getPageByUrl

Obtendo um único objeto de página com informações sobre formulários, blocos e menus anexados à página por URL

Pages.getPageByUrl(url, langCode)

const value = await Pages.getPageByUrl('shop');

Esquema

url:* string
URL da página
exemplo: shop

langCode: string
código do idioma
exemplo: en_US

Este método recupera um único objeto de página com base em sua URL (url) da API. Ele retorna uma Promise que se resolve no objeto da página, com o objeto específico dependendo do tipo de página que está sendo retornada.

Exemplo de retorno:

{
  "id": 3,
  "parentId": 1,
  "pageUrl": "blog1",
  "depth": 1,
  "localizeInfos": {
    "title": "Blog 1",
    "menuTitle": "Blog 1",
    "htmlContent": "",
    "plainContent": ""
  },
  "isVisible": true,
  "forms": [],
  "blocks": [],
  "type": "forUsualPage",
  "templateIdentifier": null,
  "attributeValues": {},
  "isSync": false
}

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

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 principal da página levando em consideração o idioma "en_US" (por exemplo)
exemplo:

{
  "en_US": {
    "title": "Catalog",
    "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

position: number
número da posição (para ordenação)
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 ]

templateIdentifier: string
identificador personalizado do template associado
exemplo: my-template

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

products number
número de produtos associados à página
exemplo: 0