Create Return

Opens an RMA request for an order item. Use List Returnable Items to get the eligible items and their caps, and List Return Reasons for the reason ids of the chosen resolution type.

Endpoint

Endpoint	Method
/api/admin/rma/requests	POST

Request Body

Field	Type	Required	Description
order_id	integer	yes	The order to open the return against.
order_item_id	integer	yes	The order item being returned/canceled.
rma_qty	integer	yes	Quantity to return. Capped server-side by the item's returnable/cancelable quantity.
resolution_type	string	yes	return or cancel_items.
rma_reason_id	integer	yes	A reason id valid for the chosen resolution_type.
information	string	no	Free-text note.
package_condition	string	no	Condition of the package (e.g. opened).

To attach proof images, send the request as multipart/form-data with the fields above plus one or more images[] file parts.

Permission

sales.rma.requests.create

TIP

See the Returns overview for the status workflow.

All admin endpoints require an admin Bearer token — see Authentication.