Skip to main content

ShipmentStatus

Current status of a shipment in the delivery process

enum ShipmentStatus {
  CREATED
  PROCESSING
  IN_TRANSIT
  OUT_FOR_DELIVERY
  DELIVERED
  CANCELED
  PARTIALLY_DELIVERED
  FAILED_DELIVERY
  EXCEPTION
}

Values​

ShipmentStatus.CREATED​

Shipment has been created but not yet processed

ShipmentStatus.PROCESSING​

Shipment is being prepared for dispatch

ShipmentStatus.IN_TRANSIT​

Shipment is on its way to the destination

ShipmentStatus.OUT_FOR_DELIVERY​

Shipment is out for final delivery to the recipient

ShipmentStatus.DELIVERED​

Shipment has been successfully delivered

ShipmentStatus.CANCELED​

Shipment has been cancelled before delivery

ShipmentStatus.PARTIALLY_DELIVERED​

Some items in the shipment have been delivered

ShipmentStatus.FAILED_DELIVERY​

Delivery attempt failed and requires rescheduling

ShipmentStatus.EXCEPTION​

Shipment encountered an exception requiring attention

Member Of​

Shipment object ● ShipmentCreateInput input ● ShipmentSearchInput input ● ShipmentUpdateInput input