====== API :: Movegood. Получение документов "Перемещение" ======

В системе реализован программный интерфейс для получения данных о документах "Перемещение". Данные выгружаются по http протоколу. Формат на выбор - xml или json.

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

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

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

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

==== Параметры запроса на получение данных ====
параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры.
  * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр.

  * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.

  * **cdate** - получение Перемещений на определенную дату. Формат: ГГГГММДД. Необязательный параметр.

  * **cdatefrom** - получение Перемещений начиная с определенной даты. Формат: ГГГГММДД. Необязательный параметр.

  * **cdateto** - получение Перемещений начиная до определенной даты. Формат: ГГГГММДД. Необязательный параметр.

  * **last_update_date** - получение Перемещений, обновленных начиная с определенной даты. Формат: ГГГГММДД. Необязательный параметр.

  * **warehouse_id** - код магазина. для которого надо вернуть Перемещения. Если не указан, то возвращаются Перемещения для всех магазинов. Необязательный параметр.

  * **ext_warehouse_id** - код магазина во внешней системе (например, в 1С). Параметр игнорируется, если передан warehouse_id. Необязательный параметр.

  * **id** - ID документа Перемещения. Необязательный параметр. Если не указан, возвращаются все документы.

  * **last_id** - Необязательный параметр. Используется для получения новых документов с момента последнего обмена. Если параметр указан, то передаются все более новые Перемещения (с бОльшим ID)

  * **days** - задает глубину поиска. Определяет, за какое количество дней от текущей даты надо вернуть документы Перемещения. Необязательный параметр.

  * **withitems** - принимает значение "1" или "0". Если "1", то возвращает строки Перемещения, иначе только "шапки" Перемещений.

  * **withattributes** - принимает значение "1" или "0". Если "1", то возвращает данные гибких полей для Перемещения.
==== Ответ сервера ====

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

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

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

<file xml>
<?xml version="1.0" encoding="UTF-8"?>
<root>
	<success>1</success>
	<type>movegood</type>
	<days_limit>30</days_limit>
	<count>1</count>
	<movegoods>
		<movegood>
			<id>6</id>
			<src_warehouse_id>6</src_warehouse_id>
			<src_warehouse_ext_id>13</src_warehouse_ext_id>
			<dst_warehouse_id>14</dst_warehouse_id>
			<dst_warehouse_ext_id/>
			<amount>1208.86</amount>
			<status>accept</status>
			<status_name>Принят</status_name>
			<comment/>
			<created_date>2016-12-08 17:06:04</created_date>
			<created_by>15</created_by>
			<last_update_date>2016-12-08 17:08:46</last_update_date>
			<last_update_by>15</last_update_by>
			<items>
				<item>
					<line_id>100</line_id>
					<item_id>431</item_id>
					<item_ext_id/>
					<item_name>Открытка с шоколадом</item_name>
					<quantity>68.000</quantity>
					<quantity_expected>68.000</quantity_expected>
					<barcode/>
					<price>65.0000</price>
					<amount>4420.00</amount>
					<manuf_date/>
					<expir_date/>
					<lot_number/>
				</item>
				<item>
					<line_id>101</line_id>
					<item_id>668</item_id>
					<item_ext_id/>
					<item_name>Шоколад "Большой набор"</item_name>
					<quantity>1.000</quantity>
					<quantity_expected>1.000</quantity_expected>
					<barcode/>
					<price>125.0000</price>
					<amount>125.00</amount>
					<manuf_date/>
					<expir_date/>
					<lot_number/>
				</item>
			</items>
		</movegood>
	</movegoods>
</root>    
</file>


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

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

  * **id** - ID документа Перемещение

  * **src_warehouse_id** - код склада, с которого перемещается товар

  * **src_warehouse_ext_id** - код склада во внешней системе, с которого перемещается товар

  * **dst_warehouse_id** - код склада, на который перемещается товар
  
  * **dst_warehouse_ext_id** - код склада во внешней системе, на который перемещается товар

  * **amount** - сумма перемещения

  * **status** - код статуса документа
  
  * **status_name** - статус документа

  * **created_date** - дата создания документа Перемещения

  * **created_by** - ID пользователя, создавшего перемещение

  * **last_update_date** - дата и время последнего изменения в перемещении

  * **last_update_by** - ID пользователя, сделавшего последние изменения


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

  * **line_id** - сквозной ID строки в транзакциях перемещений

  * **item_id** - ID товарной позиции по номенклатурному справочнику

  * **item_name** - наименование позиции

  * **quantity** - количество

  * **barcode** - штрих-код по накладной перемещения

  * **price** - себестоимость товара в перемещении

  * **amount** - сумма по строке

  * **lot_number** - характеристика (серия, партия и пр) позиции в перемещении
  
  * **manuf_date** - дата производства
  
  * **expir_date** - срок годности товара