Order Notification

webhook

https://yourwebhook.com/orders

Purpose

When a customer orders from a Deliverect integrated channel, it will immediately deliver a webhook even to a specified endpoint provided by the POS.

This order will contain the products, prices, payment information and any customer info provided by the channel.

Order Model

For a full list of all order attributes and their definitions, see the link below;

▶ POS Order Model

Order Types

The type of order can be displayed to the user on the KDS

Type	Integer Value
pickup	`1`
delivery	`2`
eat in	`3`
curbside	`4`

Order Cancellations

Cancellations will also be sent to the KDS order notification webhook URL, see how to receive and process these correctly in the guide below;

▶ Order Cancellations

Payload

Sent by Deliverect as a JSON payload.

orderId

string

Unique identifier of the order in Deliverect.

account

string

Unique customer account ID in Deliverect.

location

string

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

channelOrderId

string

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

channelOrderDisplayId

string

Alternative order ID set by ordering channel, primarily for convenience and readability. This is not unique and typically a shortened version of channelOrderId consisting of 4-5 alphanumeric characters, although may go up to 12 characters.

posReceiptId

string

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

orderType

integer

enum

Type of order.

Pickup: 1
Delivery: 2
Eat in: 3
Curbside: 4
Drive thru: 5

Allowed:

channel

integer

Unique ID of the channel (see GET Integrated channels).

pickupTime

date-time

Time the order is due to be picked up, in the format yyyy-MM-ddTHH:mm:ss.SSSSSSZ.

deliveryIsAsap

boolean

Signifies if the order is required as soon as possible.

note

string

Overall note for an order.

items

array of objects

All the items included in an order.

items

packaging

object

Order-level packaging preferences.

brandId

string

Appears where the customer operates multiple brands from one location (see Get account brands).

brandName

string

Name of the brand linked to brandId.

remake

boolean

Indicates the order has been sent again to be remade.

customerName

string

Name of the customer.

status

integer

Current order status (see all Order statuses here).

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).

Responses

200

201

Purpose

Order Model

Order Types

Order Cancellations

204