Box types
INFO
Каждый ответ приходит в общем конверте — code, message, messages, status_code, time — а полезная нагрузка лежит в data. Таблицы ниже описывают содержимое data.
POST /box-types/create
This method allows adding box-types into the account.
Тело запроса
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
name | string | Да | |
short_name | string | Нет | |
code | string | Нет | |
status | string | Нет | Допустимые значения: active, inactive. По умолчанию: "active" |
{
"name": "string",
"short_name": "string",
"code": "string",
"status": "active"
}Ответ
| Поле | Тип | Описание |
|---|---|---|
name | string | |
code | string | |
short_name | string | |
status | string | Допустимые значения: active, inactive |
{
"code": 0,
"message": "Success",
"status_code": 200,
"data": {
"name": "string",
"code": "string",
"short_name": "string",
"status": "active"
},
"time": "2025-05-01T12:00:00Z"
}PUT /box-types/update
This method allows updating box-types in the account.
Тело запроса
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
_id | string | Нет | |
name | string | Да | |
short_name | string | Нет | |
code | string | Нет | |
status | string | Нет | Допустимые значения: active, inactive. По умолчанию: "active" |
{
"_id": "67b486d242ed76693cd2cc59",
"name": "string",
"short_name": "string",
"code": "string",
"status": "active"
}Ответ
Структура ответа совпадает с POST /box-types/create.
DELETE /box-types/delete/{id}
Delete a box-types
Параметры пути
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
id | string | Да |
Тело запроса
Тело запроса не требуется.
Ответ
{
"code": 0,
"message": "Success",
"status_code": 200,
"data": "ok",
"time": "2025-05-01T12:00:00Z"
}GET /box-types/get-all
Get all box-typess
Параметры запроса
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
search | string | Нет | Search box-types |
Тело запроса
Тело запроса не требуется.
Ответ
{
"code": 0,
"message": "Success",
"status_code": 200,
"data": [
{
"name": "string",
"code": "string",
"short_name": "string",
"status": "active"
}
],
"time": "2025-05-01T12:00:00Z"
}GET /box-types/get-by-id/{id}
Get box-types using its _id
Параметры пути
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
id | string | Да |
Тело запроса
Тело запроса не требуется.
Ответ
Структура ответа совпадает с POST /box-types/create.
GET /box-types/get-deleted
Get deleted box-types ids
Параметры запроса
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
deleted_at | string | Да |
Тело запроса
Тело запроса не требуется.
Ответ
{
"code": 0,
"message": "Success",
"status_code": 200,
"data": [
"string"
],
"time": "2025-05-01T12:00:00Z"
}POST /box-types/get-paging
Get box-types by paging
Тело запроса
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
page | number | Да | По умолчанию: 1 |
limit | number | Да | По умолчанию: 20 |
search | string | Нет | |
name | string | Нет | |
short_name | string | Нет | |
code | string | Нет | |
status | string | Нет | Допустимые значения: active, inactive |
{
"page": 1,
"limit": 20,
"search": "string",
"name": "string",
"short_name": "string",
"code": "string",
"status": "active"
}Ответ
data.total — общее количество записей, data.data[] — записи текущей страницы. Таблица ниже описывает одну запись.
| Поле | Тип | Описание |
|---|---|---|
name | string | |
code | string | |
short_name | string | |
status | string | Допустимые значения: active, inactive |
updated_by_user | object | |
updated_by_user._id | string | |
updated_by_user.full_name | string | |
created_by_user | object | |
created_by_user._id | string | |
created_by_user.full_name | string | |
created_at | string (date-time) | |
updated_at | string (date-time) | |
is_default | boolean |
{
"code": 0,
"message": "Success",
"status_code": 200,
"data": {
"total": 0,
"data": [
{
"name": "string",
"code": "string",
"short_name": "string",
"status": "active",
"updated_by_user": {
"_id": "string",
"full_name": "string"
},
"created_by_user": {
"_id": "string",
"full_name": "string"
},
"created_at": "2025-05-01T12:00:00Z",
"updated_at": "2025-05-01T12:00:00Z",
"is_default": false
}
]
},
"time": "2025-05-01T12:00:00Z"
}Эта страница сгенерирована из спецификации OpenAPI.