Skip to main content

ShipmentStatus

Where a shipment stands, from DRAFT and booking through pickup and transit to DELIVERED, or a problem such as FAILED_ATTEMPT, EXCEPTION, LOST, CANCELLED or BOOKING_FAILED.

enum ShipmentStatus {
AWAITING_PICKUP
BOOKED
BOOKING
BOOKING_FAILED
BOOKING_ORPHANED
CANCELLED
DELIVERED
DRAFT
EXCEPTION
FAILED_ATTEMPT
IN_TRANSIT
LOST
OUT_FOR_DELIVERY
PICKED_UP
RETURNED_TO_SENDER
SUBMITTED
}

Values​

ShipmentStatus.AWAITING_PICKUP​

Booked and waiting for the courier to collect.

ShipmentStatus.BOOKED​

Booked with the courier.

ShipmentStatus.BOOKING​

The booking is being made.

ShipmentStatus.BOOKING_FAILED​

The courier refused or failed the booking.

ShipmentStatus.BOOKING_ORPHANED​

The booking outcome is unknown and needs checking with the courier.

ShipmentStatus.CANCELLED​

Cancelled.

ShipmentStatus.DELIVERED​

Delivered.

ShipmentStatus.DRAFT​

Being prepared.

ShipmentStatus.EXCEPTION​

The courier reported a problem.

ShipmentStatus.FAILED_ATTEMPT​

A delivery attempt failed.

ShipmentStatus.IN_TRANSIT​

On its way.

ShipmentStatus.LOST​

Lost by the courier.

ShipmentStatus.OUT_FOR_DELIVERY​

Out for delivery.

ShipmentStatus.PICKED_UP​

Collected by the courier.

ShipmentStatus.RETURNED_TO_SENDER​

Sent back to the seller.

ShipmentStatus.SUBMITTED​

Sent to the courier.

Member Of​

CustomerShipment object ● CustomerShipmentEvent object ● CustomerShipmentTracking object ● RecordShipmentStatusInput input ● ShipmentEventGql object ● ShipmentGql object ● ShipmentListRow object ● ShipmentTracking object