Skip to main content
POST
Create order

Authorizations

X-Api-Key
string
header
required

Your API key provided during onboarding. Example c2fb5ae6ea99c37d...

X-Merchant-Id
string
header
required

Your numeric merchant ID. Example 1

Path Parameters

outlet_id
integer
required
channel_id
integer
required

Body

application/json
serving_date
string<date>
timeslot_start
integer
timeslot_end
integer
timeslot_type
string
contact_name
string
contact_email
string
contact_number
string
fulfilment_type
string
notes
string
source_label
string
external_order_id
string
is_paid
boolean
subtotal
integer

Admin override

total
integer

Admin override

tax
integer

Admin override

discount
integer

Admin override

surcharge
integer

Admin override

delivery_fee
integer

Admin override

order_items
object[]
order_payments
object[]

Response

Created order

id
integer
identifier
string
user_id
integer
channel_id
integer
outlet_id
integer
brand_id
integer
fulfilment_type
string
state
string
call_number
integer
notes
string | null
source_label
string | null
serving_date
string<date>
timeslot_start
integer
timeslot_end
integer
timeslot_range
string
contact_name
string
contact_email
string
contact_number
string
external_order_id
string | null
external_order_short_code
string | null
is_gift
boolean
is_paid
boolean
promo_code
string | null
address_line1
string | null
address_line2
string | null
address_latitude
number | null
address_longitude
number | null
postal_code
string | null
is_cutlery_required
boolean
is_contactless
boolean
is_asap
boolean
recipient_name
string | null
recipient_contact_number
string | null
recipient_organisation_name
string | null
gift_message
string | null
confirmation_custom_message
string | null
current_trip
object | null
payment_breakdown
object
created_at
integer
updated_at
integer
cancelled_at
integer | null
completed_at
integer | null
order_items
object[]
order_payments
object[]