getAttributes

Getting all attribute set objects

AttributesSets.getAttributes(langCode, offset, limit, typeId, sortBy)

const value = await AttributesSets.getAttributes()

Schema

langCode: string
language code
example: en_US

offset: number
parameter offset of record selection, default - 0
example: 0

limit: number
parameter limiting the selection of records, default - 30
example: 30

typeId: any
identifier of the attribute set type
example: null

sortBy: string
sorting key
example: id

This method return all attribute sets objects and total.

Example return:

{
  "total": 100,
  "items": [
    {
      "id": 1764,
      "updatedDate": "2025-01-31T21:53:39.276Z",
      "version": 10,
      "identifier": "my_id",
      "title": "Set for pages",
      "schema": {
        "attribute1": {
          "id": 1,
          "type": "string",
          "isPrice": false,
          "original": true,
          "identifier": "string",
          "localizeInfos": {
            "en_US": {
              "title": "String"
            }
          }
        }
      },
      "isVisible": true,
      "type": {
        "id": 5,
        "type": "forProducts"
      },
      "position": 1
    }
  ]
}

Schema

total: number
Total number of found records
example: 100

items: Array
**

id: number
Object identifier
example: 1764

updatedDate: string($date-time)
Object modification date
example: ''

version: number
Object modification version number
example: 10

identifier: string
Text identifier for record field
example: 'my-id'

title: string
Attribute set name
example: Set for pages

schema: Record<string, string>
Schema JSON description (attributes used by the set) of the attribute set
example:

{
  "attribute1": { 
    "id": 1,
    "type": "string",
    "isPrice": false, 
    "original": true,
    "identifier": "string",
    "localizeInfos": {
      "en_US": { "title": "String" }
    }
  } 
}

title: string
Attribute set name
example: Set for pages

isVisible: boolean
Visibility flag of the set

type: object
Object of set type

position: number
Position number
example: 1

---