1. Use Flow
Four steps to using TRACK123’s API interface.
2. Request
All requests and response data are in JSON format. All API interfaces use the HTTPS POST method to submit requests.
Basic URL
https://api.track123.com/gateway/open-api/
3. Response
The response content of Track123 is in JSON format.
Each response object contains "Code" and "msg" fields.
Code
The code field is a service code, which identifies the result of the API request.
Msg
The description of the current service code.
Data
The object actually returned.
4. Status code
HTTP status code
Track123 uses HTTP status codes to indicate the status of the request.
| Status code | Type | Description |
|---|
| 200 | Success | Request succeeded. |
| 400 | Bad Request | The request type is incorrect，e.g. incorrect request parameters. |
| 500 | Server Error | Something went wrong on Track123's end. |
Query status code
Track123 waybill uses different inquiry status codes to identify the status of waybill inquiry.
| query status code | type | description |
|---|
| 001 | NORMAL_QUERY | Normal Track |
| 002 | NO_RECORD | Not Found |
| 003 | UNSTABLE_OFFICIAL_WEBSITE | Web Error |
| 004 | OFFICIAL_WEBSITE_FORMAT_CHANGES | Process Error |
| 005 | CACHE_FOR_WEBSITE_ERROR | Web Error [Cache] |
| 006 | CACHE_FOR_DEAL_ERROR | Process Error [Cache] |
Service status code
Track123 uses service status codes (i.e. the code field in the response object) to mark the status of the request at the service level.
| Status code | Type | Description |
|---|
| 00000 | SUCCESS | Success |
| A0001 | USER_ERROR | User terminal error. |
| A0200 | USER_LOGIN_ERROR | Server error. |
| A0201 | USER_NOT_EXIST | Account does not exist. |
| A0202 | USER_ACCOUNT_LOCKED | The user account is locked. |
| A0203 | USER_ACCOUNT_INVALID | The user account is invalid. |
| A0230 | TOKEN_INVALID_OR_EXPIRED | Token is invalid or expired. |
| A0231 | TOKEN_ACCESS_FORBIDDEN | Token has been forbidden. |
| A0300 | AUTHORIZED_ERROR | Abnormal access rights. |
| A0301 | ACCESS_UNAUTHORIZED | Unauthorized access. |
| A0400 | PARAM_ERROR | User request parameter error. |
| A0410 | PARAM_IS_NULL | The parameter for the request is null. |
| B0001 | SYSTEM_EXECUTION_ERROR | System error. |
| B0100 | SYSTEM_EXECUTION_TIMEOUT | System timeout. |
| B0100 | SYSTEM_ORDER_PROCESSING_TIMEOUT | System timeout. |
| B0210 | FLOW_LIMITING | Exceed flow limits. |
| B0300 | SYSTEM_RESOURCE_ERROR | Abnormal system resources. |
| B0310 | SYSTEM_RESOURCE_EXHAUSTION | System resources are exhausted. |
| C0113 | INTERFACE_NOT_EXIST | The interface does not exist. |
| D0000 | SERVICE_DETAIL_MSG_ERROR | Other errors, detailed information will be returned in msg or data. |
5. Package status
| Status code | Description |
|---|
| INIT | New shipments added that are pending to track. |
| NO_RECORD | This shipment has no tracking information available yet. |
| INFO_RECEIVED | The carrier has received a request from the shipper and is preparing to pick up the package. |
| IN_TRANSIT | The shipment is in transit. |
| WAITING_DELIVERY | The shipment is out for delivery or has arrived at the collection point for pick up. |
| DELIVERY_FAILED | Carrier attempted to deliver but failed due to address issues, unavailability of the recipient, etc. |
| ABNORMAL | Parcels are damaged, returned, customs detained, and other abnormal situations. |
| DELIVERED | Parcel delivered successfully. |
| EXPIRED | Parcel has no tracking information for 30 days since added. |
Info Received Sub-status
| Status | Description |
|---|
| INFO_RECEIVED_01 | The carrier has received a request from the shipper and is preparing to pick up the package. |
In Transit Sub-status
| Status | Description |
|---|
| IN_TRANSIT_01 | Parcel is on it's way. |
| IN_TRANSIT_02 | Parcels have arrived at the sorting center. |
| IN_TRANSIT_03 | Parcel customs clearance completed. |
| IN_TRANSIT_04 | Dispatching, the package has been encapsulated and will be sent to the airport soon. |
| IN_TRANSIT_05 | The package has been handed over to the airline and is being sent to the destination country. |
| IN_TRANSIT_06 | Landed, the package has arrived in the destination country. |
| IN_TRANSIT_07 | The parcel has arrived at the local post office or courier outlet and delivery will be arranged soon. |
| IN_TRANSIT_08 | The package is on the plane and the plane has departed. |
Waiting Delivery Sub-status
| Status | Description |
|---|
| WAITING_DELIVERY_01 | The parcel is out for delivery. |
| WAITING_DELIVERY_02 | The parcel has arrived at the collection point for receipts to pick up. |
| WAITING_DELIVERY_03 | The recipient requests a delayed delivery or the courier leaves a note after a failed delivery waiting for a second delivery. |
Delivered Sub-status
| Status | Description |
|---|
| DELIVERED_01 | Parcel delivered successfully. |
| DELIVERED_02 | Successful pick-up by the recipient at the collection point. |
| DELIVERED_03 | Parcel delivered and signed by the customer. |
| DELIVERED_04 | Parcel delivered to property owners, doormen, family members, or neighbors |
Delivery Failed Sub-status
| Status | Description |
|---|
| DELIVERY_FAILED_01 | Delivery failed due to address related issues. |
| DELIVERY_FAILED_02 | Delivery failed due to the recipient was not at home. |
| DELIVERY_FAILED_03 | Delivery failed due to the recipient can not being reached. |
| DELIVERY_FAILED_04 | Delivery failed due to other reasons. |
Abnormal sub-status
| Status | Description |
|---|
| ABNORMAL_01 | Parcel unclaimed. |
| ABNORMAL_02 | Parcels detained by customs. |
| ABNORMAL_03 | The package is damaged, lost, or discarded. |
| ABNORMAL_04 | The order is canceled. |
| ABNORMAL_05 | The recipient refuses to accept the parcel. |
| ABNORMAL_06 | The return package has been successfully received by the sender. |
| ABNORMAL_07 | The package is on its way to the sender. |
| ABNORMAL_08 | Other exceptions. |
6. Ocean cargo status
Search status
| searchStatus | Description |
|---|
| INIT | New shipments added that are pending to track. |
| IN_TRANSIT | The shipment is in transit |
| FINAL | All cargos of the shipment delivered successfully. |
| NO_RECORD | The shipment has no tracking information available yet. |
| EXPIRED | The shipment has no tracking information for 30 days since added. |
Transit status
| transitStatus | Description |
|---|
| NO_RECORD | The cargo has no tracking information available yet. |
| IN_TRANSIT | The cargo is in transit |
| DELIVERED | Cargo delivered successfully. |
| EXPIRED | The cargo has no tracking information for 30 days since added. |
Tracking event status
| eventStatus | Description |
|---|
| STUF | Empty to shipper |
| STRP | Empty returned |
| LOAD | Loaded |
| DISC | Discharged |
| GTOT | Gate out |
| GTIN | Gate in |
| DEPA | Departed |
| ARRI | Arrived |
| BERT | Berthed |
| HOLD | Container on hold |
| CUST | Customs released |
| RELS | Carrier released |
| UNKNOWN | Unknown |
Location type
| locationType | Description |
|---|
| PRE | Place of receipt |
| POL | Port of loading |
| POT | Port of transfer |
| POD | Port of discharge |
| PDE | Place of delivery |
7. Air cargo status
Aviation status
| aviationStatus | Description |
|---|
| INIT | New shipments added that are pending to track. |
| BOOKED | Consignment booked on a certain flight |
| RECEIVED | Consignment received from shipper or agent |
| IN_TRANSIT | Consignment has been shipped and is on the way to destination |
| ARRIVED | Consignment arrived on a certain flight |
| NOTIFIED | Consignment arrived at destination and the consignee or agent has been |
| DELIVERED | Consignment delivered to Consignee or (if not possible) to customs |
| EXCEPTION | Consignment missing, cargo damaged, or any other exceptions |
| NO_RECORD | The shipment is not found and there is no tracking information available |
| EXPIRED | The cargo has no tracking information for 30 days since added. |
Tracking event status
| status | Description |
|---|
| BOOKED | Consignment booked on a certain flight |
| RECEIVED | Consignment received from shipper or agent |
| IN_TRANSIT | Consignment has been shipped and is on the way to destination |
| ARRIVED | Consignment arrived on a certain flight |
| NOTIFIED | Consignment arrived at destination and the consignee or agent has been |
| DELIVERED | Consignment delivered to Consignee or (if not possible) to customs |
| EXCEPTION | Consignment missing, cargo damaged, or any other exceptions |