Courier Update

webhook

https://yourwebhook.com/courier_update

Sends courier details and delivery progress whenever they change.

Purpose

Where delivery platforms provide courier statuses or a 3rd party 'Dispatch' service is enabled, the details of the delivery progress will be sent whenever they change

Delivery job statuses

Status name	Meaning	Integer value
`EN_ROUTE_TO_PICKUP`	Courier approaching the pickup location	`83`
`ARRIVED_AT_PICKUP`	Courier has arrived at the pickup location	`85`
`EN_ROUTE_TO_DROPOFF`	Courier approaching the drop-off location	`87`
`ARRIVED_AT_DROPOFF`	Courier has arrived at the drop-off location	`89`
`DELIVERED`	Courier has delivered the order	`90`

Parameters

Parameter	Meaning	Type
`received`	Timestamp of when the update was generated	str
`orderId`	Unique Deliverect order ID	str
`rawDriverUpdate`	An empty array not currently in use	array of str
`updatedOrigin`	`2` = Channel `6` = Courier (via Dispatch)	int
courier	—	array of str
courier.`firstName`	—	str
courier.`lastName`	—	str
courier.`phoneNumber`	—	str
courier.`deliveryBy`	The delivery party responsible	str
courier.`status`	See Delivery job statuses	int
`pickupTime`	The correct `pickupTime` for the order when the status was generated	str
`deliveryTime`	The anticipated order delivery time	str
`location`	The unique ID of the Deliverect location	str

Sent to the reporting webhook URL configured during onboarding. Where delivery platforms provide courier statuses or a 3rd party 'Dispatch' service is enabled, the details of the delivery progress will be sent whenever they change.

Payload

Sent by Deliverect as a JSON payload.

received

date-time

Time the courier update was received, in the format yyyy-MM-ddTHH:mm:ss.SSSSSSZ.

orderId

string

Deliverect's unique identifier of the order.

pickupTime

date-time

Estimated time the courier picks up the order, in the format yyyy-MM-ddTHH:mm:ss.SSSSSSZ.

deliveryTime

date-time

Estimated time the order is delivered to the customer, in the format yyyy-MM-ddTHH:mm:ss.SSSSSSZ.

location

string

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

courier

object

Courier assigned to the delivery and their current progress.

handoffInstructions

string

Instructions for handing the order to the courier.

passcode

string

Passcode the courier presents at pickup, where applicable.

updatedOrigin

integer

The source from where the update is coming: 1 = POS, 2 = Channel, 3 = DMA, 4 = Driver, 5 = Internal, 6 = Delivery System, 7 = Manual, 8 = KDS, 9 = Bill to Order Status.

rawDriverUpdate

string

Raw courier update as received from the delivery service, as a JSON string.

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.