Some example order payloads for use with the Order API are listed below.
Simple Order
A basic order with a single item with no modifiers and no discounts.
{
"id": "234123898712389722",
"displayId": "10130",
"type": "DELIVERY_BY_FOOD_AGGREGATOR",
"storeId": "1250001201251",
"instructions": "Please put very very little tomato and add extra lemon juice in tabbouleh pleasei",
"delivery": {
"receiverName": "John Doe",
"receiverMobileNumber": "+9477123456",
"location": {
"address": "1006 B Emirattes Hills, Dubai",
"latitude": "55.1599898",
"longitude": "25.0616772"
},
"notes": "Please deliver ASAP"
},
"customer": {
"name": "John Doe",
"contactNumber": "+94717123456",
"email": "[email protected]"
},
"items": [
{
"id": "5f44afa4fac4a5ca4c28ff",
"quantity": 1,
"price": {
"unitPrice": {
"amount": 1000,
"currencyCode": "AED",
"formattedAmount": "AED 10.00"
},
"totalPrice": {
"amount": 1000,
"currencyCode": "AED",
"formattedAmount": "AED 10.00"
},
"taxAmount": {
"amount": 200,
"currencyCode": "AED",
"formattedAmount": "AED 2.00"
}
},
"modifiers": [
]
}
],
"payment": {
"status": "PREPAID",
"method": "CARD",
"charges": {
"subTotal": {
"amount": 1000,
"currencyCode": "AED",
"formattedAmount": "AED 10.00"
},
"total": {
"amount": 1600,
"currencyCode": "AED",
"formattedAmount": "AED 16.00"
},
"deliveryFee": {
"amount": 600,
"currencyCode": "AED",
"formattedAmount": "AED 6.00"
}
},
"discounts": [],
"tax": [{
"amount": {
"amount": 200,
"currencyCode": "AED",
"formattedAmount": "AED 2.00"
},
"name": "VAT"
}]
},
"status": "Created",
"placedAt": "2020-08-02T09:23:54.723Z"
}
Order with modifiers
An order with one item with modifiers
{
"id": "234123898712389722",
"displayId": "10130",
"type": "DELIVERY_BY_RESTAURANT",
"storeId": "1250001201251",
"instructions": "Please put very very little tomato and add extra lemon juice in tabbouleh pleasei",
"delivery": {
"receiverName": "John Doe",
"receiverMobileNumber": "+9477123456",
"location": {
"address": "1006 B Emirattes Hills, Dubai",
"latitude": "55.1599898",
"longitude": "25.0616772"
},
"notes": "Please deliver ASAP"
},
"customer": {
"name": "John Doe",
"contactNumber": "+97177123456",
"email": "[email protected]"
},
"items": [
{
"id": "5f44afa4fac4a5ca4c28ff",
"quantity": 1,
"price": {
"unitPrice": {
"amount": 1000,
"currencyCode": "AED",
"formattedAmount": "AED 10.00"
},
"totalPrice": {
"amount": 1000,
"currencyCode": "AED",
"formattedAmount": "AED 10.00"
},
"taxAmount": {
"amount": 200,
"currencyCode": "AED",
"formattedAmount": "AED 2.00"
}
},
"modifiers": [
{
"id": "22a694ab-8506-4a4b-a831-579fba64aa7c",
"quantity": 1,
"price": {
"unitPrice": {
"amount": 500,
"currencyCode": "AED",
"formattedAmount": "AED 5.00"
},
"totalPrice": {
"amount": 500,
"currencyCode": "AED",
"formattedAmount": "AED 5.00"
},
"taxAmount": {
"amount": 100,
"currencyCode": "AED",
"formattedAmount": "AED 1.00"
}
}
}
]
}
],
"payment": {
"status": "PREPAID",
"method": "CARD",
"charges": {
"subTotal": {
"amount": 1500,
"currencyCode": "AED",
"formattedAmount": "AED 15.00"
},
"total": {
"amount": 2100,
"currencyCode": "AED",
"formattedAmount": "AED 21.00"
},
"deliveryFee": {
"amount": 600,
"currencyCode": "AED",
"formattedAmount": "AED 6.00"
}
},
"discounts": [],
"tax": [{
"amount": {
"amount": 200,
"currencyCode": "AED",
"formattedAmount": "AED 2.00"
},
"name": "VAT"
}]
},
"status": "Created",
"placedAt": "2020-08-02T09:23:54.723Z"
}
NOTE: Delivery type values can be any of the following -
- DELIVERY_BY_FOOD_AGGREGATOR
- DELIVERY_BY_RESTAURANT
- DINE_IN
- PICK_UP