Перейти к основному содержимому

getTemplateByType

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

Templates.getTemplateByType(type, langCode)

const value = await Templates.getTemplateByType('forCatalogProducts')
Схема

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

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

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

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

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

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

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

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

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

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

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

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

"product"

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

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

{
"id": 1,
"value": "some"
}