Your standalone integration can use this endpoint to place a new order informing us of the need to create a Dispatch delivery job.
Deliverect will check the 'scope' within the request target URL to ensure your channel is permitted to send orders for the specified customer. The scope is represented by the {channelname} which will be provided to integrating parties along with their API credentials.
If the channelname used is invalid or does not have access to an account, the request is considered unauthorised.
Request parameters
Certain attributes are explained in detail below, for the full list of order attributes, follow the link below;
Orders for Dispatch
Creating orders for Dispatch
To ensure an order for Delivery is handled by a Dispatch service via Deliverect, you need to send the below in the payload;
"courier": "restaurant,
Order Type
orderType should be sent with only the delivery value (as an integer) and courier set to "restaurant".
| Type | Integer Value |
|---|---|
| delivery | 2 |
"orderType": 2,
"courier":" restaurant"
Order Items
Items
Note, although we are not injecting orders into the POS we still require the items and subitems to be sent in the delivery. This is so we can create the job successfully on the Dispatch partner side. It will also help with any investigations needed between the Order platform, Deliverect and Delivery Partner.
PLU is required but can be hardcoded as a standard value
"items": [
{
"plu": "1",
"name": "Chicken Nugget Meal",
"price": 700,
"quantity": 1,
"productType": 1,
"remark": "Lightly Battered",
"subItems": [
{
"plu": "1",
"name": "8Pcs nuggets",
"price": 0,
"quantity": 1,
"productType": 1,
"subItems": []
},
{
"plu": "1",
"name": "Large fries",
"price": 0,
"quantity": 1,
"productType": 1,
"subItems": []
},
{
"plu": "1",
"name": "Fanta 500ml",
"price": 0,
"quantity": 1,
"productType": 1,
"subItems": []
},
]
}
],
Payments
Depending on the method of payment, the relevant payment types should be sent with one of two following values (as an integer):
| Payment Type | Integer Value |
|---|---|
| credit card online | 0 |
| cash | 1 |
Payment amount
Note, you should always pass the payment amount, whether the order is already paid or not. This will help us to communicate the order value to the Dispatch partner for any future needs.
Payment format
Payment amounts should be sent as an integer with 2 decimal digits, for example, 5 euros would be sent as
500.
"payment": {
"amount": 400,
"type": 0
},
Driver Tips
To send a tip through with an order that is intended for the driver you must send the below:
"driverTip": 500,.
An additional taxes array should be provided by channels operating in the US/Canada
Please check the guide here . An order example is provided on the right hand side of the documentation named "Tax Exclusive Noam".