KronclAPI
Мои приложения
Введение
Публичные методы
Аккаунт
Компания
Базовые действия
Хранилище
Тарификация
Участники
Логи
Документы
Поддержка
Персонал (HRM)
Финансы (FM)
Клиенты (CRM)
Склад (WM)
POST Отчёт
Каталог
Категории
GET Список
POST Создать
GET Детали
PATCH Обновить
POST Деактивировать
POST Активировать
Товарные позиции
Склад
Сделки (DM)
Создать приложение
Документация API платформы. Последняя сборка v1.5.30

Категории каталога

Методы для управления категориями товаров и услуг.

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

GET
/companies/{id}/modules/wm/catalog/categories

Возвращает список категорий каталога с пагинацией и фильтрацией.

Структура ответа

RESPONSE_DATA:
application/json
categoriesrequired
array
Категории
Список категорий (Category[])
paginationrequired
array
pagination

Категория

CATEGORY:
application/json
idrequired
string
ID
Уникальный идентификатор категории
namerequired
string
Название
Название категории
commentoptional
string
Комментарий
Комментарий
statusrequired
enum
activeinactive
Статус
Статус
parent_idoptional
string
Родитель
ID родительской категории
metadataoptional
array
Метаданные
Дополнительные данные
created_atrequired
string
Создана
Дата создания (RFC 3339)
updated_atrequired
string
Обновлена
Дата последнего обновления (RFC 3339)

Параметры запроса

GET_CATEGORIES_PARAMS:
application/json
pageoptional
int
Страница
Номер страницы (по умолчанию 1)
limitoptional
int
Лимит
Записей на странице (по умолчанию 20)
statusoptional
enum
activeinactive
Статус
Фильтр по статусу
parent_idoptional
string
ID родителя
Фильтр по родительской категории
searchoptional
string
Поиск
Поиск по названию

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

200
{
    "status": true,
    "message": "Categories retrieved successfully",
    "data": {
        "categories": [
            {
                "id": "e00e8400-e29b-41d4-a716-446655440100",
                "name": "Электроника",
                "comment": "Все виды электроники",
                "status": "active",
                "parent_id": null,
                "metadata": null,
                "created_at": "2026-06-14T12:00:00Z",
                "updated_at": "2026-06-14T12:00:00Z"
            }
        ],
        "pagination": {
            "total": 1,
            "page": 1,
            "limit": 20,
            "pages": 1
        }
    },
    "meta": {
        "timestamp": "2026-06-14T12:00:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/wm/catalog/categories",
        "method": "GET"
    }
}

# Создание категории

POST
/companies/{id}/modules/wm/catalog/categories

Создаёт новую категорию в каталоге.

Структура запроса

CREATE_REQUEST:
application/json
namerequired
string
Название
Название категории
commentoptional
string
Комментарий
Комментарий
parent_idoptional
string
Родитель
ID родительской категории
metadataoptional
array
Метаданные
Дополнительные данные

Структура ответа

CATEGORY:
application/json
idrequired
string
ID
Уникальный идентификатор категории
namerequired
string
Название
Название категории
commentoptional
string
Комментарий
Комментарий
statusrequired
enum
activeinactive
Статус
Статус
parent_idoptional
string
Родитель
ID родительской категории
metadataoptional
array
Метаданные
Дополнительные данные
created_atrequired
string
Создана
Дата создания (RFC 3339)
updated_atrequired
string
Обновлена
Дата последнего обновления (RFC 3339)

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

201
{
    "status": true,
    "message": "Category created successfully",
    "data": {
        "id": "e00e8400-e29b-41d4-a716-446655440101",
        "name": "Ноутбуки",
        "comment": null,
        "status": "active",
        "parent_id": "e00e8400-e29b-41d4-a716-446655440100",
        "metadata": null,
        "created_at": "2026-06-14T12:05:00Z",
        "updated_at": "2026-06-14T12:05:00Z"
    },
    "meta": {
        "timestamp": "2026-06-14T12:05:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/wm/catalog/categories",
        "method": "POST"
    }
}

# Получение категории

GET
/companies/{id}/modules/wm/catalog/categories/{categoryId}

Возвращает информацию о категории.

Структура ответа

CATEGORY:
application/json
idrequired
string
ID
Уникальный идентификатор категории
namerequired
string
Название
Название категории
commentoptional
string
Комментарий
Комментарий
statusrequired
enum
activeinactive
Статус
Статус
parent_idoptional
string
Родитель
ID родительской категории
metadataoptional
array
Метаданные
Дополнительные данные
created_atrequired
string
Создана
Дата создания (RFC 3339)
updated_atrequired
string
Обновлена
Дата последнего обновления (RFC 3339)

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

