Skip to content

List RMA reasons

Returns the store's return reasons. Rows come back in the standard { data, meta } envelope.

Endpoint

GET /api/admin/rma/reasons

Query parameters

All parameters are optional and combine in one request — filter, sort and paginate together.

Pagination

ParameterDescription
pagePage number (1-based).
per_pageItems per page (default 10, max 50).

Filters

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

ParameterMatchExample
titlePartial (contains).?title=Damaged
statusExact — 1 active, 0 inactive.?status=1

Sorting

ParameterValues
sortid (default), position, title
orderasc, desc (default desc)

Fields

FieldMeaning
titleThe reason label shown to the customer.
status1 active, 0 inactive.
positionSort order in the returns form.
isAdmin1 if the reason was created by an admin, 0 if it is a seeded reason.
resolutionTypeThe return actions this reason allows — an array of return and/or cancel_items.
messagenull on create / update / read; populated only on the delete confirmation.

For how this menu fits the rest of the RMA settings, see the menu overview.

Released under the MIT License.