Courier Status Update

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

ParameterMeaning
orderIdThe unique ID from Deliverect
channelOrderIdThe unique ID from the ordering channel
statusThe status from the list of value supported for updates.
pickupTimeThe arrival time for the courier to their pickup location (only available until "status": 85)
deliveryTimeThe delivery time from the partner.
courierNameName of the courier delivery.
coordinatesThe coordinates object.

Available status for courier update

StatusDescriptionValue
Courier assignedThe delivery partner has assigned a courier for the delivery73
No courier foundThe creation event failed and we are no longer able to find a courier76
Delivery CreatedThis is to confirm a delivery partner has confirmed acceptance of the delivery request81
En Route To PickupSpecific stage of the courier approaching the pickup location83
Arrived At PickupCourier has arrived at the pickup location85
En Route To DropoffSpecific stage of the courier approaching the drop off location87
Arrived At DropOffCourier has arrived at the drop off location89
DeliveredFinalized , order is fully handled and no further POS status updates are coming90
Delivery CanceledDispatch partner cancels the delivery115
{
    "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
Language