Courier Status Update

This webhook will provide an update of each delivery in real time based on information being shared by the party responsible for Delivery. Common use cases for this endpoint are:

Building a customer facing Order Tracker in your order platform
Controlling when to inject the order into the kitchen for preparation (fireTime) based on courier arrival time for freshest delivery and optimal courier wait time in store.

Some of the common ways an event will be sent will be based on the below rules, early on events will be quite sporadic but during the course of the delivery once an order has been assigned, they will become more regular, note the same status enum will be received with different details within:

Coordinates of assigned courier have changed
pickupTimeETA or deliveryTimeETA has changed by greater or less than 60 seconds
The status of the delivery has been changed eg. Delivery Created -> En Route to Pickup
The assigned Courier has been reassigned
Add dispatchPartner as a param in the list and example

📘
Delivery Updates from Dispatch Partners
Note that this webhook is returning results only when there is a registered Dispatch partner that has integrated with our Dispatch API and is connected to the customer (restaurant, food business) account.

Definitions

Parameter	Meaning
orderId	The unique ID from Deliverect
channelOrderId	The unique ID from the ordering channel
status	The status from the list of value supported for updates.
pickupTime	The arrival time for the courier to their pickup location (only available until "status": 85)
deliveryTime	The delivery time from the partner.
courierName	Name of the courier delivery.
coordinates	The coordinates object.

Available status for courier update

Status	Description	Value
Courier assigned	The delivery partner has assigned a courier for the delivery	73
No courier found	The creation event failed and we are no longer able to find a courier	76
Delivery Created	This is to confirm a delivery partner has confirmed acceptance of the delivery request	81
En Route To Pickup	Specific stage of the courier approaching the pickup location	83
Arrived At Pickup	Courier has arrived at the pickup location	85
En Route To Dropoff	Specific stage of the courier approaching the drop off location	87
Arrived At DropOff	Courier has arrived at the drop off location	89
Delivered	Finalized , order is fully handled and no further POS status updates are coming	90
Delivery Auto Canceled	Channel partner cancels the delivery	114
Delivery Canceled	Dispatch partner cancels the delivery	115

{   "dispatchPartner": "example",
    "orderId": "651142e93c54c5405****6a3",
    "channelOrderId": "TEST12341156",
    "status": 83,
    "courierName": "DRIVER NAME"
}

{"orderId": "658052e*******d39f3",
 "channelOrderId": "**D-*****32",
 "status": 87,
 "deliveryTime": "2023-12-18T14:29:07.295000Z",
 "courierName": "John  S.",
 "coordinates": {"coordinates": [-3.7018185, 40.401814]}}

Response format

OK

📘Delivery Updates from Dispatch Partners

Definitions

Available status for courier update

Response format

📘
Delivery Updates from Dispatch Partners