Get package trackings
# Endpoint
POST https://api.track123.com/gateway/open-api/tk/v2/track/query
# Interface description
You can track up to 100 tracking numbers at a time.
# Request parameter
Name | Description | Required | Type |
---|---|---|---|
trackNos | Tracking numbers list | false | array |
orderNos | Order number list | false | array |
createTimeStart | The start point of time range of tracking created, used to screen tracking results | false | string(date-time) |
createTimeEnd | The end point of time range of tracking created, used to screen tracking results | false | string(date-time) |
cursor | Pagination query request, cursor, obtained from the query result of the previous page, leave blank to track the result of the first page | false | string |
queryPageSize | Pagination query request, number of queries per page, default 100, maximum 100 queries at a time | false | integer(int32) |
# Request example
{
"trackNos": [
"304071414818",
"620372231752"
],
"orderNos": [ "" ],
"createTimeStart": "2021-08-01 00:00:00",
"createTimeEnd": "2021-09-28 00:00:00",
"cursor": "",
"queryPageSize": 100
}
# Response parameter
Name | Description | Type |
---|---|---|
code | Service status code | string |
data | Object actually returned | object |
accepted | Successful order number enquiry | object |
content | Pagination data list | array |
trackNo | Track nomber | string |
createTime | Create time | string |
id | Major key | string |
nextUpdateTime | The next update time of a tracking number, if it is null, this tracking number will not update again | string |
orderNo | The order number of the parcel that generated by the merchant or platform | string |
customerEmail | The customer email address associated with the order filled in by the merchant/platform | string |
shipFrom | Origin country two-letter short code | string |
shipTo | Destination country two-letter short code | string |
trackingStatus | query status code | string |
transitStatus | Transit status | string |
transitSubStatus | Transit sub-status | string |
shipTime | Ship time | string |
orderTime | Order time | string |
receiptTime | Receipt time, first scan time, collection time | string |
deliveredTime | Delivered time | string |
lastTrackingTime | Time of the last tracking information | string |
deliveredDays | The difference between delivered time and receipt time | integer |
receiptDays | The difference between recepit time and ship time | integer |
transitDays | days between the current time and receiptTime, stop updating | integer |
stayDays | when the shipment stops updating | integer |
remark | Remark | string |
destinationLogisticsInfo | Destination Logistics information | object |
courierCode | The unique courier shortcode | string |
courierNameCN | Couier Name in Chinese | string |
courierNameEN | Couier Name in English | string |
courierHomePage | Link to the homepage of courier | string |
trackingDetails | Detailed list of tracks, in reverse chronological order | array |
address | Tracking address | string |
eventTime | Tracking event time | string |
eventTimeZeroUTC | UTC time of the current event | string |
timezone | Time zone | string |
eventDetail | Tracking e vent detail | string |
lastMileInfo | Last mail info | object |
lmTrackNo | Last mail tracking number | String |
openApiWayBillInfo | Last mail tracking info | object |
transitSubStatus | Transit sub-status | string |
localLogisticsInfo | Carrier Logistics Information | object |
courierCode | The unique courier shortcode | string |
courierNameCN | Carrier Name in Chinese | string |
courierNameEN | Carrier Name in English | string |
courierHomePage | Link to the homepage of carrier | string |
cursor | Paging cursor, the cursor of the previous page needs to be carried when querying the data of the next page | string |
totalElements | Total elements | integer |
totalPages | Total pages | integer |
currentPage | Current page | integer |
expectedDelivery | Estimated arrival time of Express | string |
shipmentType | Waybill service level number | string |
code | Error Code | string |
error | Reason for failure | object |
msg | Cause of error | 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": {
"content": [
{
"trackNo": "9261290289104300655419",
"createTime": "2022-08-02 20:20:36",
"nextUpdateTime": "2022-08-05 20:20:45",
"orderNo": "",
"customerEmail": "",
"shipFrom": "US",
"shipTo": "US",
"trackingStatus": "001",
"transitStatus": "EXPIRED",
"transitSubStatus": null,
"shipTime": "2022-06-14 18:10:10",
"orderTime": "2022-05-31 14:46:06",
"receiptTime": "2022-06-01 11:17:36",
"deliveredTime": null,
"lastTrackingTime": "2022-06-01 19:50:20",
"receiptDays": 14,
"deliveredDays": null,
"remark": "test-bytedance",
"localLogisticsInfo": {
"courierCode": "parcll",
"courierNameCN": "PARCLL",
"courierNameEN": "PARCLL",
"courierHomePage": "https://www.parcll.com/",
"trackingDetails": [
{
"address": "New York",
"eventTime": "2022-06-01 19:50:20",
"eventTimeZeroUTC": "2022-06-01T11:50:20Z",
"timezone": "+08:00",
"eventDetail": "Departed Facility In processing center",
"transitSubStatus": "IN_TRANSIT_01"
},
{
"address": "",
"eventTime": "2022-06-01 11:47:00",
"eventTimeZeroUTC": "2022-06-01T03:47:00Z",
"timezone": "+08:00",
"eventDetail": "picked up by shipping partner, usps awaiting item",
"transitSubStatus": "INFO_RECEIVED_01"
},
{
"address": "New York",
"eventTime": "2022-06-01 11:17:40",
"eventTimeZeroUTC": "2022-06-01T03:17:40Z",
"timezone": "+08:00",
"eventDetail": "Departed Facility in New York ",
"transitSubStatus": "IN_TRANSIT_01"
},
{
"address": "New York",
"eventTime": "2022-06-01 11:17:36",
"eventTimeZeroUTC": "2022-06-01T03:17:36Z",
"timezone": "+08:00",
"eventDetail": "Arrived at Sort Facility New York ",
"transitSubStatus": "IN_TRANSIT_01"
},
{
"address": "",
"eventTime": "2022-05-31 14:46:06",
"eventTimeZeroUTC": "2022-05-31T06:46:06Z",
"timezone": "+08:00",
"eventDetail": "Shipment information received",
"transitSubStatus": "INFO_RECEIVED_01"
}
]
},
"expectedDelivery": null,
"shipmentType": "",
"lastMileInfo": {
"lmTrackNo": "9261290289104300655419",
"openApiWayBillInfo": {
"courierCode": "usps",
"courierNameCN": "美国邮政",
"courierNameEN": "USPS",
"courierHomePage": "https://www.usps.com/",
"trackingDetails": [
{
"address": "",
"eventTime": "2022-06-01 11:47:00",
"eventTimeZeroUTC": "2022-06-01T17:47:00Z",
"timezone": "-06:00",
"eventDetail": "Picked Up by Shipping Partner, USPS Awaiting Item -> Your item was picked up by a shipping partner at 11:47 am on June 1, 2022. This does not indicate receipt by the USPS or the actual mailing date.",
"transitSubStatus": "INFO_RECEIVED_01"
}
]
}
}
}
],
"totalElements": "1",
"totalPages": "1",
"currentPage": "1",
"cursor": "1659442836095,342401319572631552,2"
},
"rejected": []
},
"msg": "成功"
}