200
{
    "status": true,
    "message": "Category retrieved successfully",
    "data": {
        "id": "e00e8400-e29b-41d4-a716-446655440100",
        "name": "Электроника",
        "comment": "Все виды электроники",
        "status": "active",
        "parent_id": null,
        "metadata": null,
        "created_at": "2026-06-14T12:00:00Z",
        "updated_at": "2026-06-14T12:00:00Z"
    },
    "meta": {
        "timestamp": "2026-06-14T12:00:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/wm/catalog/categories/...",
        "method": "GET"
    }
}

# Обновление категории

PATCH
/companies/{id}/modules/wm/catalog/categories/{categoryId}

Обновляет данные категории.

Структура запроса

UPDATE_REQUEST:
application/json
nameoptional
string
Название
Название категории
commentoptional
string
Комментарий
Комментарий
parent_idoptional
string
Родитель
ID родительской категории
statusoptional
enum
activeinactive
Статус
Статус
metadataoptional
array
Метаданные
Дополнительные данные

Структура ответа

CATEGORY:
application/json
idrequired
string
ID
Уникальный идентификатор категории
namerequired
string
Название
Название категории
commentoptional
string
Комментарий
Комментарий
statusrequired
enum
activeinactive
Статус
Статус
parent_idoptional
string
Родитель
ID родительской категории
metadataoptional
array
Метаданные
Дополнительные данные
created_atrequired
string
Создана
Дата создания (RFC 3339)
updated_atrequired
string
Обновлена
Дата последнего обновления (RFC 3339)

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

200
{
    "status": true,
    "message": "Category updated successfully",
    "data": {
        "id": "e00e8400-e29b-41d4-a716-446655440101",
        "name": "Ноутбуки и планшеты",
        "comment": "Портативные устройства",
        "status": "active",
        "parent_id": "e00e8400-e29b-41d4-a716-446655440100",
        "metadata": null,
        "created_at": "2026-06-14T12:05:00Z",
        "updated_at": "2026-06-14T12:10:00Z"
    },
    "meta": {
        "timestamp": "2026-06-14T12:10:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/wm/catalog/categories/...",
        "method": "PATCH"
    }
}

# Деактивация категории

POST
/companies/{id}/modules/wm/catalog/categories/{categoryId}/deactivate

Деактивирует категорию.

Структура ответа

CATEGORY:
application/json
idrequired
string
ID
Уникальный идентификатор категории
namerequired
string
Название
Название категории
commentoptional
string
Комментарий
Комментарий
statusrequired
enum
activeinactive
Статус
Статус
parent_idoptional
string
Родитель
ID родительской категории
metadataoptional
array
Метаданные
Дополнительные данные
created_atrequired
string
Создана
Дата создания (RFC 3339)
updated_atrequired
string
Обновлена
Дата последнего обновления (RFC 3339)

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

200
{
    "status": true,
    "message": "Category deactivated successfully",
    "data": {
        "id": "e00e8400-e29b-41d4-a716-446655440101",
        "name": "Ноутбуки и планшеты",
        "comment": "Портативные устройства",
        "status": "inactive",
        "parent_id": "e00e8400-e29b-41d4-a716-446655440100",
        "metadata": null,
        "created_at": "2026-06-14T12:05:00Z",
        "updated_at": "2026-06-14T12:15:00Z"
    },
    "meta": {
        "timestamp": "2026-06-14T12:15:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/wm/catalog/categories/.../deactivate",
        "method": "POST"
    }
}

# Активация категории

POST
/companies/{id}/modules/wm/catalog/categories/{categoryId}/activate

Активирует деактивированную категорию.

Структура ответа

CATEGORY:
application/json
idrequired
string
ID
Уникальный идентификатор категории
namerequired
string
Название
Название категории
commentoptional
string
Комментарий
Комментарий
statusrequired
enum
activeinactive
Статус
Статус
parent_idoptional
string
Родитель
ID родительской категории
metadataoptional
array
Метаданные
Дополнительные данные
created_atrequired
string
Создана
Дата создания (RFC 3339)
updated_atrequired
string
Обновлена
Дата последнего обновления (RFC 3339)

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

200
{
    "status": true,
    "message": "Category activated successfully",
    "data": {
        "id": "e00e8400-e29b-41d4-a716-446655440101",
        "name": "Ноутбуки и планшеты",
        "comment": "Портативные устройства",
        "status": "active",
        "parent_id": "e00e8400-e29b-41d4-a716-446655440100",
        "metadata": null,
        "created_at": "2026-06-14T12:05:00Z",
        "updated_at": "2026-06-14T12:20:00Z"
    },
    "meta": {
        "timestamp": "2026-06-14T12:20:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/wm/catalog/categories/.../activate",
        "method": "POST"
    }
}