Различия
Здесь показаны различия между двумя версиями данной страницы.
doc:dev:api:returns [22.08.2017 18:01] mzubkov [Параметры запроса на получение данных] - last_update_date |
doc:dev:api:returns [02.06.2018 10:42] |
||
---|---|---|---|
Строка 1: | Строка 1: | ||
- | ====== API :: Returns. Получение документов "Возврат поставщику" ====== | ||
- | |||
- | В системе реализован программный интерфейс для получения данных о документах "Возврат поставщику" (далее Возврат). Данные выгружаются по http(s) протоколу. Формат на выбор - xml или json. | ||
- | |||
- | Глубина запроса по умолчанию - последние 30 дней. Для изменения глубины необходимо использовать параметр **days**. | ||
- | |||
- | ===== Пример запроса на получение данных ===== | ||
- | |||
- | Пример запроса на получение данных о документах "Возврат": | ||
- | |||
- | http://mycompany.virtpos.ru/api/returns?apikey=MySecret&format=xml | ||
- | |||
- | ==== Параметры запроса на получение данных ==== | ||
- | |||
- | * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. | ||
- | |||
- | * **format** - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. | ||
- | |||
- | * **date** - получение Возвратов на определенную дату. Формат: ГГГГММДД. Необязательный параметр. | ||
- | |||
- | * **datefrom** - получение Возвратов начиная с определенной даты. Формат: ГГГГММДД. Необязательный параметр. | ||
- | |||
- | * **dateto** - получение Возвратов до определенной даты. Формат: ГГГГММДД. Необязательный параметр. | ||
- | |||
- | * **cdatefrom** - получение Возвратов, созданных начиная с определенной даты. Формат: ГГГГММДД. Необязательный параметр. | ||
- | |||
- | * **cdateto** - получение Возвратов, созданных до определенной даты. Формат: ГГГГММДД. Необязательный параметр. | ||
- | |||
- | * **last_update_date** - получение Возвратов, обновленных начиная с определенной даты. Формат: ГГГГММДД. Необязательный параметр. | ||
- | |||
- | * **warehouse_id** - код магазина. для которого надо вернуть поступления. Если не указан, то возвращаются Возвраты для всех магазинов. Необязательный параметр. | ||
- | |||
- | * **ext_warehouse_id** - код магазина во внешней системе (например, в 1С). Параметр игнорируется, если передан warehouse_id. Необязательный параметр. | ||
- | |||
- | * **id** - ID документа Возврата. Необязательный параметр. Если не указан, возвращаются все документы. | ||
- | |||
- | * **external_id** - код Возврата во внешней системе (например, в 1С). Если указан, возвращается только документ с указанным кодом. | ||
- | |||
- | * **last_id** - Необязательный параметр. Используется для получения новых документов с момента последнего обмена. Если параметр указан, то передаются все более новые Возвраты (с бОльшим ID) | ||
- | |||
- | * **days** - задает глубину поиска. Определяет, за какое количество дней от текущей даты надо вернуть документы Возврата. Необязательный параметр. | ||
- | |||
- | * **withitems** - принимает значение "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>returns</type> | ||
- | <days_limit>30</days_limit> | ||
- | <count>1</count> | ||
- | <returns> | ||
- | <return> | ||
- | <id>12</id> | ||
- | <warehouse_id>1</warehouse_id> | ||
- | <docnum>118</docnum> | ||
- | <docdate>2016-10-25 00:00:00</docdate> | ||
- | <supplier_id>1</supplier_id> | ||
- | <supplier_name>Мой поставщик</supplier_name> | ||
- | <supplier_inn>12345678901</supplier_inn> | ||
- | <supplier_kpp>12345679</supplier_kpp> | ||
- | <supplier_type>1</supplier_type> | ||
- | <supplier_type_name>Внешний поставщик</supplier_type_name> | ||
- | <amount>4545.00</amount> | ||
- | <status>accept</status> | ||
- | <status_name>Принят</status_name> | ||
- | <comment/> | ||
- | <guid>803ad8b6-688c-11e7-849d-74d435ee6043</guid> | ||
- | <supplier_external_id>212</supplier_external_id> | ||
- | <warehouse_external_id>222</warehouse_external_id> | ||
- | <created_date>2016-11-18 15:37:55</created_date> | ||
- | <created_by>4</created_by> | ||
- | <last_update_date>2016-11-18 15:39:16</last_update_date> | ||
- | <last_update_by>4</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> | ||
- | <barcode/> | ||
- | <price>65.0000</price> | ||
- | <amount>4420.00</amount> | ||
- | <manuf_date/> | ||
- | <expir_date/> | ||
- | <lot_number/> | ||
- | <guid>803ad8b6-688c-11e7-849d-74d435ee6043</guid> | ||
- | </item> | ||
- | <item> | ||
- | <line_id>101</line_id> | ||
- | <item_id>668</item_id> | ||
- | <item_ext_id/> | ||
- | <item_name>Шоколад "Большой набор"</item_name> | ||
- | <quantity>1.000</quantity> | ||
- | <barcode/> | ||
- | <price>125.0000</price> | ||
- | <amount>125.00</amount> | ||
- | <manuf_date/> | ||
- | <expir_date/> | ||
- | <lot_number/> | ||
- | <guid>803ad8b6-688c-11e7-849d-74d435ee6043</guid> | ||
- | </item> | ||
- | </items> | ||
- | </return> | ||
- | </returns> | ||
- | </root> | ||
- | </file> | ||
- | |||
- | |||
- | ==== Структура ответа сервера ==== | ||
- | |||
- | **Шапка документа** | ||
- | |||
- | * **id** - ID документа Возврат | ||
- | |||
- | * **external_id** - код Возврата во внешней системе (например, в 1С) | ||
- | |||
- | * **warehouse_id** - ID магазина, с которого осуществляется Возврат | ||
- | |||
- | * **docdate** - дата документа Возврата | ||
- | |||
- | * **docnum** - номер документа Возврата | ||
- | |||
- | * **supplier_id** - ID Поставщика | ||
- | |||
- | * **supplier_name** - название Поставщика | ||
- | |||
- | * **supplier_type** - код типа Поставщика | ||
- | |||
- | * **supplier_type_name** - название типа Поставщика | ||
- | |||
- | * **amount** - сумма поставки | ||
- | |||
- | * **status** - статус документа поставки (accept – возврат отгружен, drаft – черновик) | ||
- | |||
- | * **comment** - комментарий | ||
- | |||
- | * **guid** - GUID документа | ||
- | |||
- | * **supplier_external_id** - код Поставщика во внешней системе учета (например, в 1С) | ||
- | |||
- | * **warehouse_external_id** - код Магазина во внешней системе учета (например, в 1С) | ||
- | |||
- | * **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** - срок годности товара | ||
- | |||
- | * **guid** - GUID строки | ||
- | |||
- | |||