Различия
Здесь показаны различия между двумя версиями данной страницы.
| Следующая версия | Предыдущая версия | ||
|
doc:dev:api:inventory [27.06.2017 13:10] dchuprunov создано |
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", то возвращает строки списания, иначе только "шапки" списаний. | ||
| Строка 84: | Строка 84: | ||
| <attribute15/> | <attribute15/> | ||
| <external_id/> | <external_id/> | ||
| + | <guid>803ad8b6-688c-11e7-849d-74d435ee6043</guid> | ||
| <warehouse_external_id>222</warehouse_external_id> | <warehouse_external_id>222</warehouse_external_id> | ||
| + | <type>G</type> | ||
| <items> | <items> | ||
| <item> | <item> | ||
| Строка 100: | Строка 102: | ||
| <last_update_date>2017-01-31 13:13:17</last_update_date> | <last_update_date>2017-01-31 13:13:17</last_update_date> | ||
| <last_update_by>2</last_update_by> | <last_update_by>2</last_update_by> | ||
| + | <guid>803ad8b6-688c-11e7-849d-74d435ee6043</guid> | ||
| + | <item_external_id/> | ||
| + | <item_name>Оливки черные Acorsa без косточки 350 г жест. банка</item_name> | ||
| + | <state>Не обработана</state> | ||
| </item> | </item> | ||
| <item> | <item> | ||
| Строка 115: | Строка 121: | ||
| <last_update_date>2017-01-31 13:13:17</last_update_date> | <last_update_date>2017-01-31 13:13:17</last_update_date> | ||
| <last_update_by>2</last_update_by> | <last_update_by>2</last_update_by> | ||
| + | <guid>803ad8b6-688c-11e7-849d-74d435ee6043</guid> | ||
| + | <item_external_id/> | ||
| + | <item_name>Чипсы картофельные Lay's Золотистые с солью 8г</item_name> | ||
| + | <state>Не обработана</state> | ||
| </item> | </item> | ||
| </items> | </items> | ||
| Строка 148: | Строка 158: | ||
| * **external_id** - код Поступления во внешней системе (например, в 1С) | * **external_id** - код Поступления во внешней системе (например, в 1С) | ||
| + | |||
| + | * **type** - тип инвентаризации (G - инвентаризация товаров, M - инвентаризация материальных ценностей) | ||
| * **comment** - комментарий | * **comment** - комментарий | ||
| + | |||
| + | * **guid** - GUID документа | ||
| Строка 181: | Строка 195: | ||
| * **last_update_by** - ID пользователя, сделавшего последние изменения | * **last_update_by** - ID пользователя, сделавшего последние изменения | ||
| + | |||
| + | * **guid** - GUID строки | ||
| * **item_name** - наименование позиции | * **item_name** - наименование позиции | ||
| * **state** - состояние строки ("Не обработана", "Излишек", "Недостача", "Ровно") | * **state** - состояние строки ("Не обработана", "Излишек", "Недостача", "Ровно") | ||