getPages

Obtenir tous les objets de page avec des informations sur les produits sous forme de tableau

Pages.getPages(langCode)

const value = await Pages.getPages();

Schéma

langCode: chaîne
code de langue
exemple : en_US

Cette méthode récupère toutes les pages créées sous forme de tableau depuis l'API. Elle renvoie une promesse qui se résout en un tableau d'objets ou en un tableau vide [] s'il n'y a pas de données.

Exemple de retour :

[
  {
    "id": 2,
    "config": {},
    "depth": 0,
    "parentId": null,
    "pageUrl": "catalog",
    "attributeSetIdentifier": "page",
    "localizeInfos": {
      "title": "Catalogue",
      "menuTitle": "Catalogue",
      "htmlContent": "",
      "plainContent": ""
    },
    "position": 3,
    "isVisible": true,
    "products": 3,
    "childrenCount": 0,
    "type": "forCatalogPages",
    "templateIdentifier": "template",
    "isSync": true,
    "attributeValues": {
      "text": {
        "type": "string",
        "value": "texte du catalogue",
        "position": 0
      }
    }
  }
]

Schéma

id: nombre
identifiant de l'objet
exemple : 1764

parentId nombre
identifiant de la page parente, si null, c'est une page de niveau supérieur
exemple : null

config Record<string, number>
paramètres de sortie pour les pages de catalogue
exemple :

{
  "rowsPerPage": 1,
  "productsPerRow": 1
}

pageUrl chaîne
URL unique de la page

depth nombre
profondeur de la page par rapport à parentId
exemple : 3

localizeInfos: Record<string, any>
description json de l'objet de données principal de la page en tenant compte de la langue "en_US" (par exemple)
exemple :

{
  "en_US": {
    "title": "Catalogue",
    "plainContent": "Contenu pour le catalogue",
    "htmlContent": "<b>Contenu pour le catalogue</b>",
    "menuTitle": "Catalogue"
  }
}

isVisible: booléen
Indicateur de visibilité de la page
exemple : true

products nombre
Nombre de produits liés à la page
exemple : 0

attributeSetId: nombre
identifiant de l'ensemble d'attributs
exemple : 7

forms
Tableau des valeurs d'identifiant d'objet FormEntity liées à la page (optionnel)

blocks
Tableau des valeurs d'identifiant d'objet BlockEntity liées à la page (optionnel)

isSync: booléen
indicateur d'indexation de la page (true ou false)
exemple : false

templateIdentifier: chaîne
Identifiant personnalisé du modèle lié
exemple : my-template

attributeValues: Record<string, string>
Tableau des valeurs d'attributs de l'index (présenté sous forme de paire d'identifiant d'attribut personnalisé : valeur d'attribut)
exemple :

{
  "en_US": {
    "marker": {
      "value": "",
      "type": "string"
    }
  }
}

position: nombre
numéro de position pour le tri (optionnel)
exemple : 192

type: chaîne
Type de page
exemple : forNewsPage
Enum : [ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]

childrenCount: nombre
nombre de pages imbriquées
exemple : 0