Aller au contenu principal

getAttributes

Récupérer tous les objets d'ensemble d'attributs

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

const value = await AttributesSets.getAttributes()
Schéma

langCode: string
code de langue
exemple : en_US

offset: number
paramètre d'offset pour la sélection des enregistrements, par défaut - 0
exemple : 0

limit: number
paramètre limitant la sélection des enregistrements, par défaut - 30
exemple : 30

typeId: any
identifiant du type d'ensemble d'attributs
exemple : null

sortBy: string
clé de tri
exemple : id

Cette méthode retourne tous les objets d'ensembles d'attributs et le total.

Exemple de retour :

{
"total": 100,
"items": [
{
"id": 1764,
"updatedDate": "2025-01-31T21:53:39.276Z",
"version": 10,
"identifier": "my_id",
"title": "Ensemble pour les 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
}
]
}
Schéma

total: number
Nombre total d'enregistrements trouvés
exemple : 100

items: Array
**

id: number
Identifiant de l'objet
exemple : 1764

updatedDate: string($date-time)
Date de modification de l'objet
exemple : ''

version: number
Numéro de version de modification de l'objet
exemple : 10

identifier: string
Identifiant textuel pour le champ d'enregistrement
exemple : 'my-id'

title: string
Nom de l'ensemble d'attributs
exemple : Ensemble pour les pages

schema: Record<string, string>
Description JSON du schéma (attributs utilisés par l'ensemble) de l'ensemble d'attributs
exemple :

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

title: string
Nom de l'ensemble d'attributs
exemple : Ensemble pour les pages

isVisible: boolean
Indicateur de visibilité de l'ensemble

type: object
Objet de type d'ensemble

position: number
Numéro de position
exemple : 1