Order statuses

Every order has a status, and so does each of its shipments. Get an order and List orders return it. List order statuses lists every value: its id and value are the same string, such as in_transit, and description is the same in words.

An order's status is the status of its last shipment. A hub order has two shipments, one per leg, and each leg's own status is in shipments[].status.

The journey

1. You create an order. It starts as order_received.
2. You create the waybill. We don't start it for you: an order made through the API waits in order_received until you call it.
3. The order moves to awaiting_schedule_pickup once the waybill exists. It can stop first at awaiting_additional_documentation, awaiting_prepayment or awaiting_waybill_generation (see below).
4. You book a pickup, in a slot from List pickup slots. The order moves to awaiting_pickup.
5. The carrier collects the goods: in_transit. From here the carrier's tracking moves the status on.
6. delivered. Clients we invoice per shipment then see invoice_to_be_paid and invoice_paid.

Every status

Needs you

Status	What it means	What to do
order_received	We have the order, and it has no waybill yet.	Call Create a waybill. Nothing moves until you do.
awaiting_additional_documentation	Customs paperwork is missing or can't be used, so we can't make the waybill. Usually the commercial invoice is missing or is 2,000,000 bytes or more.	The API takes documents only when you create the order (see Sending documents). Send the missing document to your account manager, then call Create a waybill again.
awaiting_prepayment	The order is over your credit limit, so a pro forma invoice has to be paid before we make the waybill. Create a waybill answers "Pro forma Please settle your Pro Forma invoice before a waybill can be generated".	Pay the pro forma invoice. It can't be paid through the API. Once we record the payment, the order moves on by itself.
awaiting_schedule_pickup	The waybill is ready, and the carrier needs a collection booked.	List pickup slots, then Book a pickup.
pickup_missed	The carrier didn't collect in the booked window.	Book a pickup again, or wait a little if the goods were in fact collected and the carrier's scan is late.
invoice_to_be_paid	Delivered, and our final invoice is waiting for payment. The order's invoice_number names it. Only for clients we invoice per shipment.	Pay the invoice. It can't be paid through the API.

Being prepared

Status	What it means	What to do
awaiting_waybill_generation	We're making the waybill, or our team is checking the order and will make it by hand. Create a waybill's answer says why when it's held.	Usually nothing: our team takes it from here. If the answer names a wrong address, cancel the order and create a new one, because an order can't be changed through the API.
awaiting_swap_out	The second leg of a hub order: its waybill is ready, and it waits for the goods to reach our hub and change carrier.	Nothing.
awaiting_consolidation	The shipment will be combined with others into one consolidated shipment.	Nothing.

Waiting for collection

Status	What it means	What to do
awaiting_pickup	A pickup is booked, and the carrier hasn't collected yet.	Have the goods ready in the booked window.

On its way

Status	What it means	What to do
in_transit	The carrier has the goods.	Follow it with List tracking events or the order's tracking_link.
partially_delivered	Some packages are delivered, and others are still on their way.	Nothing.

Done

Status	What it means	What to do
delivered	Every package is delivered.	Nothing. Clients we invoice per shipment move on to invoice_to_be_paid.
invoice_paid	The invoice is paid. Nothing further happens.	Nothing.

Stopped

Status	What it means	What to do
cancelled	The order was cancelled before the carrier collected it. Cancel an order does this, while every shipment is still before pickup.	Nothing.
lost_in_transit	We have declared the shipment lost. It can still become delivered if it turns up.	Your account manager will be in touch.

Normally hidden

Status	What it means
incomplete	A shipment on a quote that was never ordered. List orders leaves it out.
consolidated	Combined into a consolidated shipment, which carries on in its place. List orders leaves it out.

Being told when it changes

Webhooks report only some status changes. For the others, check the order with Get an order.