Skip to main content
POST
Create order

Authorizations

X-Channel-Id
string
header
required

Merchant storefront identifier. Provided during onboarding.

X-Session-Id
string
header
required

Diner session identifier. Created by GET /channel and returned in the X-Session-Id response header.

Response

Order created successfully

id
integer
identifier
string
channel_id
integer
outlet_id
integer
brand_id
integer
brand
object | null
fulfilment_type
string
state
string
call_number
string | null
notes
string | null
serving_date
string<date>
timeslot_start
integer
timeslot_end
integer
timeslot_range
string
timeslot_type
string
contact_name
string
contact_email
string
contact_number
string
address_line1
string | null
address_line2
string | null
address_latitude
number<double> | null
address_longitude
number<double> | null
postal_code
string | null
is_cutlery_required
boolean
is_contactless
boolean
is_asap
boolean
is_gift
boolean
recipient_name
string | null
recipient_contact_number
string | null
recipient_organisation_name
string | null
gift_message
string | null
is_paid
boolean
promo_code
string | null
confirmation_custom_message
string | null
payment_breakdown
object
claim_token_url
string | null
eligible_points
integer
eligible_points_value
integer
created_at
integer

Unix timestamp

updated_at
integer

Unix timestamp

cancelled_at
integer | null

Unix timestamp

completed_at
integer | null

Unix timestamp

order_items
object[]
order_payments
object[]