Our Commerce API powers digital ordering via endpoints that provide store details, menu data, basket calculation and validation and provides a checkout flow to handle POS order injection.
Glossary
| Endpoint | Type | Function |
|---|---|---|
| Get Stores đź”— | GET | Returns a list of stores |
| Get Store đź”— | GET | Returns a specific store's data |
| 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. |
| Create Basket đź”— | POST | Generates a unique basket ID, also validates the order, it's content and calculates total amount payable including applicable taxes and store charges. |
| Get Basket đź”— | GET | Retrieve a basket by unique ID. Contains the basket's details and contents. |
| Update Basket đź”— | PATCH | Applies various basket updates (e.g., items, customer info, and discounts). |
| Validate Basket đź”— | POST | Validate a basket using an unique basket ID |
| 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. |
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 |