A new order arrived

POST

Sent when a new order arrives from any channel. data contains the full order.

Authorizations

• bearerAuth

Parameters

Header Parameters

webhook-id

required

string

Unique delivery ID; equal to the event ID. Use it to ignore duplicates.

webhook-timestamp

required

string

Unix timestamp (seconds) when the delivery was signed.

webhook-signature

required

string

Standard Webhooks signature (v1,<base64 HMAC-SHA256>).

Request Body^required

Media typeapplication/json

object

id

required

string

type

required

string

created_at

required

string format: date-time

merchant_id

required

string

location_id

string | null

connection_id

required

string

origin

required

What caused the change. Ignore events where application_id is your own.

object

type

string

Allowed values: channel api web_app system

application_id

string | null

data

required

Event-specific payload.

object

key

additional properties

any

data

required

object

id

required

string

version

required

Increases on every change. Use it to discard stale updates.

integer

merchant_id

required

string

location_id

required

string

channel

required

Channel ID from GET /channels.

string

channel_connection_id

string

channel_ref

required

The order number shown on the channel, for staff and support.

string

type

required

string

Allowed values: delivery pickup dine_in

status

required

Channel-neutral order status.

string

Allowed values: placed accepted preparing ready picked_up delivered rejected cancelled

status_history

Array<object>

object

status

required

Channel-neutral order status.

string

Allowed values: placed accepted preparing ready picked_up delivered rejected cancelled

at

required

string format: date-time

scheduled_for

string | null format: date-time

items

required

Array<object>

object

name

required

Text in the languages the merchant provided.

object

en

string | null

ar

string | null

sku

string | null

quantity

required

integer

unit_price

required

An amount in minor units (halalas for SAR).

object

amount

required

integer

currency

required

ISO 4217 code.

string

modifiers

Array<object>

object

name

Text in the languages the merchant provided.

object

en

string | null

ar

string | null

quantity

integer

unit_price

An amount in minor units (halalas for SAR).

object

amount

required

integer

currency

required

ISO 4217 code.

string

notes

string | null

totals

required

object

subtotal

required

An amount in minor units (halalas for SAR).

object

amount

required

integer

currency

required

ISO 4217 code.

string

discount

An amount in minor units (halalas for SAR).

object

amount

required

integer

currency

required

ISO 4217 code.

string

delivery_fee

An amount in minor units (halalas for SAR).

object

amount

required

integer

currency

required

ISO 4217 code.

string

tax

An amount in minor units (halalas for SAR).

object

amount

required

integer

currency

required

ISO 4217 code.

string

total

required

An amount in minor units (halalas for SAR).

object

amount

required

integer

currency

required

ISO 4217 code.

string

payment

object

method

string

Allowed values: online cash card_on_delivery

paid

boolean

notes

string | null

created_at

required

string format: date-time

updated_at

required

string format: date-time

extensions

Channel-specific fields, keyed by channel ID. Safe to ignore.

object

key

additional properties

any

Responses

200

Return any 2xx within 10 seconds to acknowledge.