getFilterByMarker

Obtén un filtro por su marcador (árbol de elementos).

Descripción

Este método recupera un único filtro de contenido por su marcador, localizado al idioma solicitado. Devuelve una Promesa que se resuelve en un objeto IContentFilter que contiene la información localizada del filtro y su árbol de elementos.

Filters.getFilterByMarker(

marker*, langCode

);

Esquema de parámetros

Esquema

marker(requerido): string
Marcador del filtro
ejemplo: "main"

langCode: string
Código de idioma. Predeterminado: "en_US"
ejemplo: "en_US"

Ejemplos

Ejemplo mínimo

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

Ejemplo con atributos

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

Ejemplo de respuesta

{
  "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": []
        }
      ]
    }
  ]
}

Esquema de respuesta

Esquema: IContentFilter

localizeInfos: ILocalizeInfo
Información localizada del filtro en la localidad solicitada.
ejemplo: { "title": "Filtro principal" }

items: IContentFilterItem[]
Árbol de elementos del filtro (elementos regulares + elementos personalizados en un solo array).

items.type: TContentFilterItemType
Tipo de nodo del árbol. Uno de: "page", "product", "admin", "attribute", "discount", "personal-discount", "bonus", "payment-method", "custom".
ejemplo: "page"

items.marker: string | null
Marcador de la entidad vinculada, o null para type=page.
ejemplo: "about"

items.url: string | null
URL de la página (solo para type=page; null en caso contrario).
ejemplo: "about"

items.localizeInfos: ILocalizeInfo
Información localizada de la entidad vinculada en la localidad solicitada.
ejemplo: { "title": "Acerca de" }

items.value: string | null
Valor unificado del nodo (por ejemplo, valor de descuento, título del atributo); null en caso contrario.
ejemplo: "10"

items.position: number
Posición numérica (por nivel).
ejemplo: 1

items.children: IContentFilterItem[]
Nodos del árbol anidados (elementos regulares y personalizados en un solo array).

---