Update Courier / Guest Status

Purpose

Update courier or a guest's delivery status.

Courier Update Status:

See the available statuses to set via the link below;

▶ See Courier Statuses

📘

Status Updates

In order to help venues optimise their order workflow, it is vital that key stages of Pickup, Dropoff and Order Completion are communicated as and when they apply.

Customer Arrival Updates

A channel can also use this endpoint to process updates relating to a customers arrival status for either pickup or curbside orders.

Only with the statuses below can "pickupNotes" be applied to pass on details of the customer's current location and other details like their vehicle registration.

Status NameInteger Value
EN_ROUTE_TO_PICKUP83
ALMOST_AT_PICKUP84
GUEST_ARRIVED85

Path Params
string
required
Defaults to my-channel
string
required
Defaults to 61bcc34f657cc48c23eb60d5
Body Params
string
required
courierUpdate
object
required
Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json