getChildPagesByParentUrl
Получение дочерних страниц с информацией о продукте по URL родительской страницы в виде массива.
Описание
Возвращает все созданные страницы в виде массива объектов или пустой массив [] (если данных нет) для выбранного родителя. Возвращает Promise, который разрешается в массив объектов IPagesEntity.
Pages.getChildPagesByParentUrl(
url,
langCode
);
Схема параметров
Схема
url(обязательно): string
URL родительской страницы, для которой необходимо получить дочерние страницы
пример: "about/our-team"
langCode: string
Код языка. По умолчанию: "en_US"
пример: "en_US"
Примеры
Минимальный пример
const response = await Pages.getChildPagesByParentUrl('shop');
Пример с атрибутами
const response = await Pages.getChildPagesByParentUrl('shop', 'en_US');
Пример ответа
[
{
"id": 9,
"config": {},
"depth": 1,
"parentId": 8,
"pageUrl": "blog1",
"attributeSetIdentifier": null,
"localizeInfos": {
"title": "Блог 1",
"menuTitle": "Блог 1",
"htmlContent": "",
"plainContent": ""
},
"position": 1,
"isVisible": true,
"products": 0,
"childrenCount": 0,
"type": "common_page",
"templateIdentifier": null,
"isSync": false,
"attributeValues": {}
}
]
Схема ответа
Схема: IPagesEntity
id: number
Идентификатор объекта.
пример: 8
parentId: number | null
Идентификатор родительской страницы, если содержит null, то это страница верхнего уровня.
пример: 10
pageUrl: string
Уникальный URL страницы.
пример: "blog"
depth: number
Глубина вложенности страницы относительно parentId.
пример: 10
localizeInfos: ILocalizeInfo
Название страницы с учетом локализации.
пример:
{
"title": "Блог",
"menuTitle": "Блог",
"htmlContent": "",
"plainContent": ""
}
isVisible: boolean
Признак видимости страницы.
пример: true
type: Types
Тип страницы.
пример:
"common_page"
templateIdentifier: string | null
Идентификатор связанного шаблона.
пример: "template"
attributeSetIdentifier: string | null
Идентификатор набора атрибутов.
пример: "page"
attributeValues: AttributeType
Массив значений атрибутов из индекса (представленный в виде пары идентификатор пользовательского атрибута: значение атрибута).
пример:
{
"text": {
"type": "string",
"value": "некоторый текст",
"position": 0,
"additionalFields": []
}
}
isSync: boolean
Указание на индексацию страницы.
пример: true
template: any
Объект шаблона.
position: number
Номер элемента (для сортировки).
пример: 2
config: any
Настройки вывода для страниц каталога.
пример:
{
"rowsPerPage": 1,
"productsPerRow": 1
}
products: number
Количество продуктов, связанных со страницей.
пример: 0
childrenCount: number
Количество дочерних элементов.
пример: 1