Skip to main content

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 cancellationReason field. It is null when the delivery is not canceled; when status is canceled, it may be one of the values below (or could be null if User Initiated with a null Reason Code).

Exposed reason values

ValueDescription
User RequestedCancellation was requested by the customer or the user who booked the delivery.
Driver IssueDriver-related issue.
Dropoff IssueProblem at drop-off.
Pickup/Dropoff IssueGeneral pickup or drop-off problem.
Material IssueIssue with items or material.
Vehicle IssueVehicle or capacity issue.
Weather IssueWeather-related cancellation.
OtherAny 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.