post https://yourwebhook.com/courier_update
To receive courier-related updates while a location is using dispatch partners you need to listen to this webhook. It would be providing new information about the courier journey as soon as a change has been made to it :
- deliveryTimeETA changes by greater than 60 seconds (UTC format)
- Changes in courier name
- The delivery partner has performed an action that resulted in the status change for the order
- Coordinates where provided by Dispatch partner will be shared
The same status may received be multiple times. If there are relevant updates on the pickupTime, deliveryTime or coordinates, a new update will be triggered.
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. It does not return results from channel partners that may also deliver the orders.
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 |
{
"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