getPageByUrl

Obteniendo un único objeto de página con información sobre formularios, bloques, menús adjuntos a la página por URL

Pages.getPageByUrl(url, langCode)

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

Esquema

url:* cadena
URL de la página
ejemplo: shop

langCode: cadena
código de idioma
ejemplo: en_US

Este método recupera un único objeto de página basado en su URL (url) desde la API. Devuelve una Promesa que se resuelve en el objeto de página, siendo el objeto específico dependiendo del tipo de página que se esté devolviendo.

Ejemplo 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: número
identificador del objeto
ejemplo: 1764

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

pageUrl cadena
URL única de la página

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

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

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

isVisible: booleano
bandera de visibilidad de la página
ejemplo: true

position: número
número de posición (para ordenamiento)
ejemplo: 192

type cadena
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 ]

templateIdentifier: cadena
identificador personalizado de la plantilla asociada
ejemplo: my-template

attributeSetId: número
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: booleano
indicador de indexación de la página (true o false)
ejemplo: false

products número
número de productos asociados con la página
ejemplo: 0