getBlockByMarker

Получение одного объекта блока по маркеру

Blocks.getBlockByMarker(marker, langCode, offset, limit)

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

Схема

marker(обязательный): строка
Маркер блока
пример: "product_block"

langCode: строка
Код языка. По умолчанию: "en_US"
пример: "en_US"

offset: число
Параметр для постраничной навигации. По умолчанию: 0
пример: 0

limit: число
Параметр для постраничной навигации. По умолчанию: 30
пример: 30

Этот метод возвращает один объект блока по маркеру.

Пример возвращаемого значения:

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

Схема

attributeValues: AttributeType
Тип атрибутов, используемых в блоке.
пример:

{
  "key": "value"
}

id: число
Уникальный идентификатор блока.
пример: 1234

identifier: строка
Уникальный строковый идентификатор для блока.
пример: "block1"

isVisible: логическое
Указывает, виден ли блок.
пример: true

localizeInfos: ILocalizeInfo
Информация о локализации для блока.
пример:

{
  "key": "value"
}

position: число
Позиция блока в списке или макете.
пример: 1

templateIdentifier: строка
Идентификатор шаблона, используемого блоком, или null, если не применимо.
пример: "template1"

type: строка
Тип блока, например 'product', 'error_page' и т.д.
пример: "product"

version: число
Версия сущности блока.
пример: 1

countElementsPerRow: число
Количество элементов, отображаемых в строке в блоке, если применимо.
пример: 3

quantity: число
Количество элементов в блоке, если применимо.
пример: 5

similarProducts: IProductsResponse
Ответ, содержащий похожие продукты, связанные с блоком.
пример:

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

products: IProductsEntity[]
Массив сущностей продуктов, связанных с блоком.
пример:

[
  {
    "id": 1,
    "name": "Продукт 1"
  },
  {
    "id": 2,
    "name": "Продукт 2"
  }
]

---