Create Orders

To push an order using the OrderOut API, follow these steps:

Endpoint for Pushing an Order

Method

  • POST

Request Headers

  • Include your API key in the header:
{
  "content-type": "application/json",
  "api-key": YOUR_API_KEY
}

Example Payload

{ "destination": { "restaurantId": "YOUR_RESTAURANT_ID", "restaurantName": "Your Restaurant Name" },
"payload": { "customer": { "customerName": "John Doe", "phoneNumber": "1234567890" }, "order": { "orderNumber": "ORDER12345", "items": [ { "id": "item_id_1", "name": "Cheeseburger", "price": 8.99, "quantity": 1,
"modifiers": [ { "id": "mod_id_1", "name": "Extra Cheese", "price": 1.00, "quantity": 1 } ] } ],
"subtotal": 9.99, "tax": 0.70, "total": 10.69, "orderType": "PICKUP", "ready_by": "2024-07-31T12:50:36-0700", "payment": { "status": "PAID" } }, "source": { "orderNumber": "SRC12345",
"placedOn": "2024-07-31T12:47:59-0700", "deliveryCompany": { "name": "Your Channel Name" } } }}