...
Status | Description | When does it trigger? |
---|---|---|
CREATED | Order has been created. | When guests access the cart page. |
PRICED | Order has been priced. The POS has provided price information for the order. | When the POS returns price info via the Price Webhook Callback endpoint. |
COMMITTED | Order has been committed. The POS has accepted the order. | When the POS confirms the commit via the Commit Webhook callback endpoint. |
PREPARING | Order is being prepared in the restaurant | When the POS responds to the Fire Webhook Callback endpoint, or the |
PREPARED | Order has been prepared and is ready for pickup or delivery. | When the POS informs that the order is ready via the Order Event endpoint. |
DONE | Order is done. This is the final state for a successful order. | [ ] |
CANCELED | Order has been cancelled. | [ ] |
ERROR | Error with the order. Customer should be notified and refunded. | When the POS notifies us there’s been an error in the Price Webhook Callback endpoint or the Commit Webhook callback endpoint. |
You can use the order event webhook to validate that the actions you are performing are being reflected correctly in our system, and that the order is moving through its lifecycle statuses.
...