Create Return (GraphQL)

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.

Input

Field	Type	Required	Description
orderId	Int	yes	The order to open the return against.
orderItemId	Int	yes	The order item being returned/canceled.
rmaQty	Int	yes	Quantity to return. Capped server-side by the item's returnable/cancelable quantity.
resolutionType	String	yes	return or cancel_items.
rmaReasonId	Int	yes	A reason id valid for the chosen resolutionType.
information	String	no	Free-text note.
packageCondition	String	no	Condition of the package (e.g. opened).

Attaching proof images is REST-only (multipart) — not available over GraphQL.

TIP

See the Returns overview for the status workflow.

Permission: sales.rma.requests.create.

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