getPageById

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

Descripción

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

Páginas.getPageById(
id*,
langCode
);

Esquema de parámetros

Esquema

id(requerido): número
El identificador único de la página a ser recuperada
ejemplo: 1

langCode: cadena
Código de idioma. Predeterminado: "en_US"
ejemplo: "en_US"

Pruébalo en vivo

Ejecuta este método de forma interactiva en el sandbox de JS SDK — conecta tu URL de Proyecto y Token de Aplicación en la primera visita, luego abre:

Obtener página por ID — recupera una única página de CMS por su ID numérico.

Ejemplos

Ejemplo mínimo

const response = await Pages.getPageById(1);

Ejemplo con atributos

const response = await Pages.getPageById(1, 'en_US');

Ejemplo de respuesta

{
  "id": 8,
  "parentId": null,
  "pageUrl": "blog",
  "depth": 0,
  "localizeInfos": {
    "title": "Blog",
    "menuTitle": "Blog",
    "htmlContent": "",
    "plainContent": ""
  },
  "isVisible": true,
  "blocks": [],
  "type": "common_page",
  "templateIdentifier": "template",
  "attributeSetIdentifier": "page",
  "attributeValues": {
    "text": {
      "type": "string",
      "value": "some text",
      "position": 0,
      "additionalFields": {}
    },
    "number": {
      "type": "integer",
      "value": 0,
      "position": 1,
      "additionalFields": {}
    },
    "real": {
      "type": "real",
      "value": "",
      "position": 2,
      "additionalFields": {}
    },
    "float": {
      "type": "float",
      "value": 0,
      "position": 3,
      "additionalFields": {}
    }
  },
  "moduleFormConfigs": [
    {
      "id": 9,
      "formIdentifier": "full_form",
      "moduleIdentifier": "content",
      "isGlobal": false,
      "isClosed": false,
      "isModerate": true,
      "viewOnlyMyData": false,
      "commentOnlyMyData": false,
      "entityIdentifiers": [
        {
          "id": "blog",
          "isNested": false
        }
      ],
      "formDataCount": 3902,
      "ratingCalculation": "average",
      "allowHalfRatings": null,
      "maxRatingScale": null,
      "isAnonymous": null,
      "allowRerating": null,
      "isRating": null,
      "entityFormDataCount": {
        "blog": 3902
      },
      "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": 479,
      "ratingCalculation": "average",
      "allowHalfRatings": null,
      "maxRatingScale": null,
      "isAnonymous": null,
      "allowRerating": null,
      "isRating": null,
      "entityFormDataCount": {
        "blog": 479
      },
      "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": 688,
      "ratingCalculation": "average",
      "allowHalfRatings": null,
      "maxRatingScale": null,
      "isAnonymous": null,
      "allowRerating": null,
      "isRating": null,
      "entityFormDataCount": {
        "blog": 688
      },
      "nestedEntityIdentifiers": [],
      "exceptionIds": []
    }
  ],
  "isSync": true,
  "template": {
    "id": 4,
    "attributeSetIdentifier": null,
    "title": "Template",
    "generalTypeId": 4,
    "identifier": "template",
    "version": 0,
    "generalTypeName": "catalog_page",
    "attributeValues": {},
    "position": 1
  }
}

Esquema de respuesta

Esquema: IPagesEntity

id: número
El identificador del objeto.
ejemplo: 8

parentId: número | nulo
El id de la página padre, si contiene nulo, entonces es la página de nivel superior.
ejemplo: 10

pageUrl: cadena
URL única de la página.
ejemplo: "blog"

depth: número
Profundidad de anidación de la página en relación con parentId.
ejemplo: 10

localizeInfos: ILocalizeInfo
El nombre de la página, teniendo en cuenta la localización.
ejemplo:

{
  "title": "Blog",
  "menuTitle": "Blog",
  "htmlContent": "",
  "plainContent": ""
}

isVisible: booleano
Un signo de visibilidad de la página.
ejemplo: true

type: Types
Tipo de página.
ejemplo: "common_page"

templateIdentifier: cadena | nulo
Id de usuario de la plantilla vinculada.
ejemplo: "template"

attributeSetIdentifier: cadena | nulo
Id del conjunto de atributos.
ejemplo: "page"

attributeValues: IAttributeValues
Mapa de valores de atributos indexados por marcador; objeto vacío cuando no hay ninguno.
ejemplo:

{
  "text": {
    "type": "string",
    "value": "some text",
    "position": 0,
    "additionalFields": []
  }
}

isSync: booleano
Indicación de indexación de la página.
ejemplo: true

template: objeto
Objeto de plantilla.
ejemplo:

position: número
Número de ítem (para ordenamiento).
ejemplo: 2

config: Record<string, number>
Configuraciones de salida para páginas de catálogo.
ejemplo:

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

products: número
El número de productos vinculados a la página.
ejemplo: 0

childrenCount: cadena
Conteo de hijos.
ejemplo: 1

blocks: IBlockEntity[] | cadena[]
bloques.
ejemplo:

