getChildPagesByParentUrl

Получение дочерних страниц с информацией о продуктах в виде массива

Pages.getChildPagesByParentUrl(url, langCode)

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

Схема

url:* строка
URL родительской страницы
пример: shop

langCode: строка
Обязательный параметр кода языка
пример: en_US

Получение дочерних страниц с информацией о продуктах в виде массива. Возвращает все созданные страницы в виде массива объектов или пустой массив [] (если данных нет) для выбранного родителя.

Пример возвращаемого значения:

[
  {
    "id": 3,
    "config": {},
    "depth": 1,
    "parentId": 1,
    "pageUrl": "blog1",
    "attributeSetIdentifier": null,
    "localizeInfos": {
      "title": "Блог 1",
      "menuTitle": "Блог 1",
      "htmlContent": "",
      "plainContent": ""
    },
    "position": 1,
    "isVisible": true,
    "products": 0,
    "childrenCount": 0,
    "type": "forUsualPage",
    "templateIdentifier": null,
    "isSync": false,
    "attributeValues": {}
  }
]

Схема

id: число
идентификатор объекта
пример: 1764

parentId число
идентификатор родительской страницы, если null, это страница верхнего уровня
пример: null

config Record<string, number>
настройки вывода для страниц каталога
пример:

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

pageUrl строка
уникальный URL страницы

depth число
глубина вложенности страницы относительно parentId
пример: 3

localizeInfos: Record<string, any>
json-описание основного объекта данных страницы с учетом языка "en_US" (например)
пример:

{
  "en_US": {
    "title": "Каталог",
    "plainContent": "Содержимое для каталога",
    "htmlContent": "<b>Содержимое для каталога</b>",
    "menuTitle": "Каталог"
  }
}

isVisible: булево
Флаг видимости страницы
пример: true

products число
Количество продуктов, связанных со страницей
пример: 0

attributeSetId: число
идентификатор набора атрибутов
пример: 7

forms
Массив значений идентификаторов объектов FormEntity, связанных со страницей (необязательно)

blocks
Массив значений идентификаторов объектов BlockEntity, связанных со страницей (необязательно)

isSync: булево
индикатор индексации страницы (true или false)
пример: false

templateIdentifier: строка
Пользовательский идентификатор связанного шаблона
пример: my-template

attributeValues: Record<string, string>
Массив значений атрибутов из индекса (представленный в виде пары пользовательский идентификатор атрибута: значение атрибута)
пример:

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

position: число
номер позиции для сортировки (необязательно)
пример: 192

type: строка
Тип страницы
пример: forNewsPage
Enum: [ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]

childrenCount: число
количество вложенных страниц
пример: 0