Request Delivery Cancellation

View as Markdown

Request the cancellation of a delivery that has already been created on the Rendr platform. This endpoint can be used once a delivery has been created, and accepts either the Rendr delivery_id or your own reference as the identifier.

This endpoint requests a cancellation — it does not guarantee the delivery will be cancelled. If the delivery has already been dispatched to a carrier, cancellation may not be possible and will be handled by the Rendr operations team.


Endpoint

PATCH {{domain}}/{{tenant_id}}/deliveries/{{delivery_id_or_reference}}/request-cancel

Authentication: Bearer token required via the Authorization header.


Path Parameters

ParameterDescription
delivery_id_or_referenceThe Rendr delivery_id returned at delivery creation, or your own reference value.

Request Payload

POST /{{tenant_id}}/deliveries/{{delivery_id_or_reference}}/request-cancel
1{
2 "reason": "out_of_stock"
3}

Request Fields

FieldTypeRequiredDescription
reasonStringNoFree-text explanation for the cancellation request. Used by the Rendr customer service team when handling the cancellation. Examples: out_of_stock, customer_requested, duplicate_order.