Register package trackings
# Endpoint
POST https://api.track123.com/gateway/open-api/tk/v2/track/import
# Interface description
Up to 40 tracking numbers can be imported at a time, the interface frequency limit is 3 requests/sec. The results include both accepted and rejected lists. The accepted list is consist of successful registered trackings and the rejected list is consist of failed ones.
# Request parameter
Name | Description | Required | Data type |
---|---|---|---|
trackNo | Track number | true | string |
courierCode | The unique carrier code, if it is null, the system will auto-detect carrier base tracking number format | false | string |
orderNo | Order number | false | string |
country | Country code of destination: CN,US,GB | false | string |
shipTime | Ship time | false | string(date-time) |
customerEmail | The customer email address associated with the order | false | string |
postalCode | The postcode of the destination (15 letters or numbers, can contain +, -, and spaces) | false | string |
extendFieldMap | Be used to add additional information, such as phone number | false | object |
phoneSuffix | The last 4 digits of the shipment sender's or recipient's phone number | false | string |
remark | Remark | false | string |
customField1 | Custom field 1 | false | string |
customField2 | Custom field 2 | false | string |
# Request example
[
{
"trackNo": "LV209031969CN",
"courierCode": "denmark-post",
"orderNo": "x1234567890",
"country": "CN",
"shipTime": "2021-09-03 17:43:00",
"customerEmail": "customer@track123.com",
"postalCode": "000000",
"remark": "备注",
"extendFieldMap": {"phoneSuffix": "2390"},
},
{
"trackNo": "LV209031934CN",
"courierCode": "denmark-post",
"orderNo": "x1234567892",
"country": "CN",
"shipTime": "2021-09-03 17:43:00",
"customerEmail": "customer@track123.com",
"postalCode": "000000",
"remark": "备注",
"extendFieldMap": {"phoneSuffix": "2390"}
}
]
# Response parameter
Name | Description | Type |
---|---|---|
code | Service status code | string |
data | Object actually returned | object |
accepted | Successful registration of tracking number | array |
trackNo | Tracking number | string |
courierCode | The unique carrier code , if it is null, the system will auto-detect carrier base tracking number format | string |
orderNo | The order number generated by the merchant/platform. | string |
country | Destination country | string |
shipTime | Ship time | string |
customerEmail | The customer email address associated with the order filled in by the merchant/platform | string |
remark | Remark | string |
rejected | Rejected registration of tracking number | array |
courierCode | Carrier code | string |
error | Error | object |
code | Error code | string |
msg | Error information | string |
trackNo | Track number | string |
msg | The description information corresponding to the service status code or other auxiliary description information. | string |
# Response example
{
"code": "00000",
"data": {
"accepted": [
{
"trackNo": "LV209031969CN",
"courierCode": "denmark-post",
"orderNo": "x1234567890",
"country": "cn",
"shipTime": "2021-09-03 17:43:00",
"customerEmail": "customer@track123.com",
"remark": "备注"
}
],
"rejected": [{
"trackNo": "LV209031934CN",
"courierCode": "",
"error": {
"code": "A0400",
"msg": "跟踪号(trackNo)已经注册过了"
},
}]
},
"msg": "成功"
}