| URI | Method | Description |
|---|---|---|
| POST /trackings/post | POST | Create a tracking item |
| GET /trackings/{carrier_code}/{tracking_number} | GET | Get tracking results of a single tracking. |
| PUT /trackings/{carrier_code}/{tracking_number} | PUT | Update Tracking item |
| DELETE /trackings/{carrier_code}/{tracking_number} | DELETE | Delete a tracking item |
| POST /trackings/batch | POST | Create multiple trackings. |
| GET /trackings/get | GET | List all trackings |
| POST /trackings/realtime | POST | Get realtime tracking results of a single tracking |
Content-Type: application/json
Api-Key: YOUR_API_KEY| Param | Description |
|---|---|
tracking_number | Tracking number |
carrier_code |
Carrier code. Check courier code |
destination_code (optional) | Destination Carrier code.Check country code list |
title (optional) | Title of the tracking |
logistics_channel (optional) | Logistics channel of the tracking |
customer_name (optional) | Customer name of the tracking. |
customer_email (optional) | Email address to receive email notifications of the customer. |
customer_phone (optional) | Phone number to receive SMS notifications. |
order_id (optional) | Text field for order ID. |
order_create_time (optional) | Order Create Time(eg:2017/8/27 16:51). |
tracking_ship_date(optional) | Shipping date in YYYYMMDD format. Required by some couriers, such as deutsch-post. |
tracking_postal_code(optional) | The postal code of receiver's address. Required by some couriers, such as postnl-3s. |
tracking_account_number(optional) | Account Number. |
tracking_destination_country(optional) | Destination Country of the shipment for a specific courier. Required by some couriers, such as postnl-3s. |
lang (optional) | Return to language type (only when courier official website supports). |
auto_correct (optional) | Auto correct params,you can set 1.. |
comment (optional) | Text field for comment. |
{
"tracking_number": "300403513351",
"carrier_code": "4px",
"destination_code": "us",
"title": "cute pillow",
"logistics_channel": "4PX挂号小包",
"customer_name": "Karen Ng",
"customer_email": "[email protected]",
"customer_phone": "86 135 3021 8545",
"order_id": "#0002",
"comment": "备注",
"order_create_time": "2018/04/01 10:08",
"lang": "en"
}
{
"meta":{
"code":200,
"type":"Success",
"message":"Success"
},
"data":{
"id":"a543163dd2474af66f64c48e3085cdfa",
"tracking_number":"300403513351",
"carrier_code":"4px",
"order_create_time":"2018/04/01 10:08",
"status":"pending",
"created_at":"2018-04-16T06:30:02+00:00",
"customer_email":"[email protected]",
"customer_name":"Karen Ng",
"order_id":"#0002",
"comment":"备注",
"title":"cute pillow",
"logistics_channel":"4PX挂号小包"
}
}