Остатки товаров

Остатки товаров на текущий момент

Для получения остатков товаров на текущий момент времени необходимо использовать API GET /api/item/remains. Поддерживаются следующие параметры фильтрации остатков товаров:

Ключ

Тип

Описание

ids

List[ObjectId]

Список id товаров для отображения

categories

List[str]

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

categories_ne

List[str]

Исключающий список категорий товаров

tags

List[str]

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

units

List[ObjectId]

Список id точек, товары с которых учитываются в остатках

units_ne

List[ObjectId]

Исключающий список точек

API использует стандартную схему пагинации.

Количество записей в одном запросе определяется GET-параметром limit и по-умолчанию равно 20. Для пагинации по списку необходимо использовать параметр offset, определяющий количество пропускаемых записей.

Пример данных:

[
  {
    "id": "5748415a5b3a42700c459eb0",
    "code": null,
    "attributes": {},
    "category": null,
    "name": "Взбитые сливки",
    "unit_name": "гр.",
    "count": 1985.0000,
    "min_count": 0.0000,
    "prime_cost": 0.750000,
    "total_price": 1488.7500000000
  }
]

Выходные данные - сокращенная информация о товаре, дополненная ключами:

Ключ

Значение

count

Количество товара на складе

prime_cost

Средняя стоимость за единицу товара

total_price

Общая стоимость остатков на складе

Альтернативный способ получения остатков

Для получения остатков по определенному складу, а так же для получения остатков на указанный момент времени, можно использовать API /api/item/snapshot/by-unit/<objectid:unit>.

Оно не поддерживает фильтрацию по товарам и в качестве опциональных параметров может принимать только ключ date: datetime для отображения остатков по складу на указанную дату.

Пример данных:

{
  "5748415a5b3a42700c459eb0": {
    "count": -4015.0000,
    "price": 0.7500
  },
  "5a84416b332dff01a97da13d": {
    "count": -50.0000,
    "price": -0.0000
  },
  "5a5e04a3b92f2801fe2fb54d": {
    "count": -23.0000,
    "price": -0.0000
  },
  "5a54d7a2c213aa0922589f41": {
    "count": 15.0000,
    "price": 0.7500
  },
  "5747f887d4c9b00e7fed561a": {
    "count": -40000.0000,
    "price": -0.0000
  },
  "5a5642c0ddbe980021e8fd51": {
    "count": 20000.0000,
    "price": 0.0000
  },
  "5747f593d4c9b00e7fed55c5": {
    "count": -21500.0000,
    "price": -0.0000
  },
  "5747f4ced4c9b00e7fed55a7": {
    "count": 13000.0000,
    "price": 1.2308
  },
  "5a84415f332dff01aac483f3": {
    "count": -5000.0000,
    "price": -0.0000
  },
  "5a93ea6c229ac3000b66d864": {
    "count": 100.0000,
    "price": 0.0000
  }
}

В выходных данных ключ - ID товара, в значении count - количество товара на складе, price - средняя стоимость единицы товара.