Saltar al contenido principal

getPages

Obteniendo todos los objetos de página con información del producto como un array

Pages.getPages(langCode)

const value = await Pages.getPages();
Esquema

langCode: string
código de idioma
ejemplo: en_US

Este método recupera todas las páginas creadas como un array desde la API. Devuelve una Promesa que se resuelve en un array de objetos o un array vacío [] si no hay datos.

Ejemplo de retorno:

[
{
"id": 2,
"config": {},
"depth": 0,
"parentId": null,
"pageUrl": "catalog",
"attributeSetIdentifier": "page",
"localizeInfos": {
"title": "Catálogo",
"menuTitle": "Catálogo",
"htmlContent": "",
"plainContent": ""
},
"position": 3,
"isVisible": true,
"products": 3,
"childrenCount": 0,
"type": "forCatalogPages",
"templateIdentifier": "template",
"isSync": true,
"attributeValues": {
"text": {
"type": "string",
"value": "texto del catálogo",
"position": 0
}
}
}
]
Esquema

id: number
identificador del objeto
ejemplo: 1764

parentId number
identificador de la página padre, si es nulo, es una página de nivel superior
ejemplo: null

config Record<string, number>
configuraciones de salida para páginas de catálogo
ejemplo:

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

pageUrl string
URL única de la página

depth number
profundidad de anidación de la página en relación con parentId
ejemplo: 3

localizeInfos: Record<string, any>
descripción json del objeto de datos principal de la página teniendo en cuenta el idioma "en_US" (por ejemplo)
ejemplo:

{
"en_US": {
"title": "Catálogo",
"plainContent": "Contenido para el catálogo",
"htmlContent": "<b>Contenido para el catálogo</b>",
"menuTitle": "Catálogo"
}
}

isVisible: boolean
Indicador de visibilidad de la página
ejemplo: true

products number
Número de productos vinculados a la página
ejemplo: 0

attributeSetId: number
identificador del conjunto de atributos
ejemplo: 7

forms
Array de valores de identificador de objeto FormEntity vinculados a la página (opcional)

blocks
Array de valores de identificador de objeto BlockEntity vinculados a la página (opcional)

isSync: boolean
indicador de indexación de la página (true o false)
ejemplo: false

templateIdentifier: string
Identificador personalizado de la plantilla vinculada
ejemplo: my-template

attributeValues: Record<string, string>
Array de valores de atributos del índice (presentados como un par de identificador de atributo personalizado: valor de atributo)
ejemplo:

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

position: number
número de posición para ordenar (opcional)
ejemplo: 192

type: string
Tipo de página
ejemplo: forNewsPage
Enum: [ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]

childrenCount: number
número de páginas anidadas
ejemplo: 0