| Endpoint | Type | Function |
|---|
| GET Stores đź”— | GET | Returns the list of stores. A store represents a unique ordering experience from a specific location. |
| 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. |
| POST 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. |
| PATCH Basket đź”— | PATCH | Applies various basket updates (e.g., items, customer info, and discounts). |
| Validate Basket đź”— | POST | Validate a basket using an unique basket ID |
| 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. |
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 |
