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.

Blocks.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 la paginación. Predeterminado: 0
ejemplo: 0

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

Por defecto, puedes recuperar 10 objetos. Esto se debe al límite de registros en la configuración de permisos del módulo.
Para que la paginación funcione correctamente, necesitas configurar Permisos del módulo de acuerdo a tus necesidades en la sección correspondiente.

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": "Block"
  },
  "version": 0,
  "position": 1,
  "identifier": "block",
  "type": "common_block",
  "templateIdentifier": null,
  "isVisible": true,
  "attributeValues": {}
}

Esquema de respuesta

Esquema: IBlockEntity

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
  }
}

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 de cadena único para el bloque.
ejemplo: "block1"

type: BlockType
Tipo de bloque.
ejemplo: "product"

position: number
Posición del bloque para ordenación.
ejemplo: 1

templateIdentifier: string | null
Identificador de 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": []
}

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"
  }
]

items.id: number
El identificador único.
ejemplo: 12345

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

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

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

items.attributeSetIdentifier: string | null
ID del conjunto de atributos.
ejemplo: "set_12345"

items.position: number
Número del artículo (para ordenación).
ejemplo: 1

items.price: number | null
El valor del precio de la página del producto tomado del índice.
ejemplo: 150.00

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

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

items.isSync: boolean
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: string[]
Categorías de productos.
ejemplo:

[
  1,
  2,
  3
]

items.isVisible: boolean
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: boolean
Indicador de bloqueo de posición de ordenación (opcional).
ejemplo: false

items.relatedIds: number[]
IDs de páginas de productos relacionadas.
ejemplo:

[
  12345,
  67890
]

items.paymentStages: unknown
Datos de etapas de pago (puede ser null).
ejemplo: null

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

items.templateIdentifier: string | null
ID de usuario de la plantilla vinculada.
ejemplo: "template_12345"

items.shortDescTemplateIdentifier: string | null
ID de usuario de la plantilla vinculada para una descripción corta.
ejemplo: "short_desc_template_12345"

items.signedPrice: string
Signo del 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: number
Identificador único del registro de enlace producto-página.
ejemplo: 16

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

productPages.productId: number
Identificador del producto.
ejemplo: 15

productPages.positionId: number
Identificador de posición de ordenación dentro de la página.
ejemplo: 244

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

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

[
  "block_12345",
  "block_67890"
]

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

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

---