getBlockByMarker

Obteniendo un único objeto de bloque por marcador.

Descripción

Este método devuelve un objeto de bloque por marcador. Devuelve una Promesa que se resuelve en un objeto IBlockEntity.

Bloques.getBlockByMarker(

marker, langCode, offset, limit

);

Esquema de parámetros

Esquema

marker(requerido): string
Marcador del Bloque
ejemplo: "product_block"

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

offset: number
Parámetro para paginación. Predeterminado: 0
ejemplo: 0

limit: number
Parámetro para paginación. Predeterminado: 30
ejemplo: 30

Ejemplos

Ejemplo mínimo

const response = await Blocks.getBlockByMarker('my-marker');

Ejemplo con atributos

const response = await Blocks.getBlockByMarker('my-marker', 'en_US', 0, 30);

Ejemplo de respuesta

{
  "id": 3,
  "localizeInfos": {
    "title": "Bloque"
  },
  "version": 0,
  "position": 1,
  "identifier": "block",
  "type": "common_block",
  "templateIdentifier": null,
  "isVisible": true,
  "attributeValues": {}
}

Esquema de respuesta

Esquema: IBlockEntity

attributeValues: AttributeType
Tipo de atributos utilizados en el bloque.
ejemplo:

{
  "block-text": {
    "type": "string",
    "value": "algún texto",
    "isIcon": false,
    "position": 0,
    "additionalFields": [],
    "isProductPreview": false
  }
}

id: number
Identificador único del bloque.
ejemplo: 1234

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

{
  "key": "value"
}

version: number
Versión de la entidad de bloque.
ejemplo: 1

identifier: string
Identificador único en forma de cadena para el bloque.
ejemplo: "block1"

type: string
Tipo del bloque, como 'producto', 'página_de_error', etc.
ejemplo: "producto"

templateIdentifier: string | null
Identificador para la plantilla utilizada por el bloque, o null si no aplica.
ejemplo: "template1"

isVisible: boolean
Indica si el bloque es visible.
ejemplo: true

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

quantity: number
Cantidad de artículos en el bloque, si aplica.
ejemplo: 5

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

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

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

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

---