getBlocksByPageUrl
Recibiendo objetos para un bloque relacionado por URL de página.
Descripción
Obtiene objetos PositionBlock para la página por URL. Devuelve una Promesa que se resuelve en un array de objetos IPositionBlock.
.getBlocksByPageUrl(
,
);
Esquema de parámetros
Esquema
url(requerido): string
URL de la página
ejemplo: "about"
langCode: string
Código de idioma. Predeterminado: "en_US"
ejemplo: "en_US"
Ejemplos
Ejemplo mínimo
const response = await Pages.getBlocksByPageUrl('shop');
Ejemplo con atributos
const response = await Pages.getBlocksByPageUrl('shop', 'en_US');
Ejemplo de respuesta
[
{
"id": 1,
"attributeSetIdentifier": null,
"localizeInfos": {
"title": "Product Block"
},
"version": 0,
"position": 1,
"identifier": "product_block",
"type": "product_block",
"templateIdentifier": null,
"isVisible": true,
"isSync": false,
"attributeValues": {},
"countElementsPerRow": 1,
"quantity": 1,
"products": [
{
"id": 2959,
"localizeInfos": {
"title": "Split"
},
"isVisible": true,
"isSync": true,
"sku": null,
"price": 120,
"additional": {
"prices": {
"min": 51,
"max": 180
}
},
"categories": [
"catalog"
],
"statusIdentifier": "sale",
"statusLocalizeInfos": {
"title": "Sale"
},
"templateIdentifier": null,
"shortDescTemplateIdentifier": "product_preview",
"attributeValues": {
"p": {
"type": "float",
"value": 120,
"isIcon": false,
"position": 0,
"additionalFields": {},
"isProductPreview": false
},
"p1": {
"type": "float",
"value": 40,
"isIcon": false,
"position": 1,
"additionalFields": {},
"isProductPreview": false
},
"p2": {
"type": "float",
"value": 60,
"isIcon": false,
"position": 2,
"additionalFields": {},
"isProductPreview": false
},
"p3": {
"type": "float",
"value": 20,
"isIcon": false,
"position": 3,
"additionalFields": {},
"isProductPreview": false
},
"currency": {
"type": "string",
"value": "usd",
"isIcon": false,
"position": 4,
"additionalFields": {},
"isProductPreview": false
}
},
"attributeSetIdentifier": "test",
"position": 1,
"rating": {},
"moduleFormConfigs": [
{
"id": 12,
"formIdentifier": "review",
"moduleIdentifier": "catalog",
"isGlobal": false,
"isClosed": false,
"isModerate": false,
"viewOnlyMyData": false,
"commentOnlyMyData": false,
"entityIdentifiers": [
{
"id": "catalog",
"isNested": true
}
],
"formDataCount": 807,
"ratingCalculation": "average",
"allowHalfRatings": null,
"maxRatingScale": null,
"isAnonymous": null,
"allowRerating": null,
"isRating": null,
"nestedEntityIdentifiers": [
"catalog"
],
"exceptionIds": []
}
],
"discountConfig": {}
}
]
},
{
"id": 4,
"attributeSetIdentifier": "block",
"localizeInfos": {
"title": "test"
},
"version": 31,
"position": 2,
"identifier": "test",
"type": "common_block",
"templateIdentifier": null,
"isVisible": true,
"isSync": true,
"attributeValues": {
"block-text": {
"type": "string",
"value": "some text",
"position": 0,
"additionalFields": {}
},
"interval": {
"type": "timeInterval",
"value": [
{
"values": [
{
"id": "bbc82c9f-1bc4-4c86-b83c-c062016eb7cb",
"dates": [
"2025-04-14T00:00:00.000Z",
"2025-04-14T00:00:00.000Z"
],
"times": [
[
{
"hours": 9,
"minutes": 0
},
{
"hours": 10,
"minutes": 0
}
],
[
{
"hours": 10,
"minutes": 0
},
{
"hours": 11,
"minutes": 0
}
],
[
{
"hours": 11,
"minutes": 0
},
{
"hours": 12,
"minutes": 0
}
],
"..."
],
"intervals": [],
"exceptions": [],
"intervalId": "c6466cd8-c55d-4583-97c5-42b684210f12",
"inEveryWeek": true,
"inEveryMonth": true
}
],
"intervalId": "c6466cd8-c55d-4583-97c5-42b684210f12"
}
],
"position": 1,
"additionalFields": {}
}
}
},
{
"id": 6,
"attributeSetIdentifier": null,
"localizeInfos": {
"title": "Frequently ordered"
},
"version": 2,
"position": 3,
"identifier": "freq_ordered",
"type": "frequently_ordered_block",
"templateIdentifier": "frequently_ordered_block_default",
"isVisible": true,
"isSync": false,
"attributeValues": {}
},
"..."
]
Esquema de respuesta
Esquema: IPositionBlock[]
id: number
El identificador del objeto.
ejemplo: 1
attributeSetIdentifier: string | null
ID del conjunto de atributos.
ejemplo: "block"
localizeInfos: ILocalizeInfo
El nombre de la página, teniendo en cuenta la localización.
ejemplo:
{
"title": "Blog",
"menuTitle": "Blog",
"htmlContent": "",
"plainContent": ""
}
version: number
El número de versión del objeto.
ejemplo: 0
position: number
La posición del objeto.
ejemplo: 1
identifier: string
El identificador textual para el campo del registro.
ejemplo: "product_block"
type: BlockType
Tipo de bloque.
ejemplo: "product"
templateIdentifier: string | null
ID de usuario de la plantilla vinculada.
ejemplo: null
isVisible: boolean
Un signo de visibilidad de la página.
ejemplo: true
isSync: boolean
Indicación de indexación de la página.
ejemplo: false
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",
"position": 0,
"additionalFields": []
}
}
countElementsPerRow: number
Número de elementos mostrados por fila en el bloque, si corresponde.
ejemplo: 3
quantity: number
Cantidad de páginas en el bloque.
ejemplo: 1
similarProducts: IProductsResponse
Respuesta de productos similares (total + elementos). Presente solo para bloques "similar_products_block" y solo cuando el modo de ahorro de tráfico está desactivado.
similarProducts.total: number
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"
}
]
similarProducts.totalFound: number
Número de productos que coinciden antes de que se apliquen los límites; devuelto por los endpoints de productos del bloque (similarProducts, recomendaciones de carrito/lista de deseos, pedidos frecuentes). Opcional.
ejemplo: 2
products: IProductsEntity[]
Array de productos asociados con el bloque. Presente solo para bloques "product_block" y solo cuando el modo de ahorro de tráfico está desactivado.
products.id: number
El identificador único.
ejemplo: 12345
products.localizeInfos: ILocalizeInfo
El nombre de los productos, teniendo en cuenta la localización.
ejemplo:
{}
products.statusIdentifier: string | null
Identificadores de estado de la página del producto (puede ser nulo).
ejemplo: "in_stock"
products.statusLocalizeInfos: ILocalizeInfo
Nombre de estado localizado para el producto.
ejemplo:
{ "title": "Sale" }
products.attributeSetIdentifier: string | null
ID del conjunto de atributos.
ejemplo: "set_12345"
products.position: number
Número del artículo (para ordenación).
ejemplo: 1
products.price: number | null
El valor del precio de la página del producto tomado del índice.
ejemplo: 150.00
products.additional: object
Valor adicional del índice.
ejemplo:
{
"prices": {
"min": 5,
"max": 150
}
}
products.sku: string | null
SKU del producto (Unidad de Mantenimiento de Stock), puede ser nulo.
ejemplo: "SKU_12345"
products.isSync: boolean
Indicación de indexación de la página.
ejemplo: true
products.attributeValues: IAttributeValues
Array de valores de atributos del índice, representados.
ejemplo:
[
{
"id": "color",
"value": "red"
}
]
products.categories: string[]
Categorías de productos.
ejemplo:
[
1,
2,
3
]
products.isVisible: boolean
Un signo de visibilidad de la página.
ejemplo: true
products.moduleFormConfigs: Array<IFormConfig>
Configuraciones de formularios del módulo (opcional).
products.rating: IRating
Datos de calificación.
products.isPositionLocked: boolean
Indicador de bloqueo de posición de ordenación (opcional).
ejemplo: false
products.relatedIds: number[]
IDs de páginas de productos relacionados.
ejemplo:
[
12345,
67890
]
products.paymentStages: unknown
Datos de etapas de pago (puede ser nulo).
ejemplo: null
products.distance: number
Distancia de relevancia de búsqueda vectorial (semántica). Presente solo en los resultados de búsqueda vectorial.
ejemplo: 0.42
products.discountConfig: Record<string, unknown>
Objeto de configuración de descuento.
ejemplo:
{}
products.templateIdentifier: string | null
ID de usuario de la plantilla vinculada.
ejemplo: "template_12345"
products.shortDescTemplateIdentifier: string | null
ID de usuario de la plantilla vinculada para una descripción corta.
ejemplo: "short_desc_template_12345"
products.signedPrice: string
El precio firmado del producto se obtiene junto con los datos del producto cuando signPrice está configurado.
ver: Precio fijo del producto
ejemplo: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
products.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"
}
]
products.blocks: string[]
Array de identificadores de bloques.
ejemplo:
[
"block_12345",
"block_67890"
]
🔒
signedPricees el token firmado que lleva el precio bloqueado: devuélvelo cuando crees un pedido. Ver Precio fijo del producto (signedPrice).