Получить список всех доступных параметров

POST /v1/attributes/list

POST/v1/attributes/list

Возвращает глобальный список всех атрибутов маркетплейса (общих для всех категорий)

  • для выбора продавцом при создании карточки. Включает как атрибуты из шаблонов, так и кастомные атрибуты продавца.

Тело запроса

filter
[ "object", "null" ]
Показать свойства
code
[ "string", "null" ]
Точное совпадение по коду
category_id
[ "string", "null" ]
ID категории - вернуть атрибуты шаблона этой категории + все глобальные
include_custom
[ "boolean", "null" ]
Включать ли кастомные атрибуты продавца (уровень A)
pagination
object
Cursor-пагинация. Первый запрос - без cursor (или пустой). Для получения следующей страницы - передать cursor из ответа (pagination.next_cursor). Если has_next: false - достигнут конец списка.
Показать свойства
cursor
[ "string", "null" ]
Курсор для следующей страницы (opaque-токен, генерируется сервером). Пусто или отсутствие - первая страница.
limit
integer
required
Лимит элементов на странице

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

200Список атрибутов
application/json
object
attributes
array
required
Элемент списка атрибутов (упрощённый, без values)
Показать свойства
id
string
required
code
string
required
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
type
string
required
Тип данных значения:
  • string - произвольная строка
  • int - целое число
  • float - дробное число
  • enum - одно значение из справочника
  • multi - несколько значений из справочника
  • bool - да/нет
  • file - файл (изображение/документ)
  • ref - ссылка на сущность (бренд, категория, продавец)
  • color - цвет (UI: показывать свотчи, значения — enum с RGB)
  • size - размер (UI: показывать размерную сетку)
  • brand - бренд (UI: показывать выбор бренда)
Допустимые значения
stringintfloatenummultiboolfilerefcolorsizebrand
unit
has_dictionary
[ "boolean", "null" ]
source
string
required
Источник атрибута:
  • marketplace - общий, из шаблона маркетплейса
  • custom - личный, продавца (уровень A)
Допустимые значения
marketplacecustom
seller_id
[ "string", "null" ]
Только для source=custom - владелец кастомного атрибута
categories_count
[ "integer", "null" ]
В скольких категориях используется
sort_order
[ "integer", "null" ]
pagination
object
required
Результат cursor-пагинации
Показать свойства
next_cursor
[ "string", "null" ]
Курсор для следующей страницы. Передать в pagination.cursor следующего запроса. Пусто (или null), если has_next: false (достигнут конец списка).
has_next
boolean
required
true - есть следующая страница; false - достигнут конец списка.
total
[ "integer", "null" ]
Общее количество элементов (опционально). Может быть неточным (приблизительная оценка на момент запроса). Не возвращается, если сервер не может оценить общее количество.
POST/v1/attributes/list
1curl https://api.omninet.ru/v1/attributes/list \2  --request POST \3  --header 'Content-Type: application/json' \4  --data '{5  "filter": {6    "include_custom": true7  }8}'
{
  "attributes": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "description": null,
      "role": "string",
      "type": "string",
      "unit": null,
      "has_dictionary": null,
      "source": "string",
      "seller_id": null,
      "categories_count": null,
      "sort_order": 0
    }
  ],
  "pagination": {
    "next_cursor": null,
    "has_next": true,
    "total": null
  }
}

Список атрибутов