POST https://webhook.example.com
Bearer auth

Courier Status Updates

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

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

Courier Statuses For a full list of all courier status values, see the link below;
In Delivery The Delivery partner has confirmed the job is assigned to a courier for the completion of the delivery 80
Delivery Created The Delivery partner has confirmed the acceptance of the delivery job 81
En Route to Pickup Courier approaching the pickup location 83
Almost at Pickup Courier within a short distance of the pickup location 84
Arrived at Pickup Courier has arrived at the pick up location 85
En Route To Dropoff Courier approaching the drop off location 87
Arrived At Drop Off Courier has arrived at the drop off location 89
Delivered Courier has delivered the order 90
Delivery Canceled Courier has canceled the Delivery 115
application/json

Body

  • orderId string

    The unique ID of the order in Deliverect

  • channelOrderId string

    The unique ID of the order sourced from the ordering channel

  • status integer

    The status from the supported list of values for courier updates.

  • pickupTime string(date-time)

    The arrival time for the courier to their pickup location in UTC (yyyy-MM-ddTHH:mm:ssZ). Only available prior to status 85.

  • deliveryTime string(date-time)

    The delivery time shown in UTC (yyyy-MM-ddTHH:mm:ssZ)

  • courierName string

    Name of the courier / rider

  • coordinates object

    The coordinates object showing longitude and latitude

    Hide coordinates attribute Show coordinates attribute object
    • coordinates array[number(double)]

      At least 2 but not more than 2 elements.

  • courierId string

    Unique Id of the courier when using the Deliverect Courier App

  • dispatchPartner string

    The name of the dispatch partner company

  • multipleDrivers boolean

    Sent as true when the delivery is split across more than one driver

Responses

  • 200 application/json

    Ok

  • 400 application/json

    Bad Request

POST /channel/courier_update
Request example 
{
  "orderId": "651142e93c54c5405****6a3",
  "channelOrderId": "TEST12341156",
  "status": 83,
  "courierName": "DRIVER NAME"
}