Create an Order against your location. The location has to be verified first in order to call this API.
You can only access this API if you have an access token issued with the scope orders
Order Types
The "meta" Object - will contain information necessary to identify and categorize the order. The "type" field is permitted to have the following values:
"meta":
{
"notes": "No tomatoes on anything. Please ask for Bob.",
"id": "123456",
"type": "driver_delivery",
"requested_at": "2019-08-21T22:16:23.914+00:00",
}
"driver_delivery" means that the Restaurant will not be delivering themselves. "restaurant_delivery" must be used for "type" if the restaurant is supposed to deliver it themselves. The "address" Object is required for "restaurant_delivery" type orders ONLY (it is optional for "driver_delivery").
requested_at - field should be in ISO8601 standard format - but the ISO8601 standard format technically allows for the UTC offset hours to be omitted - when the Local Time Zone is assumed. Please do not utilize that specific stipulation regarding the omission of UTC offset hours. We want you to always include a UTC offset value.
Example Request
Following is a sample request payload for an order with basic details.
{
"order": {
"location": {
"id": 223344,
"name": "Demo Location name",
"timezone": "America/New York"
},
"meta": {
"id": "5455681",
"type": "restaurant_delivery",
"notes": " Please include plastic utensils, napkins, forks, etc.",
"requested_at": null
},
"customer": {
"first_name": "Test",
"last_name": "User",
"phone": "(202) 210-5529",
"email": "[email protected]",
"address": {
"street": "102 Bradhurst Ave.",
"street2": "Apartment Number: 604",
"city": "New York",
"state": "NY",
"postal_code": "10039"
}
},
"items": [
{
"group_name": "Soup Noodles",
"name": "Herbal Beef Soup",
"id": "667336",
"price": 1500,
"quantity": 1,
"special_request": "",
"name_label": "",
"modifiers": [
{
"group_name": "Spice Level",
"id": "1234A",
"name": "High (No Refunds)",
"price": 0,
"quantity": 1,
"modifiers": [
]
},
{
"group_name": "Noodle Type",
"id": "1234B",
"name": "Chopped Ribbon",
"price": 100,
"quantity": 1,
"modifiers": [
]
}
]
}
],
"payment": {
"cash_payment": false,
"tip": 160,
"discounts": [
],
"service_fees": [
{
"name": "Delivery Fee",
"amount": 250
}
]
}
}
}