getTemplateByType

Получение всех объектов шаблонов, сгруппированных по типам.

Описание

Этот метод извлекает один объект шаблона на основе его идентификатора (id) из API. Он возвращает Promise, который разрешается в массив индексированных объектов шаблонов ITemplateEntity.

Templates.getTemplateByType(

type, langCode

);

Схема параметров

Схема

type(обязательный): Типы
Тип шаблонов для извлечения. Этот параметр указывает категорию или классификацию запрашиваемых шаблонов
пример: "product"

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

Примеры

Минимальный пример

const response = await Templates.getTemplateByType('forCatalogProducts');

Пример с атрибутами

const response = await Templates.getTemplateByType('forCatalogProducts', 'en_US');

Пример ответа

[
  {
    "id": 4,
    "attributeSetIdentifier": null,
    "title": "Шаблон",
    "generalTypeId": 4,
    "identifier": "template",
    "version": 0,
    "generalTypeName": "catalog_page",
    "attributeValues": {},
    "position": 1
  }
]

Схема ответа

Схема: ITemplateEntity[]

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

attributeSetIdentifier: строка | null
Идентификатор набора атрибутов.
пример: "attribute_set_1"

title: строка
Название шаблона.
пример: "Шаблон продукта"

generalTypeId: число
Идентификатор общего типа сущности.
пример: 67890

identifier: строка
Текстовый идентификатор для поля записи.
пример: "template_12345"

version: число
Номер версии объекта.
пример: 1

generalTypeName: Типы
Название общего типа.
пример:

"product"

attributeValues: AttributeType
Значения атрибутов из индекса (представленные в виде пары идентификатор пользовательского атрибута: значение атрибута).

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

---