Create/ingest an order

Time	Status	User Agent
Retrieving recent requests…

Time

Status

User Agent

Retrieving recent requests…

uuid

required

Unique identifying string for an order.

display_id

string

required

5-character display friendly id, used by stores and delivery partners to identify the order.

external_order_id

string | null

Optional custom/3rd party order id supplied when accepting the order.

channel_order_id

string

The order id provided by the order placement channel.

current_state

string

enum

required

The current state of the order.

Allowed:

type

string

enum

required

The dining type of the order. In case of delivery the order charges will include a tip and delivery fee.

Allowed:

store

object

Details of the Store for which the order was placed.

customer

object

required

Details of the customer that placed the order.

charges

object

Charges related to the order.

discounts

array of objects | null

discounts

payments

array of objects

required

payments*

items

array of objects

The list of menu items added to the order.

items

requested_for_time

string

The time at which the order is scheduled to be ready for pick-up or delivery.

system_instructions

string | null

System-provided instructions for the order, including vehicle info in case of kerbside delivery. May include call-center notes

channel

string

enum

The ordering channel used by the customer.

Allowed:

created_date

string

The time at which the order was placed.

200ok