Skip to content

List Returns (GraphQL)

Returns the paginated RMA (return request) queue. Detail-only fields — item, images, availableStatuses, information, packageCondition, canReopen, messagesCount — are null on the listing rows; fetch them with View Return.

The item, images, and availableStatuses fields are JSON values — select them bare (no sub-selection).

Arguments

All arguments are optional and combine in a single query — filter, sort and paginate together.

Pagination

ArgumentDescription
firstNumber of records to return.
afterCursor to fetch the page after (from pageInfo.endCursor).

Filters

Each filter narrows the result; supplying more than one combines with logical AND.

ArgumentTypeMatch
idIntExact return id.
order_idIntExact order id.
statusStringStatus title (e.g. Pending, Accept, Declined).
customer_nameStringPartial customer name.

Sorting

ArgumentTypeValues
sortStringid (default), order_id, created_at
orderStringasc, desc (default desc)

TIP

See the Returns overview for the status workflow and action semantics.

Permission: sales.rma.requests.

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

Released under the MIT License.