Cancellation Reasons
Where cancellation reason appears
- GraphQL API — When you query
delivery { cancellationReason }, the field returns one of the values below. - Webhooks — Each webhook payload includes a top-level
cancellationReasonfield. It isnullwhen the delivery is not canceled; whenstatusiscanceled, it is one of the values below.
Exposed reason values
| Value | Description |
|---|---|
| User Requested | Cancellation was requested by the customer or the user who booked the delivery. |
| Driver Issue | Driver-related issue. |
| Dropoff Issue | Problem at drop-off. |
| Pickup/Dropoff Issue | General pickup or drop-off problem. |
| Material Issue | Issue with items or material. |
| Vehicle Issue | Vehicle or capacity issue. |
| Weather Issue | Weather-related cancellation. |
| Other | Any cancellation reason not mapped to one of the above. |
Example
Webhook payload (canceled delivery):
{
"id": "del_XXXXXXXXXX",
"status": "canceled",
"cancellationReason": "User Requested",
...
}
GraphQL (API authentication):
query {
delivery(id: "del_XXXXXXXXXX") {
id
status
cancellationReason
}
}
Response when canceled:
{
"data": {
"delivery": {
"id": "del_XXXXXXXXXX",
"status": "canceled",
"cancellationReason": "User Requested"
}
}
}
When the delivery is not canceled, cancellationReason is null.