POST https://webhook.example.com
Bearer auth
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 /yourwebhook.com/courier_update
Request example 
{
  "status": 83,
  "orderId": "651142e93c54c5405****6a3",
  "courierName": "DRIVER NAME",
  "channelOrderId": "TEST12341156"
}