# Courier Status Update

**POST /channel/courier_update**

# 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;

|                                                                                                                                                                                                  |                                                                                                        |           |
| :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------- | :-------- |
| <span style={{backgroundColor: "#39b54a", color: "white", borderRadius: "16px", fontFamily: "Helvetica", fontWeight: "light", fontSize: "11px", padding: "5px 10px"}}>In Delivery</span>         | The Delivery partner has confirmed the job is assigned to a courier for the completion of the delivery | **`80`**  |
| <span style={{backgroundColor: "#39b54a", color: "white", borderRadius: "16px", fontFamily: "Helvetica", fontWeight: "light", fontSize: "11px", padding: "5px 10px"}}>Delivery Created</span>    | The Delivery partner has confirmed the acceptance of the delivery job                                  | **`81`**  |
| <span style={{backgroundColor: "#0eb552", color: "white", borderRadius: "16px", fontFamily: "Helvetica", fontWeight: "light", fontSize: "11px", padding: "5px 10px"}}>En Route to Pickup</span>  | Courier approaching the pickup location                                                                | **`83`**  |
| <span style={{backgroundColor: "#0eb552", color: "white", borderRadius: "16px", fontFamily: "Helvetica", fontWeight: "light", fontSize: "11px", padding: "5px 10px"}}>Almost at Pickup</span>    | Courier within a short distance of the pickup location                                                 | **`84`**  |
| <span style={{backgroundColor: "#0eb552", color: "white", borderRadius: "16px", fontFamily: "Helvetica", fontWeight: "light", fontSize: "11px", padding: "5px 10px"}}>Arrived at Pickup</span>   | Courier has arrived at the pick up location                                                            | **`85`**  |
| <span style={{backgroundColor: "#39b54a", color: "white", borderRadius: "16px", fontFamily: "Helvetica", fontWeight: "light", fontSize: "11px", padding: "5px 10px"}}>En Route To Dropoff</span> | Courier approaching the drop off location                                                              | **`87`**  |
| <span style={{backgroundColor: "#39b54a", color: "white", borderRadius: "16px", fontFamily: "Helvetica", fontWeight: "light", fontSize: "11px", padding: "5px 10px"}}>Arrived At Drop Off</span> | Courier has arrived at the drop off location                                                           | **`89`**  |
| <span style={{backgroundColor: "#39b54a", color: "white", borderRadius: "16px", fontFamily: "Helvetica", fontWeight: "light", fontSize: "11px", padding: "5px 10px"}}>Delivered</span>           | Courier has delivered the order                                                                        | **`90`**  |
| <span style={{backgroundColor: "#4E4E4E", color: "white", borderRadius: "16px", fontFamily: "Helvetica", fontWeight: "light", fontSize: "11px", padding: "5px 10px"}}>Delivery Canceled</span>   | Courier has canceled the Delivery                                                                      | **`115`** |


## Servers
- Staging Environment: https://api.staging.deliverect.com (Staging Environment)


## Authentication methods
- Bearer auth


## Parameters



### Body: application/json (object)

- **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
- **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
Ok

### 400
Bad Request


[Powered by Bump.sh](https://bump.sh)