Courier Status Update

Courier Status Updates

Webhook events are triggered based on the following conditions. Early in the delivery process, events may be infrequent but become more regular after an order is assigned. The same status enum may be sent with updated details:

Courier co-ordinates change
pickupTimeETA or deliveryTimeETA changes by more than 60 seconds
Delivery status changes (e.g., DELIVERY_CREATED → EN_ROUTE_TO_PICKUP)
A courier is reassigned

ⓘ Requires Integrated Dispatch
A Dispatch provider needs to be integrated in a customer location for courier status updates to be received

Definitions

Parameter	Meaning	Type
`orderId`	The unique ID of the order in Deliverect	String
`channelOrderId`	The unique ID of the order sourced from the ordering channel	String
`status`	The status from the list of values supported for updates.	Integer
`pickupTime`	The arrival time for the courier to their pickup location (only available until "status": 85)	String
`deliveryTime`	The delivery time from the ordering channel	String
`courierName`	Name of the courier delivery.	String
`coordinates`	The coordinates object showing Longitude / Latitude	Object
`courierId`	Where Deliverect courier app is used, this is the unique Id of the courier	String
`dispatchPartner`	The name of the dispatch partner	String
`multipleDrivers`	This will be sent as true when the delivery is split across more than one driver	Boolean

Courier Status Updates

▶ See All Courier Statuses

{
    "orderId": "651142e93c54c5405****6a3",
    "channelOrderId": "T8****28",
    "status": 87,
    "deliveryTime": "YYYY-MM-DDT08:36:46.SSSSSSZ",
    "courierName": "DRIVER NAME",
    "coordinates": {
        "coordinates": [
            -4.294259666220875,
            55.78873945318564
        ]
    },
    "courierId": "9B******HK",
    "dispatchPartner": "COURIERAPP"
}

{
    "orderId": "651142e93c54c5405****6a3",
    "channelOrderId": "T8****29",
    "status": 87,
    "deliveryTime": "YYYY-MM-DDT08:36:46.SSSSSSZ",
    "courierName": "DRIVER NAME",
    "coordinates": {
        "coordinates": [
            -4.294259666220875,
            55.78873945318564
        ]
    },
    "courierId": "9B******HL",
    "dispatchPartner": "UBERDAAS",
    "multipleDrivers": true
}

Response format

OK