Перейти к содержаниюСправка

Различия

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

Ссылка на это сравнение

Предыдущая версия справа и слеваПредыдущая версия
Следующая версия
Предыдущая версия
doc:dev:api:requisition [02.03.2018 14:35] – doc:dev:api:requisition [26.09.2026 14:03] (текущий) – внешнее изменение
Строка 1: Строка 1:
-====== API :: Requisition. Заявки на закупку: получение данных ======+====== Requisition. Заявки на закупку ======
  
-В системе реализован программный интерфейс для получения, добавления и изменения данных о Клиентах (покупателях). Данные выгружаются по http протоколу. Формат на выбор - xml или json. +Статья перенесена: [[hc:api:requisition]]
- +
- +
-===== Пример запроса на получение данных ===== +
- +
-Пример запроса на получение данных об остатках товаров: +
- +
- http://mycompany.virtpos.ru/api/requisition?apikey=MySecret&format=xml +
- +
-==== Параметры запроса ==== +
- +
-  * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. +
-  * **format** - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. +
-  * **id** - идентификатор заявки, которую требуется получить +
-  * **warehouse_id** - идентификатор склада, для которого требуется выгрузить заявки +
-  * **ext_warehouse_id** - внешний идентификатор склада для которого нужно выгрузить заявки +
-  * **status** - статус заявки для фильтрации (NEW|DRAFT|EXPECTED|ORDERED|COMPLETED) +
-  * **datefrom** - дата в формате Ymd - с какого числа необходимо получить заявки +
-  * **dateto** - дата в формате Ymd - по какое число включительно должны быть выгружены заявки +
-  * **with_items** - установка данного поля указывает на необходимость выгружать сведения о товарах, которые входят в заявку +
- +
-==== Ответ сервера ==== +
- +
-В ответ получаем XML или JSON. В ответе обязательно присутствует поле success. Если success=1, то операция выполнена успешно. Если success=0, то произошла ошибка. Дополнительная информация об ошибке содержится в поле info +
- +
-==== Пример ответа сервера ==== +
- +
-Ниже приведен пример ответа сервера в формате XML +
- +
-<file xml> +
-<?xml version="1.0" encoding="UTF-8"?> +
-<root> +
-    <success>1</success> +
-    <type>requisition</type> +
-    <count>1</count> +
-    <requisitions> +
-        <requisition> +
-            <id>12</id> +
-            <status>EXPECTED</status> +
-            <warehouse_id>2</warehouse_id> +
-            <ext_warehouse_id/> +
-            <created_date>2018-02-13 09:02:44</created_date> +
-            <type>normal</type> <!-- тип заявки normal - обычная, agg - сводная --> +
-            <summary> +
-                <item_count>1</item_count> +
-                <item_quantity>1.000</item_quantity> +
-                <amount_cogs>1,760.26</amount_cogs> +
-                <amount_inflow>0.00</amount_inflow> +
-            </summary> +
-            <items> +
-                <item> +
-                    <item_name> +
-                        Некоторый товар +
-                    </item_name> +
-                    <ext_item_id/> +
-                    <item_id>28304</item_id> +
-                    <quantity_ordered>1.000</quantity_ordered> +
-                </item> +
-            </items> +
-        </requisition> +
-    </requisitions> +
-</root> +
-</file>+