Различия
Здесь показаны различия между двумя версиями данной страницы.
| Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
|
doc:dev:api:inventory [17.07.2017 12:35] akoptelov [Структура ответа сервера] |
doc:dev:api:inventory [22.10.2025 12:05] (текущий) rlysov [Пример запроса на получение данных] |
||
|---|---|---|---|
| Строка 9: | Строка 9: | ||
| Пример запроса на получение данных о документах "Инвентаризация": | Пример запроса на получение данных о документах "Инвентаризация": | ||
| - | http://mycompany.virtpos.ru/api/inventory?apikey=MySecret&format=xml | + | https://[company].myvirtualpos.ru/api/inventory?apikey=MySecret&format=xml |
| ==== Параметры запроса на получение данных ==== | ==== Параметры запроса на получение данных ==== | ||
| + | параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры. | ||
| * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. | * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. | ||
| - | * **format** - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. | + | * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. |
| * **date** - получение инвентаризаций на определенную дату. Формат: ГГГГММДД. Необязательный параметр. | * **date** - получение инвентаризаций на определенную дату. Формат: ГГГГММДД. Необязательный параметр. | ||
| Строка 37: | Строка 37: | ||
| * **last_id** - Необязательный параметр. Используется для получения новых документов с момента последнего обмена. Если параметр указан, то передаются все более новые инвентаризации (с бОльшим ID) | * **last_id** - Необязательный параметр. Используется для получения новых документов с момента последнего обмена. Если параметр указан, то передаются все более новые инвентаризации (с бОльшим ID) | ||
| - | * **days** - задает глубину поиска. Определяет, за какое количество дней от текущей даты надо вернуть документы списаний. Необязательный параметр. | + | * **days** - задает глубину поиска. Определяет, за какое количество дней от текущей даты надо вернуть документы инвентаризаций. Если указан 0 - выгружается весь список. Необязательный параметр. |
| * **withitems** - принимает значение "1" или "0". Если "1", то возвращает строки списания, иначе только "шапки" списаний. | * **withitems** - принимает значение "1" или "0". Если "1", то возвращает строки списания, иначе только "шапки" списаний. | ||