| Endpoint | Type | Function |
|---|
| Get Stores đź”— | GET | Returns the list of stores. A store represents a unique ordering experience from a specific location. |
| Get Store đź”— | GET | Returns details of a specific store |
| 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, validates the order and its contents, and calculates the total payable amount including applicable taxes and store charges. |
| Get Basket đź”— | GET | Retrieves a basket by unique ID, including its details and contents. |
| Update Fulfillment Details đź”— | PATCH | Updates the basket's fulfillment details, such as the fulfillment type, scheduled time, or delivery information. |
| Update Store đź”— | PATCH | Updates the store associated with the basket. |
| Update Basket - Item(s) đź”— | PATCH | Adds, removes, or updates items in the basket. |
| Update Customer đź”— | PATCH | Updates the customer's information associated with the basket. |
| Update Group Customers đź”— | PATCH | Updates the list of customers participating in a group order. |
| Update Group Policies đź”— | PATCH | Updates policy acknowledgements or policy-related information associated with the basket. |
| Update Tip đź”— | PATCH | Updates the gratuity or tip amount applied to the basket. |
| Update Donations đź”— | PATCH | Updates donation amounts associated with the basket. |
| Update Discount(s) đź”— | PATCH | Applies, updates, or removes discounts from the basket. |
| Update Charges đź”— | PATCH | Updates additional charges applied to the basket, such as service or delivery fees. |
| Validate Basket đź”— | POST | Validates a basket using a 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. |
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. |
