Query summary

POST/api/v1/routers/summary

Batch summary by referId. This response has no shipment timeline. Each referId is resolved on its own, so data and errors can both contain items.

Parameters

referIdsarrayRequired

Business IDs to look up. At least one. Each value max 128 characters.

Return

dataarray

Trackings that were found.

Fields

referIdstring

Business ID from the request.

rawTrackingNumberstring

Tracking number from the create request.

trackNumberstring

Tracking number stored on the router.

statusnumber

Status code. See Shipment status.

statusLabelstring

Status name, such as TRANSIT.

routerobject

Router summary for this tracking.

data.routerobject

Fields on each data.router.

Fields

idstring

Router ID.

trackingNumberstring

Tracking number.

destinationTrackingNumberstring

Last-mile tracking number.

carrierCodestring

Carrier code.

carrierNamestring

Carrier name.

statusTrackstring

Carrier status, such as transit.

statusnumber

Status code.

statusLabelstring

Status name.

hasIssuenumber

1 when the router has an issue, otherwise 0.

latestEventstring | null

Latest event text.

latestCheckpointTimestring | null

Time of the latest event.

transitTimenumber

Transit days.

deliveryDatestring | null

Delivery time.

pickupDatestring | null

Pickup time.

expressDatestring | null

Ship time.

firstTimestring | null

Time of the first event.

firstStatestring | null

State or province of the first event.

firstCitystring | null

City of the first event.

firstZipCodestring | null

Postal code of the first event.

latestStatestring | null

State or province of the latest event.

latestCitystring | null

City of the latest event.

latestZipCodestring | null

Postal code of the latest event.

createdstring

When the router was created.

updatedstring

When the router was last updated.

errorsarray

referId values that were not returned in data.

Fields

referIdstring

Business ID from the request.

codestring

NOT_FOUND, PROCESSING, UPDATE_FAILED, or CREATE_FAILED.

messagestring

Why this referId was not returned.

cURL

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

Response Sample

{
  "data": [
    {
      "referId": "order-10001",
      "rawTrackingNumber": "9400111899223857461234",
      "trackNumber": "9400111899223857461234",
      "status": 3,
      "statusLabel": "TRANSIT",
      "router": {
        "trackingNumber": "9400111899223857461234",
        "carrierCode": "usps",
        "carrierName": "USPS",
        "status": 3,
        "statusLabel": "TRANSIT",
        "latestEvent": "In Transit to Next Facility",
        "transitTime": 3
      }
    }
  ],
  "errors": []
}