{
  "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 vacío cuando no hay ninguno.
ejemplo:

{
  "block-text": {
    "type": "string",
    "value": "some text",
    "isIcon": false,
    "position": 0,
    "additionalFields": [],
    "isProductPreview": false
  }
}

blocks.id: número
Identificador único del bloque.
ejemplo: 1234

blocks.localizeInfos: ILocalizeInfo
Información de localización para el bloque.
ejemplo:

{
  "key": "value"
}

blocks.version: número
Versión de la entidad de bloque.
ejemplo: 1

blocks.identifier: cadena
Identificador único de cadena para el bloque.
ejemplo: "block1"

blocks.type: BlockType
Tipo del bloque.
ejemplo: "product"

blocks.position: número
Posición del bloque para ordenamiento.
ejemplo: 1

blocks.templateIdentifier: cadena | nulo
Identificador de la plantilla utilizada por el bloque, o nulo si no aplica.
ejemplo: "template1"

blocks.isVisible: booleano
Indica si el bloque es visible.
ejemplo: true

blocks.countElementsPerRow: número
Número de elementos mostrados por fila en el bloque, si aplica.
ejemplo: 3

blocks.quantity: número
Cantidad de ítems en el bloque, si aplica.
ejemplo: 5

blocks.similarProducts: IProductsResponse
Respuesta que contiene productos similares asociados con el bloque.
ejemplo:

{
  "total": 10,
  "items": []
}

similarProducts.total: número
El número total de productos encontrados.
ejemplo: 100

similarProducts.items: IProductsEntity[]
Un array de entidades de productos.
ejemplo:

[
  {
    "id": 12345,
    "title": "Product 1"
  },
  {
    "id": 67890,
    "title": "Product 2"
  }
]

items.id: número
El identificador único.
ejemplo: 12345

items.localizeInfos: ILocalizeInfo
El nombre de los productos, teniendo en cuenta la localización.
ejemplo:

items.statusIdentifier: cadena | nulo
Identificadores de estado de la página del producto (puede ser nulo).
ejemplo: "in_stock"

items.statusLocalizeInfos: ILocalizeInfo
Nombre de estado localizado para el producto.
ejemplo: { "title": "Sale" }

items.attributeSetIdentifier: cadena | nulo
Id del conjunto de atributos.
ejemplo: "set_12345"

items.position: número
Número de ítem (para ordenamiento).
ejemplo: 1

items.price: número | nulo
El valor del precio de la página del producto tomado del índice.
ejemplo: 150.00

items.additional: objeto
Valor adicional del índice.
ejemplo: { prices: { min: 5 max: 150 } }

items.sku: cadena | nulo
SKU del producto (Unidad de Mantenimiento de Stock), puede ser nulo.
ejemplo: "SKU_12345"

items.isSync: booleano
Indicación de indexación de la página.
ejemplo: true

items.attributeValues: AttributeType
Array de valores de atributos del índice, representados.
ejemplo:

[
  {
    "id": "color",
    "value": "red"
  }
]

items.categories: cadena[]
Categorías de productos.
ejemplo:

[
  1,
  2,
  3
]

items.isVisible: booleano
Un signo de visibilidad de la página.
ejemplo: true

items.moduleFormConfigs: Array<IFormConfig>
Configuraciones de formularios del módulo (opcional).

items.rating: IRating
Datos de calificación.

items.isPositionLocked: booleano
Indicador de bloqueo de posición de ordenamiento (opcional).
ejemplo: false

items.relatedIds: número[]
Ids de páginas de productos relacionadas.
ejemplo:

items.paymentStages: desconocido
Datos de etapas de pago (puede ser nulo).
ejemplo: nulo

items.discountConfig: Record<string, unknown>
Objeto de configuración de descuento.
ejemplo:

items.templateIdentifier: cadena | nulo
Id de usuario de la plantilla vinculada.
ejemplo: "template_12345"

items.shortDescTemplateIdentifier: cadena | nulo
Id de usuario de la plantilla vinculada para una descripción corta.
ejemplo: "short_desc_template_12345"

items.signedPrice: cadena
Signo de precio.

items.productPages: IProductPageRef[]
Array de referencias de páginas de productos que vinculan el producto a sus páginas.
ejemplo:

[
  {
    "id": 16,
    "pageId": 4,
    "productId": 15,
    "positionId": 244,
    "categoryPath": "products"
  }
]

productPages.id: número
Identificador único del registro de enlace producto-página.
ejemplo: 16

productPages.pageId: número
Identificador de la página a la que está vinculado el producto.
ejemplo: 4

productPages.productId: número
Identificador del producto.
ejemplo: 15

productPages.positionId: número
Identificador de posición de ordenamiento dentro de la página.
ejemplo: 244

productPages.categoryPath: cadena
Ruta de categoría de la página a la que pertenece el producto.
ejemplo: "products"

items.blocks: cadena[]
Array de identificadores de bloques.
ejemplo:

[
  "block_12345",
  "block_67890"
]

blocks.products: IProductsEntity[]
Array de entidades de productos asociadas con el bloque.
ejemplo:

[
  {
    "id": 1,
    "name": "Product 1"
  },
  {
    "id": 2,
    "name": "Product 2"
  }
]

moduleFormConfigs: Array<IFormConfig>
Configuraciones de formularios del módulo vinculadas a la página.

rating: IRating
Datos de calificación.

total: cadena
Número total de productos vinculados a la página.
ejemplo: "10"

categoryPath: cadena
Cadena de ruta de categoría.
ejemplo: "catalog"

Descripción​

Esquema de parámetros​

Pruébalo en vivo​

Ejemplos​

Ejemplo mínimo​

Ejemplo con atributos​

Ejemplo de respuesta​

Esquema de respuesta​