Skip to content

Query a tracking

GET/api/v1/routers/detail

One tracking, including the timeline. Pass referId or trackingNumber. At least one is required. A missing tracking returns 404.

referIdstringoptional

Business ID from the create request.

trackingNumberstringoptional

Tracking number.

firstRequestRange.startstringoptional

Range start, ISO 8601. Pass with firstRequestRange.end.

firstRequestRange.endstringoptional

Range end, ISO 8601. Pass with firstRequestRange.start.

trackingNumberstring
Tracking number.
statusnumber

Status code. See Shipment status.

statusLabelstring
Status name, such as TRANSIT.
summaryobject
Router summary for this tracking.
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.
createdstring
When the router was created.
updatedstring
When the router was last updated.
detailobject

Carrier timeline.

Fields
trackingNumberstring
Tracking number.
statusSummarystring | null
Latest status text from the carrier.
trackingEventsarray | null
Events, newest first.
detail.trackingEventsarray

Fields on each event. A carrier can include more keys than the ones below.

Fields
eventTypestring | null
Event text.
eventCodestring | null
Carrier event code.
eventTimestampstring | null
Event time in the local offset.
GMTTimestampstring | null
Event time in UTC.
GMTOffsetstring | null
Offset from UTC.
eventCitystring | null
City.
eventStatestring | null
State or province.
eventZIPCodestring | null
Postal code.
eventCountrystring | null
Country.
errorobject | null

Present when the carrier returned an error for this timeline.