Skip to main content

Batch Get Tracking Status

Get tracking status and event history for multiple tracking numbers in a single request.

Endpoint: POST /api/track-points/batch

Required Scope: track-points:read

Request

Request Body:

NameTypeRequiredDescription
TrackingNumbersstring[]YesList of tracking numbers to retrieve.

Example Request Body

{
"TrackingNumbers": ["TRACK123456", "TRACK404"]
}

Response

Returns a BatchResult wrapped in Result.

  • Request in each batch result item is the tracking nubmber
  • The Data for a successful batch result item result is Tracking Response

BatchResult preserves per-item success or failure. A successful HTTP response + successful root Result can still contain failed items.

Success Response Body

{
"Data": {
"AllSucceeded": false,
"Items": [
{
"Request": "TRACK123456",
"Result": {
"Succeeded": true,
"Data": {
"TrackingNumber": "TRACK123456",
"Status": "DataReceived",
"Events": [
{
"TimeLocal": "2026-03-09T19:36:34",
"TimeUtc": "2026-03-10T02:36:34Z",
"TimezoneOffset": "-07:00",
"CarrierEventCode": "GX",
"Description": "Shipping Label Created, USPS Awaiting Item",
"Location": {
"CountryCode": "US",
"City": "WALNUT",
"Province": "CA",
"Postcode": "91789"
}
}
]
},
"Error": null,
"SystemError": null,
"CapturedValues": null
}
},
{
"Request": "TRACK404",
"Result": {
"Succeeded": false,
"Data": null,
"Error": {
"Code": "TRACK_FAILED",
"Message": "error message here"
},
"SystemError": null,
"CapturedValues": {}
}
}
]
},
"Succeeded": true,
"Error": null,
"CapturedValues": {}
}