Return
A Return holds information about Line Items that a Customer wishes to send back, along with how the items will be returned. Returns can also be used as part of a Swap or a Claim.
Properties
id
stringRequiredThe return's ID
created_at
DateRequiredThe date with timezone at which the resource was created.
updated_at
DateRequiredThe date with timezone at which the resource was updated.
Status of the Return.Default: requested
requested
The details of the items that the customer is returning.
swap_id
null | stringRequiredThe ID of the swap that the return may belong to.
The details of the swap that the return may belong to.
claim_order_id
null | stringRequiredThe ID of the claim that the return may belong to.
The details of the claim that the return may belong to.
order_id
null | stringRequiredThe ID of the order that the return was created for.
The details of the order that the return was created for.
The details of the Shipping Method that will be used to send the Return back. Can be null if the Customer will handle the return shipment themselves.
location_id
null | stringRequiredThe ID of the stock location the return will be added back.
shipping_data
Record<string, unknown>RequiredData about the return shipment as provided by the Fulfilment Provider that handles the return shipment.
refund_amount
numberRequiredThe amount that should be refunded as a result of the return.
received_at
DateRequiredThe date with timezone at which the return was received.
no_notification
null | booleanRequiredWhen set to true, no notification will be sent related to this return.
metadata
null | Record<string, unknown>RequiredAn optional key-value map with additional details
idempotency_key
null | stringRequiredRandomly generated key used to continue the completion of the return in case of failure.
Was this section helpful?