Skip to main content

Get Tracking Info

Retrieve tracking information for an order.

Endpoint

GET /v1/tracking/get

Request

Header Parameters


ParameterTypeRequiredExampleDescription
AuthorizationstringYesBearer YOUR_ACCESS_TOKENBearer access token used for authentication.
Content-TypestringYesapplication/jsonRequest body content type.

Path Parameters

FieldTypeRequiredDescription
order_idstringYesOrder ID to get tracking for

Query Parameters

FieldTypeRequiredDescription
tracking_numberstringYesTracking number to query (alternative to order_id path)

Note: At least one of order_id (path) or tracking_number (query) is required.

Example request

With Order ID

curl -X GET "${API_URL}/v1/tracking/get/3550806" \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
-H "Content-Type: application/json"

With Tracking Number

curl -X GET "${API_URL}/v1/tracking/get?tracking_number=SF7444700499701" \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
-H "Content-Type: application/json"

Responses

200 Success

200 Success

Response schema: application/json
data
json-string
Tracking response wrapper.
Expand for fields.
tracking_number
string
Shipment tracking number.
Example: SF7444700508450
order_id
string
Associated order ID.
Example: 3550875
order_status
string
Current tracking status.
Example: 列印及安排取件
export_country
string
Origin country.
Example: HONG KONG
destination_country
string
Destination country.
Example: Hong Kong
shipping_provider
string
Shipping provider name.
Example: Sf Express
courier_name
string
Courier company name.
Example: Sf Express
tracking_msg_list
json-string
Array of tracking events.
Expand for item fields.
code
string
Event status code.
Example: 50
location
string
Event location.
Example: 深圳市
date
string
Event timestamp.
Example: 2025-12-09 17:37:09
message
string
Human-readable message.
Example: 顺丰速运 已收取快件
message
string
Human-readable message.
Example: OK

Response sample

{
"data": {
"tracking_number": "SF7444700508450",
"order_id": "3550875",
"order_status": "列印及安排取件",
"export_country": "HONG KONG",
"destination_country": "Hong Kong",
"shipping_provider": "Sf Express",
"courier_name": "Sf Express",
"tracking_msg_list": [
{
"code": "50",
"location": "深圳市",
"date": "2025-12-09 17:37:09",
"message": "顺丰速运 已收取快件"
}
],
"message": "OK"
}
}

Note: Tracking data is fetched in real-time from courier APIs. Only orders belonging to the authenticated member can be tracked.

400 Bad Request

400 Bad Request

Response schema: application/json
error.code
string
Error code.
Example: 400000
error.code_reason
string
Error reason.
Example: BAD_REQUEST
error.message
string
Human-readable message.
Example: Bad Request
error.error_code
string
Optional error code.
Example: ORDER_NOT_FOUND, TRACKING_NUMBER_REQUIRED
error.error_trace
array
List of validation errors.
Expand for fields.
field
string
Request field that failed.
Example: order_id
message
string
Human-readable message.
Example: order_id is required when tracking_number is not provided

Response sample

{
"error": {
"code": "400000",
"code_reason": "BAD_REQUEST",
"message": "Bad Request",
"error_trace": [
{
"field": "order_id",
"message": "order_id is required when tracking_number is not provided"
}
]
}
}

401 Unauthorized

401 Unauthorized

Response schema: application/json
code
string
Error code.
Example: 401000
code_reason
string
Error reason.
Example: UNAUTHORIZED
message
string
Human-readable message.
Example: Unauthorized
{
"error": {
"code": "401000",
"code_reason": "UNAUTHORIZED",
"message": "Unauthorized"
}
}

403 Forbidden

403 Forbidden

Response schema: application/json
error
json-string
Access forbidden for this resource.

404 Not Found

404 Not Found

Response schema: application/json
error
json-string
Resource or endpoint not found.

500 Failure

500 Failure

Response schema: application/json
code
string
Error code.
Example: 500999
code_reason
string
Error reason.
Example: API_ERROR
message
string
Human-readable message.
Example: Api Error, please contact customer service
{
"error": {
"code": "500999",
"code_reason": "API_ERROR",
"message": "Api Error, please contact customer service"
}
}