Create Return Delivery

View as Markdown

Return deliveries are created using the standard delivery and quote endpoints by including is_returned: true in the request payload. This flags the shipment as a return — goods travelling back toward the origin (e.g. a customer returning an item to a retailer).


Endpoints

POST {{domain}}/{{tenant_id}}/deliveries
POST {{domain}}/{{tenant_id}}/deliveries/quote-next-available

Authentication: Bearer token required via the Authorization header.


The is_returned Flag

1{
2 "is_returned": true
3}
PropertyValue
TypeBoolean
RequiredNo
Defaultfalse
Applies toPOST /deliveries, POST /quotes

Behaviour When is_returned: true

Reference — RTN prefix auto-generated

The delivery reference is automatically prefixed to distinguish it from the original forward shipment:

RTN1-{original_reference}
RTN2-{original_reference} ← if RTN1 already exists

Service availability — filtered to return-eligible services

Only carrier services configured to support returns are considered when quoting or booking. Postage-only services are excluded.

Notifications — return-specific events

When is_returned: true and SMS or email notification flags are set, the system fires a return delivery created notification event rather than the standard delivery created event.


The following fields can be included alongside is_returned to provide additional context for the return shipment.

FieldTypeDescription
original_referenceStringThe reference of the original forward delivery being returned.
return_instructionsStringSpecial handling instructions for the return shipment.
send_return_delivery_smsBooleanSend an SMS notification to the customer on return delivery creation.
send_return_delivery_emailBooleanSend an email notification to the customer on return delivery creation.

For more information and to understand the customer experience for returns, see the Create & Manage Returns guide.