Order Statuses
An order moves through a series of statuses from the moment it is created until it is finished. The values below are exactly what the API returns and what our order status webhook sends, so match on them verbatim — note that they contain no spaces, and that Canceled is spelled with a single l.
| Status | Description |
|---|---|
Init |
Initial order state. The order has been created and stored. |
SendDelayed |
Sending the order to the integration is delayed until it is time for preparation to start. Specific to order types with a pickup time selection, such as Take-out and Preorder. |
SendTried |
Sending the order to the integration was tried but failed. Specific to tablet-related order types, such as Take-out, Quick service and Preorder. |
Sent |
The order was successfully sent to the POS or printer. |
InPreparation |
The order is in the kitchen being prepared. |
Ready |
The order is prepared and ready for pickup. Specific to Take-out and Quick service order types. Orders left in Ready are moved to Final automatically after 15 minutes. |
Final |
The final state of the regular order status flow, once all processing has finished successfully. Common to all order types. |
Canceled |
The order was cancelled. |
Revised |
The order was revised, meaning a new order was created while revising this one. |
Failed |
The order failed because of a system error. The order still exists, and it can fail at any stage. |
Customer Initiated Cancellation Statuses
Whether a customer can cancel their own order is controlled per brand, and in some cases per store. The brand-level setting decides whether stores get a say at all.
| ID | Status | Description |
|---|---|---|
| 1 | Enabled | Order regret is enabled for the brand, and each store can turn it on or off for itself |
| 2 | Disabled for All | Order regret is disabled for every store in the brand, and stores cannot change it |
| 3 | Enabled for All | Order regret is enabled for the brand, and stores cannot change it |
When a customer tries to cancel after the regret window has closed, the API returns error code 2013. See Error Codes for the full list.