getPages
Obtendo todos os objetos de página com informações do produto como um array.
Descrição
Este método recupera todas as páginas criadas como um array da API. Ele retorna uma Promise que resolve para um array de objetos IPagesEntity.
Páginas.getPages(
langCode);
Esquema de parâmetros
Esquema
langCode: string
Código do idioma. Padrão: "en_US"
exemplo: "en_US"
Exemplos
Exemplo mínimo
const response = await Pages.getPages();
Exemplo com atributos
const response = await Pages.getPages('en_US');
Exemplo de resposta
[
{
"id": 9,
"config": {},
"depth": 1,
"parentId": 8,
"pageUrl": "blog1",
"attributeSetIdentifier": null,
"localizeInfos": {
"title": "Blog 1",
"htmlContent": "",
"plainContent": "",
"menuTitle": "Blog 1"
},
"isVisible": true,
"products": 0,
"childrenCount": 0,
"type": "common_page",
"position": 1,
"templateIdentifier": null,
"isSync": false,
"categoryPath": "blog/blog1",
"rating": {},
"attributeValues": {},
"moduleFormConfigs": []
},
{
"id": 8,
"config": {},
"depth": 0,
"parentId": null,
"pageUrl": "blog",
"attributeSetIdentifier": "page",
"localizeInfos": {
"title": "Blog",
"htmlContent": "",
"plainContent": "",
"menuTitle": "Blog"
},
"isVisible": true,
"products": 0,
"childrenCount": 2,
"type": "common_page",
"position": 2,
"templateIdentifier": "template",
"isSync": true,
"categoryPath": "blog",
"rating": {},
"attributeValues": {
"text": {
"type": "string",
"value": "some text",
"isIcon": false,
"position": 0,
"additionalFields": {},
"isProductPreview": false
},
"number": {
"type": "integer",
"value": 5,
"isIcon": false,
"position": 1,
"additionalFields": {},
"isProductPreview": false
},
"real": {
"type": "real",
"value": "10",
"isIcon": false,
"position": 2,
"additionalFields": {},
"isProductPreview": false
},
"float": {
"type": "float",
"value": 12,
"isIcon": false,
"position": 3,
"additionalFields": {},
"isProductPreview": false
}
},
"moduleFormConfigs": [
{
"id": 9,
"formIdentifier": "full_form",
"moduleIdentifier": "content",
"isGlobal": false,
"isClosed": false,
"isModerate": true,
"viewOnlyMyData": false,
"commentOnlyMyData": false,
"entityIdentifiers": [
{
"id": "blog",
"isNested": false
}
],
"formDataCount": 4827,
"ratingCalculation": "average",
"allowHalfRatings": null,
"maxRatingScale": null,
"isAnonymous": null,
"allowRerating": null,
"isRating": null,
"entityFormDataCount": {
"blog": 4827
},
"nestedEntityIdentifiers": [],
"exceptionIds": []
},
{
"id": 3,
"formIdentifier": "file_form",
"moduleIdentifier": "content",
"isGlobal": false,
"isClosed": false,
"isModerate": false,
"viewOnlyMyData": false,
"commentOnlyMyData": false,
"entityIdentifiers": [
{
"id": "blog",
"isNested": false
}
],
"formDataCount": 556,
"ratingCalculation": "average",
"allowHalfRatings": null,
"maxRatingScale": null,
"isAnonymous": null,
"allowRerating": null,
"isRating": null,
"entityFormDataCount": {
"blog": 556
},
"nestedEntityIdentifiers": [],
"exceptionIds": []
},
{
"id": 2,
"formIdentifier": "test-form",
"moduleIdentifier": "content",
"isGlobal": false,
"isClosed": false,
"isModerate": false,
"viewOnlyMyData": false,
"commentOnlyMyData": false,
"entityIdentifiers": [
{
"id": "blog",
"isNested": false
}
],
"formDataCount": 775,
"ratingCalculation": "average",
"allowHalfRatings": null,
"maxRatingScale": null,
"isAnonymous": null,
"allowRerating": null,
"isRating": null,
"entityFormDataCount": {
"blog": 775
},
"nestedEntityIdentifiers": [],
"exceptionIds": []
}
],
"template": {
"id": 4,
"attributeSetIdentifier": null,
"title": "Template",
"generalTypeId": 4,
"identifier": "template",
"version": 0,
"generalTypeName": "catalog_page",
"attributeValues": {},
"position": 1
}
},
{
"id": 49,
"config": {},
"depth": 1,
"parentId": 8,
"pageUrl": "blog2",
"attributeSetIdentifier": null,
"localizeInfos": {
"title": "Blog 2",
"htmlContent": "",
"plainContent": "",
"menuTitle": "Blog 2"
},
"isVisible": true,
"products": 0,
"childrenCount": 0,
"type": "common_page",
"position": 3,
"templateIdentifier": null,
"isSync": false,
"categoryPath": "blog2",
"rating": {},
"attributeValues": {},
"moduleFormConfigs": []
},
"..."
]
Esquema de resposta
Esquema: IPagesEntity[]
id: number
O identificador do objeto.
exemplo: 8
parentId: number | null
O id da página pai, se contiver null, então é a página de nível superior.
exemplo: 10
pageUrl: string
URL única da página.
exemplo: "blog"
depth: number
Profundidade de aninhamento da página em relação ao parentId.
exemplo: 10
localizeInfos: ILocalizeInfo
O nome da página, levando em consideração a localização.
exemplo:
{
"title": "Blog",
"menuTitle": "Blog",
"htmlContent": "",
"plainContent": ""
}
isVisible: boolean
Um sinal de visibilidade da página.
exemplo: true
type: PageType
Tipo de página.
exemplo: "common_page"
templateIdentifier: string | null
Id do usuário do template vinculado.
exemplo: "template"
attributeSetIdentifier: string | null
Id do conjunto de atributos.
exemplo: "page"
attributeValues: IAttributeValues
Mapa de valores de atributos indexados por marcador; objeto vazio quando nenhum.
exemplo:
{
"text": {
"type": "string",
"value": "some text",
"position": 0,
"additionalFields": []
}
}
isSync: boolean
Indicação de indexação da página.
exemplo: true
template: object
Objeto template.
exemplo:
{}
position: number
Número do item (para ordenação).
exemplo: 2
config: Record<string, number>
Configurações de saída para páginas de catálogo.
exemplo:
{
"rowsPerPage": 1,
"productsPerRow": 1
}
products: number
O número de produtos vinculados à página.
exemplo: 0
childrenCount: number
Contagem de filhos.
exemplo: 1
blocks: IBlockEntity[] | string[]
blocos.
exemplo:
{
"id": 4,
"attributeSetIdentifier": null,
"title": "Template",
"generalTypeId": 4,
"identifier": "template",
"version": 0,
"generalTypeName": "catalog_page",
"attributeValues": {},
"position": 1
}
blocks.attributeValues: IAttributeValues
Mapa de valores de atributos indexados por marcador; objeto vazio quando nenhum.
exemplo:
{
"block-text": {
"type": "string",
"value": "some text",
"isIcon": false,
"position": 0,
"additionalFields": [],
"isProductPreview": false
}
}
blocks.id: number
Identificador único do bloco.
exemplo: 1234
blocks.localizeInfos: ILocalizeInfo
Informações de localização para o bloco.
exemplo:
{
"key": "value"
}
blocks.version: number
Versão da entidade do bloco.
exemplo: 1
blocks.identifier: string
Identificador de string único para o bloco.
exemplo: "block1"
blocks.type: BlockType
Tipo do bloco.
exemplo: "product"
blocks.position: number
Posição do bloco para ordenação.
exemplo: 1
blocks.templateIdentifier: string | null
Identificador para o template usado pelo bloco, ou null se não aplicável.
exemplo: "template1"
blocks.isVisible: boolean
Indica se o bloco é visível.
exemplo: true
blocks.countElementsPerRow: number
Número de elementos exibidos por linha no bloco, se aplicável.
exemplo: 3
blocks.quantity: number
Quantidade de itens no bloco, se aplicável.
exemplo: 5
blocks.similarProducts: IProductsResponse
Resposta contendo produtos semelhantes associados ao bloco.
exemplo:
{
"total": 10,
"items": []
}
blocks.products: IProductsEntity[]
Array de entidades de produtos associadas ao bloco.
exemplo:
[
{
"id": 1,
"name": "Product 1"
},
{
"id": 2,
"name": "Product 2"
}
]
moduleFormConfigs: Array<IFormConfig>
Configurações de formulário do módulo vinculadas à página.
rating: IRating
Dados de avaliação.
total: string
Total de produtos vinculados à página.
exemplo: "10"
categoryPath: string | null
String do caminho da categoria; null para páginas aninhadas que não têm seu próprio caminho de categoria.
exemplo: "catalog"
Exemplos de uso
Passo a passo na documentação:
- Obter todas as páginas — recuperar páginas em todas as profundidades em uma única solicitação.
Experimente ao vivo
Execute este método interativamente no sandbox do JS SDK — conecte sua URL do Projeto e Token do App na primeira visita, depois abra:
- Obter todas as páginas — recuperar páginas em todas as profundidades em uma única solicitação.