Create Order Run in API Explorer
Create/Cancel Order
Your channel integration can use this endpoint to place a new order or process a cancellation of an existing order. See examples listed on the right hand side of this page.
Channel 'Scope'
The channelName represents the Scope provided to create orders.
If the channelname used is invalid or does not have access to an account, the request is considered unauthorised. Remember to write the channelname in lowercase letters.
Channel Link ID
The {channelLinkId} is the unique identifier of the channel in the restaurant location. Obtained via a registration webhook event delivered via Register Channel
If the channelLinkId used is invalid or has not been made available to your partner 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 |
| Curbside | 4 |
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.
Body
-
The full unique ID from the ordering channel.
-
A humanly-readable order reference.
-
Who delivers the order.
-
Validation ID returned from dispatch validation when used.
-
Order type. Use 1 for pickup, 2 for delivery, 3 for eat-in, and 4 for curbside.
-
Timestamp is in UTC yyyy-MM-ddTHH:mm:ssZ all time values in our API are in UTC time as per ISO8601
-
Timestamp is in UTC yyyy-MM-ddTHH:mm:ssZ all time values in our API are in UTC time as per ISO8601
-
Time when the order was placed.Timestamp is in UTC yyyy-MM-ddTHH:mm:ssZ all time values in our API are in UTC time as per ISO8601
curl \
--request POST 'https://api.staging.deliverect.com/{channelName}/order/{channelLinkId}' \
--header "Content-Type: application/json" \
--data '[{"channelOrderId":"{{channelOrderId-001}}","channelOrderDisplayId":"{{channelOrderDisplayId-001}}","channelLinkId":"{{channelLinkId-001}}","by":"","orderType":2,"table":"Table 23","channel":10000,"pickupTime":"2020-03-09T17:17:38Z","estimatedPickupTime":"2020-03-09T17:17:38Z","deliveryTime":"2020-03-09T17:17:38Z","deliveryIsAsap":true,"courier":"restaurant","customer":{"name":"Customer name","companyName":"Deliverect","phoneNumber":"0123456789","email":"customer@deliverect.com","tin":"taxIdentificationNumber"},"deliveryAddress":{"street":"The Krook","streetNumber":"4","postalCode":"9000","city":"Gent","extraAddressInfo":""},"orderIsAlreadyPaid":true,"payment":{"amount":975,"type":3},"note":"This is a test note","items":[{"plu":"T5","name":"Bier (Hertog Jan)","price":325,"quantity":1,"remark":"","subItems":[{"plu":"SI2","name":"Fluitje","price":0,"quantity":1,"remark":"","subItems":[]}]},{"plu":"SO1","name":"Cali SALMON","price":550,"quantity":1,"remark":"Don't add peper","subItems":[]}],"decimalDigits":2,"numberOfCustomers":1,"deliveryCost":0,"serviceCharge":0,"discountTotal":0,"tip":100}]'[
{
"channelOrderId": "{{channelOrderId-001}}",
"channelOrderDisplayId": "{{channelOrderDisplayId-001}}",
"channelLinkId": "{{channelLinkId-001}}",
"by": "",
"orderType": 2,
"table": "Table 23",
"channel": 10000,
"pickupTime": "2020-03-09T17:17:38Z",
"estimatedPickupTime": "2020-03-09T17:17:38Z",
"deliveryTime": "2020-03-09T17:17:38Z",
"deliveryIsAsap": true,
"courier": "restaurant",
"customer": {
"name": "Customer name",
"companyName": "Deliverect",
"phoneNumber": "0123456789",
"email": "customer@deliverect.com",
"tin": "taxIdentificationNumber"
},
"deliveryAddress": {
"street": "The Krook",
"streetNumber": "4",
"postalCode": "9000",
"city": "Gent",
"extraAddressInfo": ""
},
"orderIsAlreadyPaid": true,
"payment": {
"amount": 975,
"type": 3
},
"note": "This is a test note",
"items": [
{
"plu": "T5",
"name": "Bier (Hertog Jan)",
"price": 325,
"quantity": 1,
"remark": "",
"subItems": [
{
"plu": "SI2",
"name": "Fluitje",
"price": 0,
"quantity": 1,
"remark": "",
"subItems": []
}
]
},
{
"plu": "SO1",
"name": "Cali SALMON",
"price": 550,
"quantity": 1,
"remark": "Don't add peper",
"subItems": []
}
],
"decimalDigits": 2,
"numberOfCustomers": 1,
"deliveryCost": 0,
"serviceCharge": 0,
"discountTotal": 0,
"tip": 100
}
]string