Order Status Update

webhook

https://yourwebhook.com/order_status

Purpose

Whenever a POS updates the status of an order, we will deliver a webhook event to your specified endpoint.

Each integrated POS will provide statuses in accordance with their own workflows, meaning the specific statuses received can vary, yet any order with status between 20 (Accepted) and 95 (Auto-finalized) confirms a successfully accepted order.

Statuses higher than 95, indicate that something went wrong with the order.

▶ See All Order Statuses

Cancelations

An ordering platform can process cancellations via the /order endpoint (see Create / Cancel Order) cancellations can also be initiated from the POS.

When a POS cancels an order, a status 110 is sent, this information should be communicated to the end-consumer in whichever manner possible i.e. in-app, email, SMS notification of an unsuccessful order.

When a merchant choses not to accept an order via our Delivery Manager App (DMA) they can choose to 'Reject' the order, in which case, the status 'Denied' is sent 35

Payload

orderId

string

Unique identifier of the order in Deliverect.

status

integer

Order status (see list here).

timeStamp

date-time

Timestamp of the status update, in UTC yyyy-MM-ddTHH:mm:ss.SSSZ.

receiptId

string

Provided by the POS in response to incoming orders as a reference to a specific POS receipt.

reason

string

In case of error, cancellation or denial, the reason will be populated here, if provided.

channelOrderId

string

The full unique ID from the delivery channel. Together with the channel is guaranteed to be unique for 48h after pickup.

location

string

Deliverect's unique identifier of a physical restaurant location, store, or kitchen.

channelLink

string

Unique identifier of the channel (merchant store) in Deliverect. Retrieve all IDs per account via GET Channel Links.

Headers

User-Agent

string

required

Defaults to Deliverect/{version}

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

X-Server-Authorization-HMAC-SHA256

string

required

Defaults to {signature}

HMAC-SHA256 signature of the raw request body, generated with your shared secret. Recompute the signature on receipt and compare it to this value to verify the request came from Deliverect (see the HMAC authentication guide).

Responses

Purpose

Cancelations

200200

400400