getFilterByMarker

Obtenez un filtre par son marqueur (arbre d'éléments).

Description

Cette méthode récupère un filtre de contenu unique par son marqueur, localisé dans la langue demandée. Elle renvoie une Promesse qui se résout en un objet IContentFilter contenant les informations localisées du filtre et son arbre d'éléments.

Filtres.getFilterByMarker(

marker*, langCode

);

Schéma des paramètres

Schéma

marker(obligatoire): string
Marqueur du filtre
exemple : "main"

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

Exemples

Exemple minimal

const response = await Filters.getFilterByMarker('main');

Exemple avec des attributs

const response = await Filters.getFilterByMarker('main', 'en_US');

Exemple de réponse

{
  "localizeInfos": {
    "title": "Main filter"
  },
  "items": [
    {
      "type": "page",
      "marker": null,
      "url": "about",
      "localizeInfos": {
        "title": "About"
      },
      "value": null,
      "position": 1,
      "children": []
    },
    {
      "type": "attribute",
      "marker": "color",
      "url": null,
      "localizeInfos": {
        "title": "Color"
      },
      "value": null,
      "position": 2,
      "children": [
        {
          "type": "custom",
          "marker": "color_red",
          "url": null,
          "localizeInfos": {
            "title": "Red"
          },
          "value": "red",
          "position": 1,
          "children": []
        }
      ]
    }
  ]
}

Schéma de réponse

Schéma : IContentFilter

localizeInfos: ILocalizeInfo
Informations localisées du filtre dans la locale demandée.
exemple : { "title": "Filtre principal" }

items: IContentFilterItem[]
Arbre des éléments du filtre (éléments réguliers + éléments personnalisés dans un seul tableau).

items.type: TContentFilterItemType
Type de nœud d'arbre. Un des : "page", "produit", "admin", "attribut", "remise", "remise-personnelle", "bonus", "méthode-de-paiement", "personnalisé".
exemple : "page"

items.marker: string | null
Marqueur de l'entité liée, ou null pour type=page.
exemple : "about"

items.url: string | null
URL de la page (uniquement pour type=page ; null sinon).
exemple : "about"

items.localizeInfos: ILocalizeInfo
Informations localisées de l'entité liée dans la locale demandée.
exemple : { "title": "À propos" }

items.value: string | null
Valeur de nœud unifiée (par exemple, valeur de remise, titre d'attribut) ; null sinon.
exemple : "10"

items.position: number
Position numérique (par niveau).
exemple : 1

items.children: IContentFilterItem[]
Nœuds d'arbre imbriqués (éléments réguliers et personnalisés dans un seul tableau).

---