Skip to content

List RMA statuses

Returns the store's return statuses. Default statuses cannot be deleted. Rows come back in the standard { data, meta } envelope.

Endpoint

GET /api/admin/rma/statuses

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=Awaiting
statusExact — 1 active, 0 inactive.?status=1

Sorting

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

Fields

FieldMeaning
titleThe status label.
status1 active, 0 inactive.
colorHex color of the status badge (e.g. #FDB022).
default1 for a built-in system status (cannot be deleted), 0 for a custom one.
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.