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

Методы для работы с остатками товаров на точках продаж: получение остатков по точкам продаж и по товарам, установка остатков одиночно и пачкой, обнуление остатков, которые не были обновлены при полной загрузке.

GET https://[компания].myvirtualpos.ru/api/store?apikey=MySecret&warehouseid=6&limit=1000&fields=itemname:price

Остатки возвращаются по возрастанию ид записи остатка. Если точка продаж с указанным warehouseid не найдена, вернётся ошибка Data not found. Точки продаж без подходящих остатков в ответ не попадают.

Если указано неизвестное поле, метод вернёт ошибку со списком допустимых значений.

Остаток (item)

{
  "success": 1,
  "type": "store",
  "stockonly": true,
  "total": 6034,
  "record_count": 2,
  "count": 1,
  "last_id": 13027,
  "warehouses": [
    {
      "warehouse": {
        "id": 6,
        "name": "Точка на Тверской",
        "count": 2,
        "items": [
          { "item": { "id": 1084, "quantity": "2.000", "lot_number": "", "available_quantity": 2, "name": "Форма для наращивания", "price": "499.00" } },
          { "item": { "id": 795, "quantity": "65.000", "lot_number": "", "available_quantity": 65, "name": "Форма многоразовая", "price": "100.00" } }
        ]
      }
    }
  ]
}

Тот же ответ при format=xml (сокращённо):

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <success>1</success>
  <type>store</type>
  <stockonly>1</stockonly>
  <total>6034</total>
  <record_count>2</record_count>
  <count>1</count>
  <last_id>13027</last_id>
  <warehouses>
    <warehouse>
      <id>6</id>
      <name>Точка на Тверской</name>
      <count>2</count>
      <items>
        <item><id>1084</id><quantity>2.000</quantity><lot_number/><available_quantity>2</available_quantity></item>
      </items>
    </warehouse>
  </warehouses>
</root>

GET https://[компания].myvirtualpos.ru/api/store/stock?apikey=MySecret&id=795

Ответ содержит:

Возвращаются только положительные остатки. Если товар не найден, придёт ошибка Item not found.

GET https://[компания].myvirtualpos.ru/api/store/byItem?apikey=MySecret&limit=1000&from_id=0&total=1

Компактная выгрузка «товар — остатки по всем точкам»: одна запись на товар.

{
  "success": 1,
  "type": "store_by_item",
  "last_id": 54,
  "count": 3,
  "total": 27168,
  "items": [
    { "id": 52, "quantities": "2=1;3=0;4=0;6=0" },
    { "id": 53, "quantities": "2=1;3=1;4=0;6=0" }
  ]
}

Поле quantities содержит остатки по точкам продаж в виде ид_точки=количество через точку с запятой: от количества вычтено зарезервированное. Товары возвращаются по возрастанию ид; last_id используйте как from_id в следующем запросе.

GET https://[компания].myvirtualpos.ru/api/store/updateOnhand?apikey=MySecret&warehouseid=6&itemid=52&quantity=20&cogs=125.5&lot_number=L1

Если остатка для такой пары нет, он создаётся. Остатки комплектов через API менять нельзя.

{"success":1,"id":"171587","itemid":38334,"lot_number":"L1","warehouseid":15,"isnew":"1","quantity_before":0}

POST https://[компания].myvirtualpos.ru/api/store/multipleUpdateOnhand?apikey=MySecret
data=[{"warehouseid":6,"itemid":52,"quantity":20},{"ext_warehouseid":"WH-6","ext_itemid":"SKU-53","quantity":5,"lot_number":"L1"}]

Параметр data — JSON-массив. Каждый элемент содержит warehouseid или ext_warehouseid, itemid или ext_itemid и поля остатка, как в методе updateOnhand. Элементы обрабатываются независимо.

Пара методов позволяет выгружать остатки «полным срезом»: после загрузки всех остатков точки нулевыми становятся те, которых в срезе не было.

1. Перед загрузкой запросите версию остатков точки продаж методом getOnhandVersion.
2. Загрузите остатки методами updateOnhand или multipleUpdateOnhand.
3. Вызовите setZeroOnhand с сохранённой версией: остатки точки, которые не обновлялись после этой версии, будут обнулены.

GET https://[компания].myvirtualpos.ru/api/store/getOnhandVersion?apikey=MySecret&warehouseid=6
GET https://[компания].myvirtualpos.ru/api/store/setZeroOnhand?apikey=MySecret&warehouseid=6&version=1790417774.000000

Ответы: {«success»:1,«version»:«1790417774.000000»} для getOnhandVersion и {«success»:1,«affected»:4} для setZeroOnhand, где affected — количество обнулённых остатков.

Ошибка авторизации и общие ошибки описаны в статье Общие сведения. Ошибки приходят с кодом HTTP 200 и success равным 0: