Aller au contenu principal

getAttributesByMarker

Obtenir tous les attributs avec des données de l'ensemble d'attributs.

Description​

Cette méthode renvoie tous les attributs avec des données de l'ensemble d'attributs. Elle renvoie une promesse qui se résout en un tableau d'objets IAttributeSetsEntity.

AttributesSets.getAttributesByMarker(

marker*, langCode

);

Schéma des paramètres​

Schéma

marker(obligatoire) : string
Marqueur d'attribut
exemple : "productAttributes"

langCode : string
Code de langue. Par défaut : "en_US"
exemple : "en_US"

Exemples​

Exemple minimal​

const response = await AttributesSets.getAttributesByMarker('my-marker');

Exemple avec attributs​

const response = await AttributesSets.getAttributesByMarker('my-marker', 'en_US');

Exemple de réponse​

[
  {
    "type": "string",
    "value": {},
    "marker": "admin-text",
    "position": 1,
    "listTitles": [],
    "validators": {},
    "initialValue": null,
    "localizeInfos": {
      "title": "Admins text"
    },
    "additionalFields": {}
  }
]

Schéma de réponse​

Schéma : IAttributeSetsEntity[]

id : number
L'identifiant unique de l'entité de l'ensemble d'attributs.
exemple : 123

createdDate : string
La date à laquelle l'ensemble d'attributs a été créé.
exemple : "2023-10-01T12:00:00Z"

updatedDate : string
La date à laquelle l'ensemble d'attributs a été mis à jour pour la dernière fois.
exemple : "2023-10-01T12:00:00Z"

version : number
Le numéro de version de l'ensemble d'attributs, utilisé pour suivre les modifications ou mises à jour.
exemple : 1

identifier : string
Une chaîne qui identifie de manière unique l'ensemble d'attributs.
exemple : "attributeSet1"

typeId : number
L'identifiant numérique représentant le type de l'ensemble d'attributs.
exemple : 1

title : string
Le titre ou le nom de l'ensemble d'attributs.
exemple : "Attributs de produit"

schema : Record<string, IAttributeSchemaItem>
Champs de schéma indexés par marqueur.
exemple :

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

isVisible : boolean
Indique si l'ensemble d'attributs est visible ou non.
exemple : true

properties : Record<string, unknown>
Propriétés supplémentaires associées à l'ensemble d'attributs ; objet vide lorsqu'il n'y en a pas.
exemple :

{
  "color": "red",
  "size": "M"
}

type : string
Le type de l'ensemble d'attributs, qui pourrait être une classification ou une catégorie spécifique.
exemple : "produit", "utilisateur", "etc"

position : number
Le numéro de position pour trier l'ensemble d'attributs.
exemple : 1