Detected Carrier By The Tracking Number

Identifying carrier which is responsible for handling a shipment

🔒

Requires read_order access scope. More access scope

The Get Carrier List API identifies the shipping carrier responsible for handling a specific shipment by its tracking number.

This API is especially useful for:

  1. Automatically determining the carrier for tracking numbers
  2. Displaying correct carrier information to customers

Request Parameters

Public Request Parameters

📘

Query Parameters

ParameterTypeRequiredDescriptionExample
tracking_numberstringYesThe tracking number to identify"123456789012"

Response Explanation

Public Response Parameters

📘

Successful Response

ParameterTypeExampleDescription
codestring"success"API response status code
messagestring"Carriers retrieved successfully"Response message
data.tracking_carriersarray[object]-Array of carrier objects
data.tracking_carriers.codestring"fedex"Carrier code for API references
data.tracking_carriers.en_namestring"FedEx"Carrier name in English
data.tracking_carriers.cn_namestring"联邦快递"Carrier name in Chinese

Error Response

FieldTypeExampleDescription
codestringInvalidParameterError http message
messagestring``Error message
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!