Purpose
A channel integration can use this endpoint to place a new order or process a cancellation of an existing order.
Path Parameters
| Parameter | Description |
|---|---|
channelName | This is provided as a 'Scope' to grants permission to create orders within linked accounts only. This value must be provided in lowercase. |
channelLinkId | The unique identifier for the channel configured on a restaurant location. This value is provided in the Register Channel request. |
Order Types
Depending on the format of the order created, the relevant orderType should be sent;
| Type | Integer Value |
|---|---|
| pick up | 1 |
| delivery | 2 |
| Eat-in | 3 |
| Curbside | 4 |
| Drive Thru | 5 |
Request Parameters
See full list of order attributes;
Payments
Details on processing discounts, payments, taxes or other charges in the guide below;
Create Orders for Dispatch / Last Mile Fulfillment
For platforms who don't directly handle delivery or aren't currently offering this order type, Deliverect allows for an order to be routed to an integrated 'Dispatch' service.
Standalone Dispatch Integration
Our Dispatch functionality can also be integrated as a “Standalone” solution, enabling full courier assignment and delivery, whilst bypassing requirements for POS order injection i.e. product validation. This format supports several use cases such as;
- First-party ordering platforms which already integrates to a customer POS via an existing direct integration
- Phone orders entered directly into a POS requiring delivery
For details on handling dispatch orders, see guide below;
Channel Cancelations
Your channel integration can process a cancellation using the same endpoint used create a new order
Sending a secondary order with the same channelOrderId and "status": 100 (Cancel) will initiate a POS cancellation request which typically involves 'voiding' the order.
Once the cancellation is processed by the POS, a status CANCELED (110) will be returned to confirm this has been handled. See Update Order Status Webhook on how to receive this, and other statuses from the POS.