Tracking
Tracking numbers, statuses and carrier events for each parcel.
When a parcel is handed to a carrier, Bigblue records its tracking events. Tracking is read-only.
Operations
Order status and tracking status
| Order status | Tracking status | |
|---|---|---|
| Describes | The whole order | One parcel |
| Codes | Order statuses | See below |
| History | Current status only | All events, with times |
| Shows returning parcels | No, they show as DELIVERED | Yes, as RETURNING |
An order with two parcels has one order status and two trackings.
GetOrder returns the tracking number of the parcel
furthest along. ListTrackings returns both.
Status codes
LABEL_CREATED- A label exists. The carrier hasn't collected the parcel.
PENDING- Tracking started. The carrier hasn't scanned the parcel yet.
IN_TRANSIT- On the way.
OUT_FOR_DELIVERY- Out for delivery today.
AVAILABLE_FOR_PICKUP- Waiting at a pickup point.
DELIVERED- Delivered.
RETURNING- On its way back to the warehouse.
RETURNED- Back at the warehouse.
LOST- Lost by the carrier.
NOT_TRACKED- The carrier service has no tracking.
STATUS_CODE_UNSPECIFIED- No status yet.
| tracking.status.code | Meaning |
|---|---|
LABEL_CREATED | A label exists. The carrier hasn't collected the parcel. |
PENDING | Tracking started. The carrier hasn't scanned the parcel yet. |
IN_TRANSIT | On the way. |
OUT_FOR_DELIVERY | Out for delivery today. |
AVAILABLE_FOR_PICKUP | Waiting at a pickup point. |
DELIVERED | Delivered. |
RETURNING | On its way back to the warehouse. |
RETURNED | Back at the warehouse. |
LOST | Lost by the carrier. |
NOT_TRACKED | The carrier service has no tracking. |
STATUS_CODE_UNSPECIFIED | No status yet. |
Events use the same codes in events[].status_code.
Objects
Tracking
tracking_numberstringThe tracking number printed on the label. Stays the same if the carrier issues a new number later.
carrier_servicestringtracking_urlstringupdate_timestringstatusTracking.StatuseventsTrackingEvent[]Tracking.Status
codestringmessagestringTrackingEvent
status_codestringmessagestringtimestampstringWhen the event happened, RFC 3339 UTC. If the carrier didn't send a time, this is when Bigblue recorded the event.
Events from all of a parcel's labels are combined, so a reshipped parcel has one history.
When you look up an order, cancelled fulfillments are ignored. If the order's only fulfillment was cancelled, the response is empty.