Your channel integration can use this endpoint to place a new order or process a cancellation of an existing order.
Channel 'Scope'
The {channelname} represents the Scope provided to create orders.
If the
channelnameused is invalid or does not have access to an account, the request is considered unauthorised.
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 |
Order Response
All orders sent in a valid format with correct scope applied will receive a
201. This does not indicate the POS has successfully processed the order, you should reference the events sent to your 'Order Status Update' webhook to understand if successful.
Request Parameters
See full list of order attributes;
Payments
Details on processing payments, taxes or other charges and discounts
Canceling an order
If your channel supports canceling an order, you can send a secondary order which acts as a cancellation request;
Self Delivery or 3rd Party Dispatch Orders
Where the delivery job isn't handled by the ordering platform, it's possible to specify that an integrated 'Dispatch' service or the restaurant themselves will handle this task;