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.
Parameters
Section titled “Parameters”referIdstringoptionalBusiness ID from the create request.
trackingNumberstringoptionalTracking number.
firstRequestRange.startstringoptionalRange start, ISO 8601. Pass with firstRequestRange.end.
firstRequestRange.endstringoptionalRange end, ISO 8601. Pass with firstRequestRange.start.
Return
Section titled “Return”trackingNumberstringTracking number.
statusnumberStatus code. See Shipment status.
statusLabelstringStatus name, such as
TRANSIT.summaryobjectRouter summary for this tracking.
Fields
idstringRouter ID.
trackingNumberstringTracking number.
destinationTrackingNumberstringLast-mile tracking number.
carrierCodestringCarrier code.
carrierNamestringCarrier name.
statusTrackstringCarrier status, such as
transit.statusnumberStatus code.
statusLabelstringStatus name.
hasIssuenumber1 when the router has an issue, otherwise 0.latestEventstring | nullLatest event text.
latestCheckpointTimestring | nullTime of the latest event.
transitTimenumberTransit days.
deliveryDatestring | nullDelivery time.
pickupDatestring | nullPickup time.
expressDatestring | nullShip time.
createdstringWhen the router was created.
updatedstringWhen the router was last updated.
detailobjectCarrier timeline.
Fields
trackingNumberstringTracking number.
statusSummarystring | nullLatest status text from the carrier.
trackingEventsarray | nullEvents, newest first.
detail.trackingEventsarrayFields on each event. A carrier can include more keys than the ones below.
Fields
eventTypestring | nullEvent text.
eventCodestring | nullCarrier event code.
eventTimestampstring | nullEvent time in the local offset.
GMTTimestampstring | nullEvent time in UTC.
GMTOffsetstring | nullOffset from UTC.
eventCitystring | nullCity.
eventStatestring | nullState or province.
eventZIPCodestring | nullPostal code.
eventCountrystring | nullCountry.
errorobject | nullPresent when the carrier returned an error for this timeline.
