getTemplateByMarker

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

Описание

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

Templates.getTemplateByMarker(

marker, langCode

);

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

Схема

marker(обязательно): string
Уникальный маркер шаблона для извлечения
пример: "template_12345"

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

Примеры

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

const response = await Templates.getTemplateByMarker('my-marker');

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

const response = await Templates.getTemplateByMarker('my-marker', 'en_US');

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

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

Схема ответа

Схема: ITemplateEntity

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

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

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

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

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

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

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

"product"

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

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

---