Courier Update

Purpose

This webhook delivers real-time updates on each delivery job, based on information provided by the integrated Dispatch partner.

Format

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 with a customer location for courier status updates to be received.

Definitions

The various attributes delivered with Courier status updates are listed in the link below;

▶ Courier Status Model

Courier Statuses

For a full list of all courier status values, see the link below;

▶ Courier Statuses

Example Courier Status Updates

{
    "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",
    "trackingURL": "trackingURL"
}

{
    "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
}

⚠️ Tracking URL Availability

The tracking URL is returned only when supported by the Dispatch provider.

Response format

OK