Категории

5 статьи Максим От Максим

Категории

Категории: группировка материалов, продуктов и ресурсов. У каждого из трех типов свой независимый список категорий. Через API категории можно получать, создавать, переименовывать, удалять и назначать позициям. Пути методов указаны относительно базового адреса API, а общие для всех методов правила (авторизация, формат запросов, частичное редактирование, постраничная выдача) описаны в статьях Обзор API и Общие правила. Методы | Метод | Что делает | |---|---| | v1/categories/get_list | Возвращает категории материалов, продуктов или ресурсов | | v1/categories/add | Создает категорию | | v1/categories/edit | Переименовывает категорию | | v1/categories/delete | Удаляет категорию |

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

Возвращает категории материалов, продуктов или ресурсов в том порядке, в каком они идут в Controlata. v1/categories/get_list.php Параметры | Поле | Тип | Обязательное | Описание | |---|---|---|---| | type | string | Да | Чьи категории: «materials», «products» или «resources» | Пример запроса { "type": "materials" } Пример ответа { "success": true, "categories": [ { "id": 12, "name": "Древесина" }, { "id": 13, "name": "Фурнитура" } ] } Ошибки | Ошибка | Причина | |---|---| | No type in input | Не передан type | | Invalid type value. Must be one of: materials, products, resources | Неверный type |

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

Создает категорию материалов, продуктов или ресурсов. v1/categories/add.php Параметры | Поле | Тип | Обязательное | Описание | |---|---|---|---| | type | string | Да | Чья категория: «materials», «products» или «resources» | | name | string | Да | Название | Новая категория встает в конец списка категорий этого типа. Создавать категорию заранее не обязательно. В поле categories методов v1/materials/add, v1/materials/edit, v1/products/add, v1/products/edit, v1/resources/add и v1/resources/edit категорию можно передать объектом { name: ... } без id: если категории с таким названием еще нет, она создастся сама, а если есть, будет использована существующая. Пример запроса { "type": "materials", "name": "Древесина" } Пример ответа { "success": true, "category_id": 14 } Ошибки | Ошибка | Причина | |---|---| | No type in input | Не передан type | | Invalid type value. Must be one of: materials, products, resources | Неверный type | | No name in input | Не передан name | | Name must not be empty | Пустое название | | Name must be a string | name не строка | | name is too long: maximum 200 characters | Название длиннее 200 символов |

Редактирование категории

Переименовывает категорию материалов, продуктов или ресурсов. Меняется только название, позиции остаются в категории. v1/categories/edit.php Параметры | Поле | Тип | Обязательное | Описание | |---|---|---|---| | type | string | Да | Чья категория: «materials», «products» или «resources» | | category_id | int | Да | ID категории | | name | string | Да | Новое название | Пример запроса { "type": "materials", "category_id": 14, "name": "Массив дерева" } Пример ответа { "success": true } Ошибки | Ошибка | Причина | |---|---| | No type in input | Не передан type | | Invalid type value. Must be one of: materials, products, resources | Неверный type | | No category_id in input | Не передан category_id (так же для name) | | Category not found or access denied | Категории с таким ID нет среди категорий этого типа | | Name must not be empty | Пустое название | | Name must be a string | name не строка | | name is too long: maximum 200 characters | Название длиннее 200 символов |

Удаление категории

Удаляет категорию материалов, продуктов или ресурсов. v1/categories/delete.php Параметры | Поле | Тип | Обязательное | Описание | |---|---|---|---| | type | string | Да | Чья категория: «materials», «products» или «resources» | | category_id | int | Да | ID категории | Удаление нельзя отменить. Позиции остаются, но категория снимается с них. Категорию, выбранную в настройках склада, удалить нельзя: сначала уберите ее из настроек склада. Пример запроса { "type": "materials", "category_id": 14 } Пример ответа { "success": true } Ошибки | Ошибка | Причина | |---|---| | No type in input | Не передан type | | Invalid type value. Must be one of: materials, products, resources | Неверный type | | No category_id in input | Не передан category_id | | Category not found or access denied | Категории с таким ID нет среди категорий этого типа или она уже удалена | | The category is used in storage location settings and cannot be deleted | Категория выбрана в настройках склада |