Menu

Returns API Routes

Customers can request to return items in their order. The admin user then receives and handles the return.

These API routes allows customers to create a return.

POST /store/returns#

Create Return

Create a return for an order's items. The admin receives the return and process it from their side. This API route doesn't require customer authentication, so that guest customers can request a return for their orders. To restrict access to this API route, refer to the Restrict Return Creation guide.

Authentication: none.

Header parameters

x-publishable-api-keystring
Publishable API Key created in the Medusa Admin.
x-medusa-localestringOptional
The locale in BCP 47 format to retrieve localized content.
Example: en-US

Query parameters

localestringOptional
The locale in BCP 47 format to retrieve localized content.
Example: en-US

Request body (application/json)

order_idstring
The ID of the order this return is created for.
itemsobject[]
The return's items.
return_shippingobject
The return's shipping details.
notestringOptional
A note with more details about the return.
receive_nowbooleanOptional
Whether to mark the return as received.
location_idstringOptional
The ID of the location that items are returned to.

Request examples

Responses

200 OK

returnobject
The return's details.

400, 401, 404, 409, 422, 500: an error response is returned.

Emitted events

  • order.return_requested: Emitted when a return request is confirmed.
  • order.return_received: Emitted when a return is marked as received.
Found a problem with this page?Report Issue
Edited Nov 14·Edit this page