Cancel a delivery you dispatched from an order push.
order_id can be either the delivery id or the OrderOut order id returned by POST /api/channel/order/push (order_id in its response).
Cancel before a driver is assignedDeliveries on
api.orderout.coare real. If a delivery is cancelled after a driver has been assigned, a $10 cancellation fee applies, to you and to OrderOut.
Cancellation is asynchronous: the response confirms the request (cancel_requested: true), and status reflects the state at the time of the call, not the final cancelled state.
Reason
reason is the reason code sent to the courier network. It is required and must be one of the codes below (case and _ are ignored, so customer_cancelled works). Put any free text in reason_comments.
| Code | Use when |
|---|---|
CustomerCancelled | The customer no longer wants the order. Default. |
CustomerChangedOrder | The customer changed the order (new order created, delivery switched to pickup, ...). |
MissedDropoffTime | The customer cancels because the delivery is late. |
CustomerOtherReason | Another customer reason. |
DriverMissedPickup | The restaurant cancels because the driver is late to pick up. |
SystemFailure | Order processing failed (POS transmission, payment, ...). |
UnableToFulfill | The restaurant can't make the order (out of stock, store closed, ...). |
VendorOtherReason | Another restaurant reason. |
PickupNotReady | The driver arrived but the order is not ready. |
DestinationUnreachable | The driver can't reach the customer. |
PackageContents | The customer refused the delivery: missing or wrong items. |
PackageDamage | The customer refused the delivery: damaged package. |
DriverFailure | The driver's vehicle failed. |
ServiceOverCommitted | The courier network has no driver available. |
DspOtherReason | Another courier-network reason. |
Free text inreasonA
reasonthat is not a code is still accepted for older integrations: it is sent asCustomerCancelledwith your text as the comments. This will become an error later, so send a code.
The response returns the reason and reason_comments that were sent.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||