Query trackings (batch)

POST/api/v1/routers/details

Batch form of Query a tracking. Pass trackingNumbers, referIds, or both. Each list allows at most 40 values, and at least one list must be non-empty. Each item is resolved on its own, so data and errors can both contain items.

Parameters

trackingNumbersarrayoptional

Tracking numbers. Each value max 128 characters. At most 40.

referIdsarrayoptional

Business IDs. Each value max 128 characters. At most 40.

firstRequestRangeobjectoptional

Limit matches to this time range. Pass start and end together.

Fields

startstringRequired

Range start, ISO 8601.

endstringRequired

Range end, ISO 8601.

Return

Each data item matches Query a tracking. summary also includes firstTime, firstState, firstCity, firstZipCode, latestState, latestCity, and latestZipCode.

dataarray

Trackings that were found, with timelines.

errorsarray

Items that were not returned in data.

Fields

referIdstring | null

Business ID, when the request used referIds.

trackingNumberstring | null

Tracking number, when the request used trackingNumbers.

codestring

NOT_FOUND, DETAIL_NOT_FOUND, PROCESSING, UPDATE_FAILED, or CREATE_FAILED.

messagestring

Why this item was not returned.

cURL

curl 'https://api.tracksuite.net/api/v1/routers/details' \
  -H 'Authorization: your_api_key' \
  -H 'Content-Type: application/json' \
  -d '{"referIds":["order-10001"],"trackingNumbers":["9400111899223857461234"]}'

Response Sample

{
  "data": [
    {
      "trackingNumber": "9400111899223857461234",
      "status": 3,
      "statusLabel": "TRANSIT",
      "summary": {
        "trackingNumber": "9400111899223857461234",
        "carrierCode": "usps",
        "status": 3,
        "statusLabel": "TRANSIT"
      },
      "detail": {
        "trackingEvents": []
      }
    }
  ],
  "errors": []
}