Tracking, Statuses & Webhooks

Confirm Return

View as Markdown

Allows store staff to confirm the status of an order return — whether the order was fully returned, partially returned, or not returned at all. Optionally triggers a customer notification via email and/or SMS on confirmation.

Endpoint

PATCH {{domain}}/{{tenant_id}}/deliveries/{{delivery_id_or_reference}}/confirm-return

Authentication: Bearer token required via the Authorization header.

Path Parameters

ParameterDescription
delivery_id_or_referenceThe Rendr id or your own reference of the delivery being confirmed as returned.

Request Payload

PATCH /{{tenant_id}}/deliveries/{{delivery_id_or_reference}}/confirm-return
1{
2    "note": "all_return",
3    "notification_channels": [
4        "email",
5        "sms"
6    ]
7}

Request Fields

FieldTypeRequiredDescription
noteStringYesThe return outcome. Accepted values: all_return, partial_return, no_return.
notification_channelsArrayNoNotification channels to use when confirming the return to the customer. Accepted values: email, sms.