Status Update

webhook

https://yourwebhook.com/order_status_update

Sends each change to an order's status.

Introduction

Each order preparation status change can trigger a webhook specifying the order status. This data can be included in BI dashboards or other reporting services for example to monitor order preparation efficiency using the timestamps between stage of the order lifecycle

Sent to the reporting webhook URL configured during onboarding. Each order preparation status change can trigger a webhook specifying the order status.

Order Statuses

See the link below for all order statuses, each of which can be applied as a triggered event e.g. delivering all orders statuses after they reach the status 'Accepted'

▶ Order Statuses

Payload

Sent by Deliverect as a JSON payload.

orderId

string

Deliverect's unique identifier of the order.

status

integer

New order status (see all Order statuses here).

timeStamp

date-time

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

reason

string

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

channelOrderId

string

Unique identifier of the order on the ordering channel.

location

string

locationId is the unique ID for the POS to identify the store location.

isIgnoredPOSStatus

boolean

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

Headers

User-Agent

string

required

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

X-Server-Authorization-HMAC-SHA256

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.