Our Commerce API powers digital ordering via endpoints that provide store details, menu data, and basket calculation and validation, with a checkout flow handling POS order injection.
Glossary
| Endpoint | Type | Function |
|---|---|---|
| GET Root Menu(s) 🔗 | GET | Retrieves the brand-level Root Menu linked to the primary location, representing all items across the brand. |
| GET Store Menu(s) 🔗 | GET | Retrieves a store’s menu, including its product range and pricing details. |
| GET Stores 🔗 | GET | Returns the list of stores. A store represents a unique ordering experience from a specific location. |
| POST Create Basket 🔗 | POST | Generates a unique basket ID for checkout by validating order details, applying taxes, store charges, and performing basket calculations. |
| GET Basket 🔗 | GET | Retrieve a basket by unique ID. Contains the basket's details and contents. |
| PATCH Basket 🔗 | PATCH | Applies various basket updates (e.g., items, customer info, and discounts). |
| POST Checkout Basket 🔗 | POST | Creates a checkout session using a unique basket ID. |
| GET Checkout 🔗 | GET | Returns a checkout session by ID. This can be used to poll the status of a checkout session, providing order placement details. |
Webhooks
| WEBHOOK | TYPE | FUNCTION |
|---|---|---|
| Checkout Update 🔗 | POST | This webhook will be called post–basket checkout to report the completion status. |
Base URLs
These are the base URLs for endpoints hosted on the Deliverect domain.
| Environment | Base URL | Description |
|---|---|---|
| Restaurant Staging | https://api.staging.deliverect.com | For any integration partner operating in the restaurant space and accessing endpoints in our Staging (test) Environment |
| Restaurant Production | https://api.deliverect.com | For any integration partner operating in the restaurant space and accessing endpoints in our Production (live) Environment |
Commerce API workflow