Получить список категорий

POST /v1/categories/list

POST/v1/categories/list

Возвращает плоский список категорий (без children - дерево собирается клиентом по parent_id). Поддерживает фильтрацию по статусу, листовости, родителю и конкретным ID.

Тело запроса

filter
[ "object", "null" ]
Показать свойства
status
string
Статус категории:
  • active - категория активна, товары можно создавать
  • disabled - категория отключена, создание товаров запрещено
Допустимые значения
activedisabled
leaf_only
[ "boolean", "null" ]
Только листовые категории
parent_id
[ "string", "null" ]
ID родителя (пусто = корень)
ids
[ "array", "null" ]
Конкретные ID (приоритет над parent_id)
pagination
object
Cursor-пагинация. Первый запрос - без cursor (или пустой). Для получения следующей страницы - передать cursor из ответа (pagination.next_cursor). Если has_next: false - достигнут конец списка.
Показать свойства
cursor
[ "string", "null" ]
Курсор для следующей страницы (opaque-токен, генерируется сервером). Пусто или отсутствие - первая страница.
limit
integer
required
Лимит элементов на странице

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

200Список категорий
application/json
object
categories
array
required
Показать свойства
id
string
required
Уникальный ID категории
name
string
required
Название категории
slug
string
required
URL-слаг
parent_id
[ "string", "null" ]
ID родительской категории (пусто = корень)
leaf
boolean
required
Листовая категория? (можно ли создавать товары здесь)
sort_order
[ "integer", "null" ]
Порядок отображения
icon_url
[ "string", "null" ]
URL иконки категории (опц.)
description
[ "string", "null" ]
Описание категории (опц.)
is_service
[ "boolean", "null" ]
Признак что категория - услуга (не физический товар). Услуги имеют SKU сквозной с товарами.
is_digital
[ "boolean", "null" ]
Признак что категория - цифровой товар (не физический). Цифровые товары не требуют доставки.
status
string
required
Статус категории:
  • active - категория активна, товары можно создавать
  • disabled - категория отключена, создание товаров запрещено
Допустимые значения
activedisabled
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/categories/list
1curl https://api.omninet.ru/v1/categories/list \2  --request POST \3  --header 'Content-Type: application/json' \4  --data '{5  "filter": {6    "status": "active"7  },8  "pagination": {9    "limit": 10010  }11}'
{
  "categories": [
    {
      "id": "cat_qled_tv",
      "name": "QLED телевизоры",
      "slug": "qled-tv",
      "parent_id": "cat_tv",
      "leaf": true,
      "sort_order": null,
      "icon_url": null,
      "description": null,
      "is_service": false,
      "is_digital": false,
      "status": "string"
    }
  ],
  "pagination": {
    "next_cursor": null,
    "has_next": true,
    "total": null
  }
}

Список категорий