v1

latestOpenAPI 3.0.02026-08-04380104.3 KB
Relay Delivery

Cancel Delivery

Cancel an active relay delivery. A cancellation reason is required.

post/relay/delivery/{reference}/cancel

Path parameters

referencestring required

The unique reference of the delivery to cancel.

Request body

reasonstring required

The reason for cancelling the delivery.

Example request

{
  "reason": "Customer requested cancellation"
}

Response

Delivery cancelled successfully.

statusstring
messagestring

Example response

{
  "status": "success",
  "message": "Delivery cancelled successfully"
}