Warehouse

INFO

Каждый ответ приходит в общем конверте — code, message, messages, status_code, time — а полезная нагрузка лежит в data. Таблицы ниже описывают содержимое data.

GET /warehouse/get-by-id/{id}

Get warehouse using its _id

Параметры пути

Параметр	Тип	Обязательно	Описание
`id`	`string`	Да

Тело запроса

Тело запроса не требуется.

Ответ

Поле	Тип	Описание
`name`	`string`
`code`	`string`
`is-main`	`boolean`
`status`	`string`	Допустимые значения: `active`, `inactive`
`order_number`	`number`
`note`	`string`
`shape`	`string`	Допустимые значения: `rectangle`, `circular`, `other`
`height`	`number`
`width`	`number`
`length`	`number`
`diameter`	`number`
`volume`	`number`
`address`	`string`
`recommended_temperature`	`number`
`recommended_humidity`	`number`
`coordinates`	`object`
`coordinates.lat`	`number`
`coordinates.long`	`number`
`updated_by`	`string`
`is_default`	`boolean`
`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`
`responsible_employee`	`object`
`responsible_employee._id`	`string`
`responsible_employee.full_name`	`string`
`created_at`	`string (date-time)`
`updated_at`	`string (date-time)`
`organization`	`object`
`organization._id`	`string`
`organization.name`	`string`
`warehouse_type`	`object`
`warehouse_type._id`	`string`
`warehouse_type.name`	`string`
`warehouse_type.order_number`	`number`
`warehouse_type.status`	`string`	Допустимые значения: `active`, `inactive`
`warehouse_type.is_default`	`boolean`

json

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "name": "string",
    "code": "string",
    "is-main": false,
    "status": "active",
    "order_number": 0,
    "note": "string",
    "shape": "rectangle",
    "height": 0,
    "width": 0,
    "length": 0,
    "diameter": 0,
    "volume": 0,
    "address": "string",
    "recommended_temperature": 0,
    "recommended_humidity": 0,
    "coordinates": {
      "lat": 0,
      "long": 0
    },
    "updated_by": "string",
    "is_default": false,
    "updated_by_user": {
      "_id": "string",
      "full_name": "string"
    },
    "created_by_user": {
      "_id": "string",
      "full_name": "string"
    },
    "responsible_employee": {
      "_id": "string",
      "full_name": "string"
    },
    "created_at": "2025-05-01T12:00:00Z",
    "updated_at": "2025-05-01T12:00:00Z",
    "organization": {
      "_id": "string",
      "name": "string"
    },
    "warehouse_type": {
      "_id": "string",
      "name": "string",
      "order_number": 0,
      "status": "active",
      "is_default": false
    }
  },
  "time": "2025-05-01T12:00:00Z"
}

POST /warehouse/get-paging

Get warehouse by paging

Тело запроса

Поле	Тип	Обязательно	Описание
`page`	`number`	Да	По умолчанию: `1`
`limit`	`number`	Да	По умолчанию: `20`
`search`	`string`	Нет
`organization_id`	`string`	Нет
`is_main`	`boolean`	Нет
`status`	`string`	Нет	Допустимые значения: `active`, `inactive`

json

{
  "page": 1,
  "limit": 20,
  "search": "string",
  "organization_id": "64b7f4d9e2b3b6a0b7c5d800",
  "is_main": false,
  "status": "active"
}

Ответ

data.total — общее количество записей, data.data[] — записи текущей страницы. Таблица ниже описывает одну запись.

json

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "total": 0,
    "data": []
  },
  "time": "2025-05-01T12:00:00Z"
}

POST /warehouse/get-all

Get all warehouses

Тело запроса

Поле	Тип	Обязательно	Описание
`page`	`number`	Да	По умолчанию: `1`
`limit`	`number`	Да	По умолчанию: `20`
`search`	`string`	Нет
`organization_id`	`string`	Нет
`is_main`	`boolean`	Нет
`status`	`string`	Нет	Допустимые значения: `active`, `inactive`

json

{
  "page": 1,
  "limit": 20,
  "search": "string",
  "organization_id": "64b7f4d9e2b3b6a0b7c5d800",
  "is_main": false,
  "status": "active"
}

Ответ

json

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": [],
  "time": "2025-05-01T12:00:00Z"
}

GET /warehouse/get-deleted

Get deleted warehouse ids

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

Параметр	Тип	Обязательно	Описание
`deleted_at`	`string`	Да

Тело запроса

Тело запроса не требуется.

Ответ

json

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": [
    "string"
  ],
  "time": "2025-05-01T12:00:00Z"
}

Эта страница сгенерирована из спецификации OpenAPI.

Warehouse ​

GET /warehouse/get-by-id/{id} ​

POST /warehouse/get-paging ​

POST /warehouse/get-all ​

GET /warehouse/get-deleted ​

Warehouse

GET /warehouse/get-by-id/{id}

POST /warehouse/get-paging

POST /warehouse/get-all

GET /warehouse/get-deleted