Category
INFO
Каждый ответ приходит в общем конверте — code, message, messages, status_code, time — а полезная нагрузка лежит в data. Таблицы ниже описывают содержимое data.
POST /category/create
This method allows adding category into the account.
Тело запроса
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
name | string | Да | |
type | string | Нет | type categories. Допустимые значения: product, material, semi_product |
parent_id | string | Нет | id of parent category |
is_available_for_sale | boolean | Да | is available for sale. По умолчанию: true |
organization_ids | string[] | Да | ids of organization |
image | string | Нет | image path of category that uploaded to the server |
{
"name": "string",
"type": "product",
"parent_id": "string",
"is_available_for_sale": true,
"organization_ids": [
"string"
],
"image": "string"
}Ответ
| Поле | Тип | Описание |
|---|---|---|
_id | string | id of category |
name | string | |
is_main_material | boolean | |
is_available_for_sale | boolean | |
type | string | |
parent_id | string | id of parent category |
organization_ids | string[] | ids of organizations |
child_cound | number | |
item_count | number | count off all child |
count | number | |
image | string |
{
"code": 0,
"message": "Success",
"status_code": 200,
"data": {
"_id": "string",
"name": "string",
"is_main_material": false,
"is_available_for_sale": false,
"type": "string",
"parent_id": "string",
"organization_ids": [
"string"
],
"child_cound": 0,
"item_count": 0,
"count": 0,
"image": "string"
},
"time": "2025-05-01T12:00:00Z"
}PUT /category/update
This method allows updating category in the account.
Тело запроса
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
name | string | Да | |
type | string | Нет | type categories. Допустимые значения: product, material, semi_product |
parent_id | string | Нет | id of parent category |
is_available_for_sale | boolean | Да | is available for sale. По умолчанию: true |
organization_ids | string[] | Да | ids of organization |
image | string | Нет | image path of category that uploaded to the server |
_id | string | Да | id of category |
{
"name": "string",
"type": "product",
"parent_id": "string",
"is_available_for_sale": true,
"organization_ids": [
"string"
],
"image": "string",
"_id": "string"
}Ответ
Структура ответа совпадает с POST /category/create.
DELETE /category/delete/{id}
Delete a category
Параметры пути
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
id | string | Да |
Тело запроса
Тело запроса не требуется.
Ответ
{
"code": 0,
"message": "Success",
"status_code": 200,
"data": "ok",
"time": "2025-05-01T12:00:00Z"
}GET /category/get-by-id/{id}
Get category using its _id
Параметры пути
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
id | string | Да |
Тело запроса
Тело запроса не требуется.
Ответ
Структура ответа совпадает с POST /category/create.
POST /category/get-paging
Get categories by paging
Тело запроса
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
page | number | Да | По умолчанию: 1 |
limit | number | Да | По умолчанию: 20 |
search | string | Нет | |
top | boolean | Нет | |
updated_at | string (date-time) | Нет | |
organization_id | string | Нет | |
parent_id | string | Нет |
{
"page": 1,
"limit": 20,
"search": "string",
"top": false,
"updated_at": "2023-10-01T12:00:00Z",
"organization_id": "64b7f4d9e2b3b6a0b7c5d800",
"parent_id": "63f8b0c4e4b0d3a2f8e4b0c4"
}Ответ
data.total — общее количество записей, data.data[] — записи текущей страницы. Таблица ниже описывает одну запись.
| Поле | Тип | Описание |
|---|---|---|
_id | string | id of category |
name | string | |
is_main_material | boolean | |
is_available_for_sale | boolean | |
type | string | |
parent_id | string | id of parent category |
organization_ids | string[] | ids of organizations |
child_cound | number | |
item_count | number | count off all child |
count | number | |
image | string |
{
"code": 0,
"message": "Success",
"status_code": 200,
"data": {
"total": 0,
"data": [
{
"_id": "string",
"name": "string",
"is_main_material": false,
"is_available_for_sale": false,
"type": "string",
"parent_id": "string",
"organization_ids": [
"string"
],
"child_cound": 0,
"item_count": 0,
"count": 0,
"image": "string"
}
]
},
"time": "2025-05-01T12:00:00Z"
}GET /category/get-deleted
Get deleted category ids
Параметры запроса
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
deleted_at | string | Да |
Тело запроса
Тело запроса не требуется.
Ответ
{
"code": 0,
"message": "Success",
"status_code": 200,
"data": [
"string"
],
"time": "2025-05-01T12:00:00Z"
}GET /category/get-by-name
Get a category by its exact name.
Параметры запроса
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
name | string | Да |
Тело запроса
Тело запроса не требуется.
Ответ
Структура ответа совпадает с POST /category/create.
Эта страница сгенерирована из спецификации OpenAPI.