Skip to main content

ShipmentTracking

Staff tracking view of a shipment: the shipment, its progress steps, any problem it is in, and the last time the carrier was asked for news (with the carrier's exact error when that ask failed).

type ShipmentTracking {
  canAskCarrier: Boolean!
  carrierError: String
  checkedAt: DateTime
  problemStatus: ShipmentStatus
  progress: [ShipmentProgressStep!]!
  shipment: ShipmentGql!
}

Fields​

ShipmentTracking.canAskCarrier ● Boolean! non-null scalar​

True when the carrier can be asked for news: it reports tracking on request, knows this shipment, and the shipment is not finished. False for custom (manual) couriers.

ShipmentTracking.carrierError ● String scalar​

The carrier's exact error from the last ask, or null. The saved timeline is still returned.

ShipmentTracking.checkedAt ● DateTime scalar​

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

ShipmentTracking.problemStatus ● ShipmentStatus enum​

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

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

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

ShipmentTracking.shipment ● ShipmentGql! non-null object​

The shipment.

Returned By​

trackShipment query