getPages

Obtendo todos os objetos de página com informações do produto como um array

Pages.getPages(langCode)

const value = await Pages.getPages();

Esquema

langCode: string
código do idioma
exemplo: en_US

Este método recupera todas as páginas criadas como um array da API. Ele retorna uma Promise que se resolve em um array de objetos ou um array vazio [] se não houver dados.

Exemplo 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 do catálogo",
        "position": 0
      }
    }
  }
]

Esquema

id: number
identificador do objeto
exemplo: 1764

parentId number
identificador da página pai, se nulo, é uma página de nível superior
exemplo: null

config Record<string, number>
configurações de saída para páginas de catálogo
exemplo:

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

pageUrl string
URL única da página

depth number
profundidade de aninhamento da página em relação ao parentId
exemplo: 3

localizeInfos: Record<string, any>
descrição json do objeto de dados principal da página levando em conta o idioma "en_US" (por exemplo)
exemplo:

{
  "en_US": {
    "title": "Catálogo",
    "plainContent": "Conteúdo para catálogo",
    "htmlContent": "<b>Conteúdo para catálogo</b>",
    "menuTitle": "Catálogo"
  }
}

isVisible: boolean
Flag de visibilidade da página
exemplo: true

products number
Número de produtos vinculados à página
exemplo: 0

attributeSetId: number
identificador do conjunto de atributos
exemplo: 7

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

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

isSync: boolean
indicador de indexação da página (true ou false)
exemplo: false

templateIdentifier: string
Identificador personalizado do template vinculado
exemplo: my-template

attributeValues: Record<string, string>
Array de valores de atributos do índice (apresentados como um par de identificador de atributo personalizado: valor do atributo)
exemplo:

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

position: number
número de posição para ordenação (opcional)
exemplo: 192

type: string
Tipo de página
exemplo: 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 aninhadas
exemplo: 0