Skip to content

List RMA custom fields

Returns the store's return custom fields. options is populated only for select / multiselect / checkbox / radio types. Rows come back in the standard { data, meta } envelope.

Endpoint

GET /api/admin/rma/custom-fields

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
codePartial (contains).?code=resolution
labelPartial (contains).?label=Preferred
typeExact input type.?type=select
statusExact — 1 active, 0 inactive.?status=1

Sorting

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

Fields

FieldMeaning
codeUnique machine code for the field.
labelThe field label shown to the customer.
typeInput type: text, textarea, select, multiselect, checkbox, radio.
isRequired1 if the customer must fill it in, 0 otherwise.
positionSort order in the returns form.
inputValidationOptional validation rule name; null when none.
status1 active, 0 inactive.
optionsChoice list for select / multiselect / checkbox / radio types — an array of { id, name, value }. Empty/absent for text / textarea.
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.