get https://{subdomain}.myshoplaza.com/openapi/2024-07/tracking/carriers/detect
Detected a carrier for the tracking number
Requires
read_orderaccess scope. More access scope
The Get carrier details by tracking number API
This API is especially useful for:
- Identifying carrier which is responsible for handling a shipment
Request Parameters
Public Request Parameters
Query Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| tracking_number | string | Yes | The tracking number (5–50 characters; letters, numbers, or - allowed) | DJ123456789CN |
Response Description
Public Response Fields
Success Response
Response Fields
| Field | Type | Description | Example |
|---|---|---|---|
| code | string | Response code | "Success" |
| message | string | Description message | "Success" |
| data.success | boolean | Whether detection was successful | true |
| data.tracking_carrier | object | Detected carrier object | {...} |
| data.tracking_carrier.cn_name | string | Carrier name in Chinese | "可络客国际物流" |
| data.tracking_carrier.en_name | string | Carrier name in English | "CLE" |
| data.tracking_carrier.code | string | Internal 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 | |
| 422 | InvalidParameter | Invalid input format or request structure. | {"code": "InvalidParameter", "tracking_number is required." } |