Skip to main content

CustomerShipmentTracking

A buyer's tracking view of one of their shipments: the shipment, its progress steps, any problem it is in, and when the carrier was last asked. Never carries the carrier's error text.

type CustomerShipmentTracking {
canAskCarrier: Boolean!
checkedAt: DateTime
problemStatus: ShipmentStatus
progress: [ShipmentProgressStep!]!
shipment: CustomerShipment!
updateDelayed: Boolean!
}

Fields​

CustomerShipmentTracking.canAskCarrier ● Boolean! non-null scalar​

True when the carrier can be asked for news (offer Refresh). False for custom couriers and finished shipments.

CustomerShipmentTracking.checkedAt ● DateTime scalar​

When the carrier was last asked for news (null when it has not been, or cannot be).

CustomerShipmentTracking.problemStatus ● ShipmentStatus enum​

Set while the shipment is in trouble (failed attempt, exception, returned, lost); the stepper keeps the last reached step CURRENT.

CustomerShipmentTracking.progress ● [ShipmentProgressStep!]! non-null object​

BOOKED, PICKED_UP, IN_TRANSIT, OUT_FOR_DELIVERY, DELIVERED — in that order.

CustomerShipmentTracking.shipment ● CustomerShipment! non-null object​

The shipment as the customer sees it.

CustomerShipmentTracking.updateDelayed ● Boolean! non-null scalar​

True when the last ask to the carrier failed — show the saved updates with a quiet note.

Returned By​

customerTrackShipment query ● mobileTrackShipment query