Attribute

INFO

Every response arrives in the shared envelope — code, message, messages, status_code, time — with the payload in data. The tables below describe what is inside data.

POST /attribute/create

This method allows adding attribute into the account.

Request body

Field	Type	Required	Description
name	string	Yes
is_active	boolean	Yes	Default: true
items	string[]	Yes

{
  "name": "string",
  "is_active": true,
  "items": [
    "string"
  ]
}

Response

Field	Type	Description
_id	string
name	string
is_active	boolean
items	object[]
items[]._id	string
items[].name	string
items[].attribute_id	string

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "_id": "string",
    "name": "string",
    "is_active": false,
    "items": [
      {
        "_id": "string",
        "name": "string",
        "attribute_id": "string"
      }
    ]
  },
  "time": "2025-05-01T12:00:00Z"
}

PUT /attribute/update

This method allows updating attribute in the account.

Request body

Field	Type	Required	Description
_id	string	No
name	string	No
is_active	boolean	No	Default: true
items	string[]	No

{
  "_id": "63f8b0c4e4b0d3a2f8e4b0c4",
  "name": "string",
  "is_active": true,
  "items": [
    "string"
  ]
}

Response

Same response shape as POST /attribute/create.

GET /attribute/get-all

Get all attributes

Query parameters

Parameter	Type	Required	Description
is_active	boolean	No
search	string	No

Request body

No request body.

Response

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": [
    {
      "_id": "string",
      "name": "string",
      "is_active": false,
      "items": [
        {
          "_id": null,
          "name": null,
          "attribute_id": null
        }
      ]
    }
  ],
  "time": "2025-05-01T12:00:00Z"
}

GET /attribute/get-by-id/{id}

Get attribute using its _id

Path parameters

Parameter	Type	Required	Description
id	string	Yes

Request body

No request body.

Response

Same response shape as POST /attribute/create.

POST /attribute/get-paging

Get attributes by paging

Request body

Field	Type	Required	Description
page	number	Yes	Default: 1
limit	number	Yes	Default: 20
search	string	No
is_active	boolean	No

{
  "page": 1,
  "limit": 20,
  "search": "string",
  "is_active": false
}

Response

data.total is the total number of records and data.data[] holds the current page. The table below describes one record.

Field	Type	Description
_id	string
name	string
is_active	boolean
items	object[]
items[]._id	string
items[].name	string
items[].attribute_id	string

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "total": 0,
    "data": [
      {
        "_id": "string",
        "name": "string",
        "is_active": false,
        "items": [
          {
            "_id": "string",
            "name": "string",
            "attribute_id": "string"
          }
        ]
      }
    ]
  },
  "time": "2025-05-01T12:00:00Z"
}

---

This page is generated from the OpenAPI spec.