Получить шаблон(ы) по категории (или списку категорий)

POST /v1/templates/get

POST/v1/templates/get

Возвращает шаблон(ы) для одной или нескольких категорий. Для каждой категории - её Template с Attributes[] и Groups[]. Поддерживает batch (несколько category_ids в одном запросе).

Тело запроса

category_ids
array
required
ID категорий (1 или более; batch)
include_values
[ "boolean", "null" ]
Включать ли справочник значений в Attribute.Values[] (false - только структура)
locale
[ "string", "null" ]
Язык локализованных полей (ISO 639-1)

Успешный ответ

200Шаблон(ы) для запрошенных категорий
application/json
object
templates
array
required
Шаблоны для запрошенных категорий (отсутствуют, если для категории нет шаблона)
Шаблон карточки для листовой категории. Содержит ссылки на атрибуты из глобального реестра (по attribute_id), а не их полные определения.
Показать свойства
id
string
required
Внутренний ID шаблона
category_id
string
required
ID категории, к которой привязан шаблон
version
string
required
Версия (semver)
status
string
required
Статус шаблона:
  • draft - черновик, не доступен продавцам
  • active - активен, используется для создания карточек
  • deprecated - устарел, новые карточки создавать нельзя (только редактировать существующие)
Допустимые значения
draftactivedeprecated
attributes
array
required
Ссылка на атрибут в шаблоне. Полное определение атрибута (code, name, type, unit, values) берётся из глобального реестра (attributes/list) по id. В шаблоне задаются только template-specific поля: role, required, sort_order, group_id.
Показать свойства
id
string
required
Глобальный ID атрибута (из реестра attributes/list). Один и тот же id может встречаться в шаблонах разных категорий — это один и тот же атрибут.
code
string
required
Универсальный код атрибута (для сопоставления между категориями). Предопределённые: item_name, brand, color, size, weight_brutto, ... Свободный для кастомных.
name
string
required
Отображаемое название
description
[ "string", "null" ]
Описание для продавца (что заполнить, в каких единицах)
role
string
required
Роль атрибута в карточке:
  • specification - потребительский (таблица спецификаций на витрине); описывает параметр SPU (одинаковый для всех SKU)
  • property - технический (внутренний, не показывается покупателю); описывает параметр SPU
  • variation - потребительский + описывает параметр SKU (отличает варианты внутри SPU): показывается в таблице спецификаций и кнопками выбора варианта; каждая комбинация значений variation-осей = отдельный SKU со своей ценой/штрихкодом/остатком
  • property_variation - технический + описывает параметр SKU (отличает варианты внутри SPU): не показывается покупателю, но используется для различения SKU
Допустимые значения
specificationpropertyvariationproperty_variation
required
boolean
required
Обязателен для валидации
type
string
required
Тип данных значения:
  • string - произвольная строка
  • int - целое число
  • float - дробное число
  • enum - одно значение из справочника
  • multi - несколько значений из справочника
  • bool - да/нет
  • file - файл (изображение/документ)
  • ref - ссылка на сущность (бренд, категория, продавец)
  • color - цвет (UI: показывать свотчи, значения — enum с RGB)
  • size - размер (UI: показывать размерную сетку)
  • brand - бренд (UI: показывать выбор бренда)
Допустимые значения
stringintfloatenummultiboolfilerefcolorsizebrand
unit
Единица измерения (nil для безразмерных: цвет, бренд)
max_count
[ "integer", "null" ]
Макс. число значений (0 = без лимита)
max_length
[ "integer", "null" ]
Макс. длина строки (для type=string)
min_value
[ "number", "null" ]
Мин. значение (для int/float, опц.)
max_value
[ "number", "null" ]
Макс. значение (для int/float, опц.)
default_value
[ "string", "null" ]
Значение по умолчанию (опц.)
has_dictionary
boolean
required
Есть ли справочник значений (enum/multi - обычно true; string - false)
values
[ "array", "null" ]
Допустимые значения (справочник). Пусто = свободный ввод.
Показать свойства
Свойства не описаны
group_id
[ "string", "null" ]
ID группы (из Template.Groups[].ID)
locales
[ "array", "null" ]
Локализованные name/description по языкам
Показать свойства
Свойства не описаны
sort_order
[ "integer", "null" ]
Порядок отображения в шаблоне
groups
[ "array", "null" ]
Показать свойства
Свойства не описаны
updated_at
[ "string", "null" ]
POST/v1/templates/get
1curl https://api.omninet.ru/v1/templates/get \2  --request POST \3  --header 'Content-Type: application/json' \4  --data '{5  "category_ids": [6    "cat_qled_tv"7  ],8  "include_values": true,9  "locale": "ru"10}'
{
  "templates": [
    {
      "id": "tpl_qled_tv",
      "category_id": "cat_qled_tv",
      "version": "1.0.0",
      "status": "active",
      "attributes": [
        {
          "id": "attr_color",
          "code": "color",
          "name": "Цвет",
          "role": "variation",
          "required": false,
          "type": "color",
          "has_dictionary": true,
          "values": [
            {
              "code": "black",
              "name": "Чёрный"
            },
            {
              "code": "white",
              "name": "Белый"
            },
            {
              "code": "silver",
              "name": "Серебристый"
            }
          ]
        },
        {
          "id": "attr_screen_size",
          "code": "screen_size",
          "name": "Диагональ экрана",
          "role": "specification",
          "required": true,
          "type": "float",
          "has_dictionary": false,
          "unit": {
            "code": "inch",
            "name": "дюйм",
            "symbol": "\"",
            "quantity": "length"
          }
        }
      ]
    },
    {
      "id": "tpl_sneakers",
      "category_id": "cat_sneakers",
      "version": "1.0.0",
      "status": "active",
      "attributes": [
        {
          "id": "attr_color",
          "code": "color",
          "name": "Цвет",
          "role": "variation",
          "required": true,
          "type": "color",
          "has_dictionary": true,
          "values": [
            {
              "code": "red",
              "name": "Красный"
            },
            {
              "code": "blue",
              "name": "Синий"
            },
            {
              "code": "black",
              "name": "Чёрный"
            },
            {
              "code": "white",
              "name": "Белый"
            }
          ]
        },
        {
          "id": "attr_shoe_size",
          "code": "shoe_size",
          "name": "Размер обуви",
          "role": "variation",
          "required": true,
          "type": "size",
          "has_dictionary": true,
          "unit": {
            "code": "eu",
            "name": "EUR",
            "symbol": "EU",
            "quantity": "shoe_size"
          }
        }
      ]
    },
    {
      "id": "tpl_luggage",
      "category_id": "cat_luggage",
      "version": "1.0.0",
      "status": "active",
      "attributes": [
        {
          "id": "attr_color",
          "code": "color",
          "name": "Цвет",
          "role": "specification",
          "required": false,
          "type": "color",
          "has_dictionary": true,
          "values": [
            {
              "code": "black",
              "name": "Чёрный"
            },
            {
              "code": "blue",
              "name": "Синий"
            },
            {
              "code": "red",
              "name": "Красный"
            }
          ]
        },
        {
          "id": "attr_volume",
          "code": "volume",
          "name": "Объём",
          "role": "specification",
          "required": true,
          "type": "float",
          "has_dictionary": false,
          "unit": {
            "code": "l",
            "name": "литр",
            "symbol": "л",
            "quantity": "volume"
          }
        }
      ]
    }
  ]
}

Шаблон(ы) для запрошенных категорий