Различия
Здесь показаны различия между двумя версиями данной страницы.
Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия Следующая версия Следующая версия справа и слева | ||
doc:dev:api:store [02.04.2019 12:32] esadin [Пример ответа сервера] |
doc:dev:api:store [15.05.2020 19:22] rlysov |
||
---|---|---|---|
Строка 32: | Строка 32: | ||
* price - цена продажи по основному прайслисту | * price - цена продажи по основному прайслисту | ||
* optionalprices - цены товара по дополнительным прайслистам | * optionalprices - цены товара по дополнительным прайслистам | ||
+ | * turnovercalc - оборачиваемость товара, рассчитанная системой | ||
Строка 38: | Строка 39: | ||
В ответ получаем XML или JSON. В ответе обязательно присутствует поле success. Если success=1, то операция выполнена успешно. Если success=0, то произошла ошибка. Дополнительная информация об ошибке содержится в поле info | В ответ получаем XML или JSON. В ответе обязательно присутствует поле success. Если success=1, то операция выполнена успешно. Если success=0, то произошла ошибка. Дополнительная информация об ошибке содержится в поле info | ||
+ | * quantity - текущее количество товара | ||
+ | * available_quantity - количество товара с учетом резервов | ||
==== Пример ответа сервера ==== | ==== Пример ответа сервера ==== | ||
Строка 85: | Строка 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** - максимальное число записей, которые можно вернуть. | ||
+ | |||
+ | ====== Изменение данных ====== | ||
===== Пример запроса на изменение данных ===== | ===== Пример запроса на изменение данных ===== |