on GitHub" data-tooltip-id=":R1blcldb:">v2.5.1·Edited Oct 9·
In this document, you’ll learn about order returns.
A return is the return of items delivered from the customer back to the merchant. It is represented by the Return data model.
A return is requested either by the customer from the storefront, or the merchant from the admin. Medusa supports an automated Return Merchandise Authorization (RMA) flow.
Once the merchant receives the returned items, they mark the return as received.
The items to be returned are represented by the ReturnItem data model.
The ReturnItem
model has two properties storing the item's quantity:
received_quantity
: The quantity of the item that's received and can be added to the item's inventory quantity.damaged_quantity
: The quantity of the item that's damaged, meaning it can't be sold again or added to the item's inventory quantity.A return has shipping methods used to return the items to the merchant. The shipping methods are represented by the OrderShippingMethod data model.
In the Medusa application, the shipping method for a return is created only from a shipping option, provided by the Fulfillment Module, that has the rule is_return
enabled.
The refund_amount
property of the Return
data model holds the amount a merchant must refund the customer.
The OrderTransaction data model represents the refunds made for the return.
When a merchant creates an exchange or a claim, it includes returning items from the customer.
The Return
data model also represents the return of these items. In this case, the return is associated with the exchange or claim it was created for.
The order’s version is incremented when: