Order statuses
The status codes an order can have.
order.status.code is returned by GetOrder and
ListOrders, and sent by the
order status webhook.
CreateOrder doesn't return a status.
Usual order
- PENDING
- IN_PREPARATION
- HANDED_OVER
- SHIPPED
- DELIVERED
- RETURNED
BACKORDER- Not enough stock. Comes before
IN_PREPARATION. CANCELLED- The order was cancelled.
EXCEPTION- A problem needs attention, during preparation or delivery.
An order can skip statuses. A webhook may send a status you haven't seen before, so don't rely on receiving every step.
Codes
PENDING- Received and waiting to be fulfilled.
BACKORDER- Not enough stock to fulfill it. Waits for new stock.
IN_PREPARATION- The warehouse is picking and packing. The order can no longer be updated or cancelled.
HANDED_OVER- Given to the carrier.
SHIPPED- In transit, or waiting at a pickup point.
DELIVERED- Delivered, or on its way back to the warehouse.
RETURNED- Back at the warehouse.
CANCELLED- Cancelled. Nothing will ship.
FULFILLMENTS_CANCELLED- The fulfillments were cancelled, but not the order. Usually sent as CANCELLED.
EXCEPTION- A problem needs attention, for example an address the carrier rejected.
CODE_UNSPECIFIED- Unknown status.
| status.code | Meaning |
|---|---|
PENDING | Received and waiting to be fulfilled. |
BACKORDER | Not enough stock to fulfill it. Waits for new stock. |
IN_PREPARATION | The warehouse is picking and packing. The order can no longer be updated or cancelled. |
HANDED_OVER | Given to the carrier. |
SHIPPED | In transit, or waiting at a pickup point. |
DELIVERED | Delivered, or on its way back to the warehouse. |
RETURNED | Back at the warehouse. |
CANCELLED | Cancelled. Nothing will ship. |
FULFILLMENTS_CANCELLED | The fulfillments were cancelled, but not the order. Usually sent as CANCELLED. |
EXCEPTION | A problem needs attention, for example an address the carrier rejected. |
CODE_UNSPECIFIED | Unknown status. |
Statuses that combine several states
The message field
status.message is a readable note for display or logs. It's often empty and its
wording can change. Don't use it in your logic.
Status changes
The order status webhook is sent when the status code changes. If several changes happen close together, only the latest status is sent.