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

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 Auto CanceledChannel partner cancels the delivery114
Delivery CanceledDispatch partner cancels the delivery115
{   "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
Language