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. |
Channel API Endpoints
| Endpoint | Type | Function |
|---|---|---|
| Update Store Status | POST | Update Deliverect on any change made to a store status when either open or closed on the channel platform |
| Tables and Floors | GET | Retrieve table and floor information for a specific POS location. |
| Menu Update (Async) | POST | Respond asynchronously to confirm successful update of a published menus |
| Create / Cancel Order | POST | Place a new order or process the cancellation of an existing order. |
| Update Courier / Guest Status | POST | Update the status of a courier or guest associated with an order. |
| Dispatch Availability | POST | Pre-validate dispatch availability for order fulfillment |
| Order Delivery Update | GET | Retrieve delivery status and tracking information for an order. |
| Order Rating Update | POST | Submit customer ratings / review for completed orders. |
Flow Diagram
See the full ordering lifecycle of a channel integration below;