getRootPages

Obtendo todos os objetos de página de nível superior (parentId = null)

Pages.getRootPages(langCode)

const value = await Pages.getRootPages()

Esquema

langCode: string
código do idioma
exemplo: en_US

Este método recupera todos os objetos de página de nível superior da API. Ele retorna uma Promise que se resolve em um array de objetos de página de nível superior ou um array vazio [] se não houver dados.

Exemplo de retorno:

[
  {
    "id": 1,
    "config": {},
    "depth": 0,
    "parentId": null,
    "pageUrl": "blog",
    "attributeSetIdentifier": "page",
    "localizeInfos": {
      "title": "Blog",
      "menuTitle": "Blog",
      "htmlContent": "",
      "plainContent": ""
    },
    "position": 1,
    "isVisible": true,
    "products": 0,
    "childrenCount": 1,
    "type": "forUsualPage",
    "templateIdentifier": "template",
    "isSync": true,
    "attributeValues": {
      "text": {
        "type": "string",
        "value": "some text",
        "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 em json do objeto de dados da página principal levando em consideração o idioma "en_US" (por exemplo)
exemplo:

{
  "en_US": {
    "title": "Catalog",
    "plainContent": "Content for catalog",
    "htmlContent": "<b>Content for catalog</b>",
    "menuTitle": "Catalog"
  }
}

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

.