Status Update



Payload

Sent by Deliverect as a JSON payload.

Each event is sent as a single HTTP POST request with a timeout of 20 seconds. Every event is delivered in one attempt, whatever response status is returned, so we recommend acknowledging with a 2xx response straight away and processing the payload asynchronously.

string

Deliverect's unique identifier of the order.

integer

New order status (see all Order statuses here).

date-time

Time of the status change, in the format yyyy-MM-ddTHH:mm:ss.SSSSSSZ.

string

Reason for the status change, where provided (e.g. on cancellation).

string

Unique identifier of the order on the ordering channel.

string

locationId is the unique identifier of a physical restaurant location, store, or kitchen

boolean

true when the status was sent by the POS but not applied to the order.

Headers
string
required

Identifies Deliverect as the sender, in the format Deliverect/{version}.

string
required

Signature of the raw request body using your shared secret; recompute it on receipt to verify the request came from Deliverect (see HMAC authentication guide).

Response
200

Return a 2xx status to acknowledge receipt.

LoadingLoading…