get https://{subdomain}.myshoplaza.com/openapi/2024-07/tracking/carriers
Get carrier list
Requires
read_orderaccess scope. More access scope
The Get carrier list API returns a list of all supported tracking carriers supported by Shoplazza Fulfillment. Each carrier entry includes a Chinese name, English name, and a unique code.
This API is especially useful for:
- Identifying available logistics providers for shipment tracking.
- Mapping carrier codes for order fulfillment integrations.
Request Parameters
Public Request Parameters
Response Description
Public Response Fields
Success Response
Response Fields
| Field | Type | Description | Example |
|---|---|---|---|
code | string | Status code of the response | "Success" |
message | string | Description message | "Success" |
data.tracking_carriers | array | List of supported carriers | [...] |
data.tracking_carriers[0].cn_name | string | Carrier name in Chinese | "可络客国际物流" |
data.tracking_carriers[0].en_name | string | Carrier name in English | "CLE" |
data.tracking_carriers[0].code | string | Unique carrier code | "DJ-10001" |
Error Response
| Field | Type | Description | Example |
|---|---|---|---|
code | string | The error code indicating the type of issue. | UnknownError |
message | string | A detailed message describing the error. | UnknownError. |
Error Detail
| Status Code | Message | Possible Reason | Example Response |
|---|---|---|---|
| 400 | Bad Request | Invalid input format or request structure (e.g., missing required fields or incorrect data types). | Bad Request |
| Unauthorized | The request is missing valid authentication credentials or the credentials provided are invalid. | Unauthorized | |
| 500 | UnknownError | please contact shoplazza technical support to resolve the issue | { "code": "UnknownError", "message": "Unknown error, please contact shoplazza technical support to resolve the issue." } |