Содержание

API :: Inventory. Получение документов Инвентаризации

В системе реализован программный интерфейс для получения данных о документах «Инвентаризация». Данные выгружаются по HTTP протоколу. Формат на выбор - XML или JSON.

Пример запроса на получение данных

Глубина запроса по умолчанию - последние 30 дней. Для изменения глубины необходимо использовать параметр days.

Пример запроса на получение данных о документах «Инвентаризация»:

http://mycompany.virtpos.ru/api/inventory?apikey=MySecret&format=xml

Параметры запроса на получение данных

параметры, которые не отмечены как get only, могут быть переданы как get- или как post-параметры.

Ответ сервера

В ответ получаем XML или JSON. В ответе обязательно присутствует поле success. Если success=1, то операция выполнена успешно. Если success=0, то произошла ошибка. Дополнительная информация об ошибке содержится в поле info

Пример ответа сервера

Ниже приведен пример ответа сервера в формате XML 

<?xml version="1.0" encoding="UTF-8"?>
<root>
	<success>1</success>
	<type>inventory</type>
	<days_limit>1000</days_limit>
	<count>4</count>
	<inventories>
		<inventory>
			<id>5</id>
			<warehouse_id>4</warehouse_id>
			<status>INPROGRESS</status>
			<docnum/>
			<docdate>2016-08-24 00:00:00</docdate>
			<comment/>
			<created_date>2016-08-24 17:28:01</created_date>
			<created_by>10</created_by>
			<last_update_date>2016-09-05 14:58:10</last_update_date>
			<last_update_by>2</last_update_by>
			<attribute1/>
			<attribute2/>
			<attribute3/>
			<attribute4/>
			<attribute5/>
			<attribute6/>
			<attribute7/>
			<attribute8/>
			<attribute9/>
			<attribute10/>
			<attribute11/>
			<attribute12/>
			<attribute13/>
			<attribute14/>
			<attribute15/>
			<external_id/>
			<guid>803ad8b6-688c-11e7-849d-74d435ee6043</guid>
			<warehouse_external_id>222</warehouse_external_id>
			<type>G</type>
			<items>
				<item>
					<id>929</id>
					<inventory_id>5</inventory_id>
					<item_id>1</item_id>
					<onhand_id/>
					<quantity_initial/>
					<quantity>15.000</quantity>
					<lot_number/>
					<cogs/>
					<price/>
					<created_date>2017-01-31 13:13:17</created_date>
					<created_by>2</created_by>
					<last_update_date>2017-01-31 13:13:17</last_update_date>
					<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>
					<id>930</id>
					<inventory_id>5</inventory_id>
					<item_id>2</item_id>
					<onhand_id/>
					<quantity_initial/>
					<quantity>9.000</quantity>
					<lot_number/>
					<cogs/>
					<price/>
					<created_date>2017-01-31 13:13:17</created_date>
					<created_by>2</created_by>
					<last_update_date>2017-01-31 13:13:17</last_update_date>
					<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>
			</items>
		</inventory>
	</inventories>
</root>

Структура ответа сервера

Шапка документа

Содержание документа (зависит от настройки загружаемых полей и гибких полей на товарный остаток)