Skip to content

Raw router

GET/api/v1/routers/:trackNumber

Returns the stored router row for this tracking number, or null when none exists. Use Query a tracking when you need the timeline.

trackNumberstringRequired

Tracking number in the path.

The body is the router row.

Fields
idstring
Router ID.
trackingNumberstring
Tracking number.
carrierCodestring
Carrier code.
isUpdatingnumber
1 while a sync is in progress.
destinationTrackingNumberstring
Last-mile tracking number.
latestEventstring | null
Latest event text.
transitTimenumber
Transit days.
lastUpdatedstring | null
When tracking fields last changed.
latestCheckpointTimestring | null
Time of the latest event.
expressDatestring | null
Ship time.
pickupDatestring | null
Pickup time.
deliveryDatestring | null
Delivery time.
statusnumber
Status code. See Shipment status.
statusTrackstring
Carrier status, such as transit.
createdstring
When the router was created.
updatedstring
When the row was last saved.
firstRequestAtstring
First request 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.
hasIssuenumber
1 when the router has an issue, otherwise 0.