List Returnable Items (GraphQL)

Returns the items of an order that can be put on a return, each with the trusted quantity caps. Use this to build the RMA create form: the caps tell you the maximum quantity you may send as rmaQty when creating a return.

The orderId argument is required. There is no customer scope — the admin can open a return for any order.

Field notes

Field	Meaning
orderItemId	The order item to return (pass as orderItemId on create).
currentQuantity	Quantity currently on the order (not yet returned/canceled).
forReturnQuantity	Max quantity eligible for a return resolution.
forCancelQuantity	Max quantity eligible for a cancel_items resolution.
rmaQuantity	Quantity already placed on returns.
rmaReturnPeriod	The return window (in days) for this item.

TIP

See the Returns overview for how a return is created.

Permission: sales.rma.requests.

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