Различия

Здесь показаны различия между двумя версиями данной страницы.

--- doc:dev:api:inflow [23.10.2019 16:34]
dlebedev [Параметры запроса]
+++ doc:dev:api:inflow [05.08.2020 12:52] (текущий)
dlebedev [Пример запроса для загрузки файла Поступления]
@@ Строка 544: / Строка 544: @@
-===== Пример запроса для загрузки Поступления =====
+===== Пример запроса для загрузки файла Поступления =====
 Пример запроса для загрузки поступления:
-http://virtualpos.loc/api/inflow/upload?apikey=MySecret&format=xml&encoding=utf8&waybill=123123123&warehouse_id=6&supplier_id=8&unique=false
+http://mycompany.myvirtualpos.ru/api/inflow/upload?apikey=MySecret&format=xml&encoding=utf8&waybill=123123123&warehouse_id=6&supplier_id=8&unique=false
 ==== Параметры запроса ====
-Если параметр не помечен как "get only", то он может быть передан как get- или как post-параметр.
+Если параметр не помечен как **get only**, то он может быть передан как get- или как post-параметр.
   * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр.
   * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
-  * **waybill** (get only) - товарная накладная
+  * **waybill** - товарная накладная. Обязательный параметр.
+  * **docdate** - дата документа в формате YYYYMMDD. Необязательный параметр. По умолчанию используется текущая дата.
-  * **supplier_id** (get only) - идентификатор поступления в системе. Необязательный параметр; если указан, то будет осуществлен поиск Поставщика по указанному коду и добавление ссылки на него в документ Поступления
+  * **encoding** - кодировка файла. Необязательный параметр. Может принимать значения "cp1251" и "utf8". По умолчанию "cp1251".
-  * **supplier_external_id** - код Поставщика во внешней системе. Необязательный параметр; если указан, то будет осуществлен поиск Поставщика по указанному коду и добавление ссылки на него в документ Поступления
+  * **supplier_id** - ID Поставщика. Обязательный параметр.
-  * **warehouse_external_id** - код Магазина во внешней системе. Необязательный параметр; если указан, то будет осуществлен поиск Магазина по указанному коду и добавление ссылки на него в документ Поступления.
+  * **supplier_external_id** - ID Поставщика во внешней системе. Может быть использован вместо **supplier_id**.
+  * **warehouse_id** - ID Магазина. Обязательный параметр.
+  * **warehouse_external_id** - ID Магазина во внешней системе. Может быть использован вместо **warehouse_id**.
+  * **phone** - телефон клиента. Необязательный параметр. Необходим, если из Поступления планируется создать заказ.
+  * **order** - номер заказа. Необязательный параметр. Необходим, если из Поступления планируется создать заказ.
+  * **unique** - Если равен true, то будет проверено, что такое Поступление еще не загружалось в систему. Если false - проверки не будет. Необязательный параметр. По умолчанию равен true.
+==== Ответ сервера ====
+В ответ получаем XML или JSON. В ответе обязательно присутствует поле success. Если success=1, то операция выполнена успешно. Если success=0, то произошла ошибка. Дополнительная информация об ошибке содержится в поле info.
+Также возвращается имя временного файла, в который было сохранено загруженное поступление. В дальнейшем из него будет создано поступление в системе.
+==== Пример ответа сервера ====
+<file xml>
+<?xml version="1.0" encoding="UTF-8"?>
+<root>
+  <success>1</success>
+  <files>
+    <0>74e474f98c55579e5f0bc72123da2b68.csv</0>
+  </files>
+</root>
+</file>
-  * Также в качестве параметров могут быть переданы все поля для поступления