...
Order event webhook and endpoint
All order events are broadcasted through our order event webhook. You can use it to validate that the statuses you are providing are being reflected correctly in our system, and that the order is moving through statuses correctlyThe POS must provide order status updates as the order advances through its lifecycle using the Order Event endpoint.
You will notice that some of these statuses are already provided as part of the API actions explained above:
During the commit action, the status
COMMITTEDis passed to our API. It’s not required to send that status again via the Order Event endpoint.During the firng action, the status
PREPARINGis passed to our API. It’s not required to send that status again via the Order Event endpoint.
These are the supported order lifecycle statuses:
Status | Description |
|---|---|
CREATED | Order has been created. |
PRICED | Order has been priced. The POS has provided price information for the order. |
COMMITTED | Order has been committed. The POS has accepted the order. |
PREPARING | Order is being prepared in the restaurant |
PREPARED | Order has been prepared and is ready for pickup or delivery. |
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. |
All order events are broadcasted through our order event webhook. You can use it to validate that the statuses you are providing are being reflected correctly in our system, and that the order is moving through statuses correctly.