Различия

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

--- doc:dev:api:store [01.09.2017 14:29]
mzubkov [Получение текущей версии:]
+++ doc:dev:api:store [23.10.2020 16:09] (текущий)
sshevchuk [Получение остатков в разрезе товаров]
@@ Строка 32: / Строка 32: @@
     * price - цена продажи по основному прайслисту
     * optionalprices - цены товара по дополнительным прайслистам
+    * turnovercalc - оборачиваемость товара, рассчитанная системой
@@ Строка 38: / Строка 39: @@
 В ответ получаем XML или JSON. В ответе обязательно присутствует поле success. Если success=1, то операция выполнена успешно. Если success=0, то произошла ошибка. Дополнительная информация об ошибке содержится в поле info
+  * quantity - текущее количество товара
+  * available_quantity - количество товара с учетом резервов
 ==== Пример ответа сервера ====
@@ Строка 59: / Строка 61: @@
                 <item>
                     <id>17007</id>
-                    <quantity>1.000</quantity>
+                    <quantity>2.000</quantity>
+                    <available_quantity>1.000</available_quantity>
+                    <lot_number>12345</lot_number>
                     <name>63838 Корм для собак 2кг</name>
                     <article>63838</article>
@@ Строка 83: / Строка 87: @@
-====== Изменение данных ======
+===== Получение остатков в разрезе товаров =====
+Альтернативный вариант запроса на получение остатков. В отличие от предыдущего варианта данные группируются не по точкам продаж, а по товарам. Это позволяет запросить остатки одного товара сразу во всех точках продаж:
+ 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** - максимальное число записей, которые можно вернуть.
+====== Изменение данных ======
 ===== Пример запроса на изменение данных =====
@@ Строка 160: / Строка 179: @@
  http://mycompany.virtpos.ru/api/store/setZeroOnhand?apikey=MySecret&format=xml&ext_warehouseid=1
+Параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры.
 Параметры:
-  * int **version** - версия, полученная с помощью функции getOnhandVersion
+  * int **version** (get only) - версия, полученная с помощью функции getOnhandVersion
-  * int **warehouseid** - ID склада в ВиП, для которого надо обнулить остатки
+  * int **warehouseid** (get only) - ID склада в ВиП, для которого надо обнулить остатки
-  * string **ext_warehouseid** - Внешний ID склада,  для которого надо обнулить остатки
+  * string **ext_warehouseid** (get only) - Внешний ID склада,  для которого надо обнулить остатки