Order Payload Example

{
  "destination": {
    "storeId": "b6c5ead5-c8db"
  },
  "payload": {
    "customer": {
      "customerName": "John Doe",
      "phoneNumber": "5552221234",
      "phoneCode": "",
      "customerEmail": "[email protected]",
      "streetName": "Av 1",
      "zipCode": "90001",
      "city": "Los Angeles",
      "state": "CA",
      "deliveryNotes": ""
    },
    "order": {
      "orderType": "DELIVERY",
      "ready_by": "2024-05-29T12:50:36-0700",
      "thirdPartyManagedDelivery": true,
      "ooServiceFee": 1.99,
      "merchantOrderFee": 0.00,
      "subtotal": 18.09,
      "staffTip": 0.00,
      "discount": 0.00,
      "tax": 0.59,
      "deliveryFee": 5.67,
      "driverTip": 1.50,
      "driverComp": 0.00,
      "total": 27.84,
      "payment": {
        "status": "PAID",
        "mode": "CREDIT_CARD"
      },
      "delivery": {
        "quote_id": 123
      },
      "items": [
        {
          "id": "item_id_1",
          "modifiers": [
            {
              "id": "modifier_id_1",
              "name": " Brioche Bun",
              "price": 4.20,
              "quantity": 1
            }
          ],
          "name": "Meat Burger Sandwich",
          "note": "Medium-Rare please",
          "price": 11.90,
          "quantity": 1,
          "total": 11.90
        }
      ],
      "orderNotes": ""
    }
  },
  "source": {
    "additionalInfo": "",
    "orderNumber": "3954956c677d",
    "placedOn": "2024-05-29T12:30:01-0700"
  }
}

Notes

destination.storeId is your channel's merchant / restaurant / store id for this restaurant.
All money fields are in dollars (18.09, not 1809).
customer.phoneNumber must be a 10-digit number without the country code (5552221234). Put the country code in phoneCode.
order.delivery is optional. Include it only if OrderOut should also dispatch a courier for this order: set delivery.quote_id to the id of a quote from Get Quotes for the same restaurant, with orderType: "DELIVERY". The pickup and drop-off addresses come from the quote; the customer name and phone, subtotal and driverTip come from this order. See Dispatch a delivery from your order push.

❗️
Including delivery.quote_id dispatches a real courier
If you don't cancel before a driver is assigned, there is a $10 cancellation fee, for you and for OrderOut.

Including delivery.quote_id dispatches a real courier

Including `delivery.quote_id` dispatches a real courier