PUT <baseURL>/deliveries/{deliveryId}/cancel
This request cancels a delivery after the delivery has been booked and before it is picked up by the delivery driver.
Call this request when the customer cancels an order so that a delivery driver is not sent to the pickup point.
Orders can be canceled up until the delivery driver has picked it up from a pickup point.
Orders cannot be canceled after the delivery status has changed to DISPATCHED.
Example
This request cancels the delivery of clientId of 49304, externalOrderId of 10208877499-208925547882099, and deliveryId of 4e9cf4d5-be96-4b30-a76e-073b5f912345:
PUT {baseURL}/deliveries/ffd1ea37-7903-466f-9b9e-3538a12db256/cancel
Request body:
{ "deliveries": { "clientId": "49304", "externalOrderId": "10208877499-208925547882099", "reasons": [ { "code": "CD-002" } ] }
}
Response (200 OK):
{ "deliveries": { "externalOrderId": "10208877499-208925547882099", "deliveryId": "4e9cf4d5-be96-4b30-a76e-073b5f912345" }
}
See Also
To book a delivery, see POST /deliveries.
To update information about the delivery, see PUT /deliveries/{deliveryId}/update.