getChildPagesByParentUrl

Récupération des pages enfants avec des informations sur les produits par l'URL de la page parente sous forme de tableau.

Description

Renvoie toutes les pages créées sous forme de tableau d'objets ou un tableau vide [] (s'il n'y a pas de données) pour le parent sélectionné. Cela renvoie une promesse qui se résout en un tableau d'objets IPagesEntity.

Pages.getChildPagesByParentUrl(

url*, langCode

);

Schéma des paramètres

Schéma

url(obligatoire): string
L'URL de la page parente pour laquelle les pages enfants doivent être récupérées
exemple : "about/our-team"

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

Exemples

Exemple minimal

const response = await Pages.getChildPagesByParentUrl('shop');

Exemple avec des attributs

const response = await Pages.getChildPagesByParentUrl('shop', 'en_US');

Exemple de réponse

[
  {
    "id": 9,
    "config": {},
    "depth": 1,
    "parentId": 8,
    "pageUrl": "blog1",
    "attributeSetIdentifier": null,
    "total": "1",
    "localizeInfos": {
      "title": "Blog 1",
      "menuTitle": "Blog 1",
      "htmlContent": "",
      "plainContent": ""
    },
    "isVisible": true,
    "products": 0,
    "childrenCount": "0",
    "type": "common_page",
    "position": 1,
    "templateIdentifier": null,
    "isSync": false,
    "categoryPath": "blog/blog1",
    "attributeValues": {},
    "moduleFormConfigs": []
  }
]

Schéma de réponse

Schéma : IPagesEntity

id: number
L'identifiant de l'objet.
exemple : 8

parentId: number | null
L'id de la page parente, s'il contient null, alors c'est la page de niveau supérieur.
exemple : 10

pageUrl: string
URL unique de la page.
exemple : "blog"

depth: number
Profondeur d'imbrication de la page par rapport à parentId.
exemple : 10

localizeInfos: ILocalizeInfo
Le nom de la page, en tenant compte de la localisation.
exemple :

{
  "title": "Blog",
  "menuTitle": "Blog",
  "htmlContent": "",
  "plainContent": ""
}

isVisible: boolean
Un indicateur de visibilité de la page.
exemple : true

type: Types
Type de page.
exemple : "common_page"

templateIdentifier: string | null
Identifiant utilisateur du modèle lié.
exemple : "template"

attributeSetIdentifier: string | null
Identifiant de l'ensemble d'attributs.
exemple : "page"

attributeValues: AttributeType
Tableau des valeurs d'attributs de l'index (représenté comme une paire d'id d'attribut utilisateur : valeur d'attribut).
exemple :

{
  "text": {
    "type": "string",
    "value": "some text",
    "position": 0,
    "additionalFields": []
  }
}

isSync: boolean
Indication de l'indexation de la page.
exemple : true

template: object
Objet modèle.
exemple :

position: number
Numéro de l'élément (pour le tri).
exemple : 2

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

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

products: number
Le nombre de produits liés à la page.
exemple : 0

childrenCount: string
Nombre d'enfants.
exemple : 1

blocks: IBlockEntity[] | string[]
blocs.
exemple :

{
  "id": 4,
  "attributeSetIdentifier": null,
  "title": "Template",
  "generalTypeId": 4,
  "identifier": "template",
  "version": 0,
  "generalTypeName": "catalog_page",
  "attributeValues": {},
  "position": 1
}

moduleFormConfigs: Array<IFormConfig>
Configurations de formulaire de module liées à la page.

total: string
Nombre total de produits liés à la page.
exemple : "10"

categoryPath: string
Chaîne de chemin de catégorie.
exemple : "catalog"

---