An order's status changed

POST

Sent when an order moves to a new status, for example from placed to accepted.

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

order_id

required

string

channel

string

channel_ref

string

previous_status

required

Channel-neutral order status.

string

Allowed values: placed accepted preparing ready picked_up delivered rejected cancelled

status

required

Channel-neutral order status.

string

Allowed values: placed accepted preparing ready picked_up delivered rejected cancelled

version

required

integer

Responses

200

Return any 2xx within 10 seconds to acknowledge.