Различия

Здесь показаны различия между двумя версиями данной страницы.

--- doc:dev:api:store [02.07.2019 13:50]
dlebedev
+++ doc:dev:api:store [27.10.2025 20:03] (текущий)
rlysov [Параметры запроса на получение данных]
@@ Строка 8: / Строка 8: @@
 Пример запроса на получение данных об остатках товаров:
- http://mycompany.virtpos.ru/api/store?apikey=MySecret&format=xml&warehouseid=1&fields=itemname:article
+ https://[company].myvirtualpos.ru/api/store?apikey=MySecret&format=xml&warehouseid=1&fields=itemname:article
 ==== Параметры запроса на получение данных ====
@@ Строка 33: / Строка 33: @@
     * optionalprices - цены товара по дополнительным прайслистам
     * turnovercalc - оборачиваемость товара, рассчитанная системой
+    * expdate - срок годности товарного остатка
@@ Строка 87: / Строка 88: @@
-====== Изменение данных ======
+===== Получение остатков в разрезе товаров =====
+Альтернативный вариант запроса на получение остатков. В отличие от предыдущего варианта данные группируются не по точкам продаж, а по товарам. Это позволяет запросить остатки одного товара сразу во всех точках продаж:
+ http://mycompany.myvirtualpos.ru/api/store/byItem?apikey=MySecret&format=xml&id=1&from_id=0&total=1&limit=10
+==== Параметры запроса на получение данных ====
+  * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр.
+  * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
+  * **id** - идентификатор товара. Если не указан, то возвращаются данные по всем товарам. Если указан, будут отданы остатки по всем точкам продаж для этого товара
+  * **from_id** - идентификатор товара, начиная с которого надо вернуть данные. Если указан, то возвращаются только те товары, идентификатор которых больше указанного. Используется совместно с параметром limit и total для получения данных пачками
+  * **total** - (bool). Если указано "yes", "true" или "1", то в ответ будет добавлено поле "total" с общим количеством строк данных, соответствующих запросу. Используется совместно с limit для получения общего количества строк
+  * **limit** - максимальное число записей, которые можно вернуть.
+====== Изменение данных ======
 ===== Пример запроса на изменение данных =====
@@ Строка 94: / Строка 110: @@
 Пример запроса на изменение данных об остатках товаров:
- http://mycompany.virtpos.ru/api/store/updateOnhand?apikey=MySecret&format=xml&warehouseid=1&itemid=1&quantity=20
+ https://[company].myvirtualpos.ru/api/store/updateOnhand?apikey=MySecret&format=xml&warehouseid=1&itemid=1&quantity=20
 ==== Параметры запроса на изменение данных ====
@@ Строка 153: / Строка 169: @@
 ==== Получение текущей версии: ====
- http://mycompany.virtpos.ru/api/store/getOnhandVersion?apikey=MySecret&format=xml&ext_warehouseid=1
+ https://[company].myvirtualpos.ru/api/store/getOnhandVersion?apikey=MySecret&format=xml&ext_warehouseid=1
 Параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры.
@@ Строка 163: / Строка 179: @@
 ==== Обнуление необновленных остатков ====
- http://mycompany.virtpos.ru/api/store/setZeroOnhand?apikey=MySecret&format=xml&ext_warehouseid=1
+ https://[company].myvirtualpos.ru/api/store/setZeroOnhand?apikey=MySecret&format=xml&ext_warehouseid=1
 Параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры.