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. For a delivery order handled by PAR Dispatch, it means the courier has accepted the job and is on the way — there is no separate "out for delivery" status. Pickup 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. For a delivery order, it means the order was handed to the customer. |
Canceled |
The order was canceled. |
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. |
Delivery statuses
A delivery order also carries a delivery_status, which follows the courier rather than the kitchen. It is null on pickup orders and on a delivery order before a delivery job exists. Read it from Get Order; the order status webhook does not include it.
| Delivery status | Description | Order status it moves the order to |
|---|---|---|
Init |
A delivery job has been requested from the store's drivers or a delivery provider. | — |
Created |
The provider has accepted the job and is finding a courier. | — |
Underway |
A courier has the job. Covers everything from heading to the store to arriving at the customer. | Ready |
Completed |
The order was handed to the customer. | Final |
Cancelled |
The provider canceled the job. The order is canceled as well, unless it has already reached a state that cannot be canceled. Note the double l — this value is spelled differently from the Canceled order status. |
Canceled |
Assignment Failed |
No courier could be assigned. The store will reassign or cancel. | — |
Rejected by Driver |
The assigned courier declined the job. The store will reassign. | — |
Rejected by DSP |
The delivery provider declined the job. The store will reassign or cancel. | — |
For the courier's live position, use Driver Tracking. Its own delivery_status is finer-grained (Assigned to Driver, Driver in the Store, Delivery in Progress, Order Delivered, …) and is a different set of values from the one above.
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.
