Canceling an order
It is possible to cancel a delivery order after creation but note that not in all cases that this cancellation will have an affect on the outcome of the delivery. This would still lead to a 200 response to the cancellation as we have acknowledged the receipt via the API.
What we recommend to the partners is that after the order is collected by the Dispatch partner to no longer offer cancellation as an option on their platform. Cancellation at any point post acceptance by a partner may lead to a cost incurred.
It is up to the merchant and the channel to define what is expected for that scenarios especially regarding refunds.
| Parameter | Meaning | Type |
|---|---|---|
channelLinkId* | Unique identifier(s) of the channel(s) (merchant store) in Deliverect. | string |
channelOrderId* | The full unique ID from the ordering channel, cannot be re-used more than once in the same 24hr period | string |
channelOrderDisplayId* | This is crucial for ensuring the communication between your kitchen staff and the courier carrying out the delivery so that a smooth handover can occur. | string |
status* | To cancel an order send "status": 100, | int |
cancellationReason* | Reason to cancel the order | string |
To cancel an order, use the create order endpoint and specify the same original order details as shown below. Deliverect will then apply the CANCEL (100) status to the order and pass this to the assigned Dispatch partner.
To test this out, see the Cancel order example on the right hand side of this page.
{
"channelOrderId":"channelOrderId",
"channelOrderDisplayId":"channelDisplayOrderId",
"channelLinkId":"5e****abc11dec0001****9b",
"status": 100,
"cancellationReason": "Customer requests order cancellation"
}