Admin Sales: RMA

Create an RMA custom field

options is required for select/multiselect/checkbox/radio types. Permission: sales.rma.custom-fields.create.

post/rma/custom-fields

Request

Base URL
http://localhost:8000/api/admin
Auth
HTTP bearer
TypeScript
https://skmtc.dev/bagisto/apis/bagisto-admin-api/docs/rma/custom-fields/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

codestring required

labelstring required

is_required0 | 1

positioninteger

input_validationstring

status0 | 1

Example request

{
  "code": "preferred_resolution",
  "label": "Preferred resolution",
  "type": "select",
  "is_required": 1,
  "position": 1,
  "status": 1,
  "options": [
    {
      "name": "Refund",
      "value": "refund"
    },
    {
      "name": "Replacement",
      "value": "replacement"
    }
  ]
}

Response

The created RMA custom field.

Changes

No recorded changes to this operation across all 8 revisions of this API.