...
This document focuses on the cart page and order confirmation page.
How do you interact with the API?
Our ordering API uses endpoint and webhooks, which follow this principle:
We broadcast all changes that impact orders via our webhooks.
We make available all information on orders via our endpoints.
API Actions
| Info |
|---|
Make sure all this actions are performant and responses are provided within milliseconds. Long response times will translate into long loading times for guests. |
...
In the commit webhook payload, the fireOrderInSeconds indicates when the order should be send sent to the kitchen.
The fire webhook can be triggered for any order that hasn’t been fired yet, regardless of the value of fireOrderInSeconds in the commit webhook payload. This means that the fire webhook can be triggered both when fireOrderInSeconds is null or higher than 0.
...
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 |
...