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. |
Glossary
Below is a list of all endpoints relating to the Commerce flow, other endpoints are available via our Channel API to enhance the ordering flow e.g. to pre-validate courier availabiity;
| 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 Basket - Fulfillment Details | PATCH | Updates the basket's fulfillment details, such as the fulfillment type, scheduled time, or delivery information. |
| Update Basket - Store | PATCH | Updates the store associated with the basket. |
| Update Basket - Item(s) | PATCH | Adds, removes, or updates items in the basket. |
| Update Basket - Customer | PATCH | Updates the customer's information associated with the basket. |
| Update Basket - Group Customers | PATCH | Updates the list of customers participating in a group order. |
| Update Basket - Policies | PATCH | Updates policy acknowledgements or policy-related information associated with the basket. |
| Update Basket - Tip | PATCH | Updates the gratuity or tip amount applied to the basket. |
| Update Basket - Donations | PATCH | Updates donation amounts associated with the basket. |
| Update Basket - Discount(s) | PATCH | Applies, updates, or removes discounts from the basket. |
| Update Basket - 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. |