Assigned shipment states

The Shipments platform assigns a state to every shipment it manages. These states describe where a shipment is in its lifecycle from allocation and transit to delivery or cancellation. This article provides a comprehensive reference of all possible states.

List of states

ValueDescription
action_requiredThe shipment needs manual intervention in order to effect successful delivery.
allocatedThe shipment is currently allocated to a carrier service.
allocatingThe shipment is in the process of being allocated. It cannot change state until allocation either completes or fails.
allocation_failedThe most recent attempt to allocate the shipment failed.
at_collection_pointThe shipment is at a collection point waiting to be collected.
at_customer_collection_pointThe shipment been delivered to the collection point.
at_customsThe shipment is at customs.
at_drop_off_pointThe shipment is at the drop off point and is waiting to be picked up.
awaiting_drop_offThe carrier is waiting for the customer to drop off the shipment.
cancelledThe shipment has been cancelled. No further changes may be made to the shipment.
cancellingThe shipment is in the process of being cancelled. It cannot change state until the cancellation either succeeds or fails.
carrier_changedThe shipment has been handed over to a new carrier.
carrier_collectedThe shipment has been collected by the carrier. This status is usually used by on_demand carriers.
carrier_collection_failedThe carrier failed to collect the shipment.
cleared_customsThe shipment has cleared customs.
collection_bookedA collection was successfully booked. Only on_demand shipments can assume this state.
collection_booking_failedA collection booking was attempted but was not successful. Only on_demand shipments can assume this state.
collection_booking_pendingA collection booking is queued but has neither failed or succeeded. Only on_demand shipments can assume this state.
customer_collectedThe shipment has been collected by the customer (e.g. from a pick-up location).
customer_collection_failedThe customer failed to collect the shipment.
damagedThe shipment has been damaged.
delayedThe shipment is delayed and is likely to be late.
delivered_damagedThe shipment was delivered in a damaged condition.
deliveredThe shipment has been delivered successfully.
delivery_failed_card_leftDelivery of the shipment failed, and the driver left a card.
delivery_failedDelivery of the shipment failed.
destroyedThe shipment has been destroyed by the carrier (generally either because it was dangerous, or it was severely damaged).
dispatchedThe shipment has been dispatched. This state is normally used when the carrier does not or cannot provide tracking events.
exchange_failedAn attempt to exchange the shipment between carriers failed.
held_by_carrierThe shipment is currently being held by the carrier.
in_transit_waitingThe shipment is in transit and is waiting for further action from the carrier.
in_transitThe shipment is currently being transported but has not yet been delivered.
lostThe shipment is lost.
manifest_failedThe most recent attempt to manifest the shipment failed.
manifestedThe shipment has been manifested with the carrier successfully.
manifestingThe shipment is in the process of being manifested. It cannot change state until manifesting either completes or fails.
missingThe shipment is missing.
out_for_deliveryThe shipment is out for delivery.
partially_deliveredOne or more parts of the shipment have been delivered, but there still some parts that have not yet been delivered.
ready_to_shipThe shipment is ready to be shipped. This is a pre-manifest state.
returned_to_senderThe shipment has been returned to the sender.
unallocatedThe default initial state. The shipment has not been booked with a carrier.

Next steps