getPageByUrl

Obtenir un objet de page unique avec des informations sur les formulaires, les blocs, les menus attachés à la page par URL

Pages.getPageByUrl(url, langCode)

const value = await Pages.getPageByUrl('shop');

Schéma

url:* chaîne
URL de la page
exemple : shop

langCode: chaîne
code de langue
exemple : en_US

Cette méthode récupère un objet de page unique basé sur son URL (url) depuis l'API. Elle renvoie une promesse qui se résout en l'objet de la page, l'objet spécifique dépendant du type de page retourné.

Exemple de retour :

{
  "id": 3,
  "parentId": 1,
  "pageUrl": "blog1",
  "depth": 1,
  "localizeInfos": {
    "title": "Blog 1",
    "menuTitle": "Blog 1",
    "htmlContent": "",
    "plainContent": ""
  },
  "isVisible": true,
  "forms": [],
  "blocks": [],
  "type": "forUsualPage",
  "templateIdentifier": null,
  "attributeValues": {},
  "isSync": false
}

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

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": "Catalog",
    "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

position: nombre
numéro de position (pour le tri)
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 ]

templateIdentifier: chaîne
identifiant personnalisé du modèle associé
exemple : my-template

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

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