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

Различия

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

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

Предыдущая версия справа и слеваПредыдущая версия
Следующая версия
Предыдущая версия
doc:dev:api:warehouseencashment [17.12.2019 14:55] – [Ответ сервера] doc:dev:api:warehouseencashment [26.09.2026 14:03] (текущий) – внешнее изменение
Строка 1: Строка 1:
-====== API :: WarehouseEncashment. Инкассации ======+====== WarehouseEncashment. Инкассации ======
  
-В системе реализован программный интерфейс для получения данных об инкассации из главной кассы магазина. Данные выгружаются по http протоколу. Формат на выбор - xml или json.+Статья перенесена: [[hc:api:warehouseencashment]]
  
-===== Пример запроса на получение данных ===== 
- 
-Пример запроса на получение данных об инкассации: 
- 
-http://mycompany.virtpos.ru/api/warehouseEncashment?apikey=MySecret&format=xml 
- 
-==== Параметры запроса ==== 
-Параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры. 
-  * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. 
- 
-  * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. 
- 
-  * **id** (get only) - ID инкассации, для которой надо вернуть данные. Необязательный параметр. 
- 
-  * **warehouse_id** (get only) - ID точки продаж, для которой надо вернуть данные. Необязательный параметр. 
- 
-  * **ext_warehouse_id** (get only) - код точки продаж во внешней системе. Необязательный параметр. 
- 
-  * **date** (get only) - получение данных на определенную дату. Формат: ГГГГММДД. Необязательный параметр. 
- 
-  * **date_from** (get only) - получение данных начиная с определенной даты. Формат: ГГГГММДД. Необязательный параметр. 
- 
-  * **date_to** (get only) - получение данных начиная до определенной даты. Формат: ГГГГММДД. Необязательный параметр. 
- 
-==== Ответ сервера ==== 
- 
-В ответ получаем XML или JSON. В ответе обязательно присутствует поле success. Если success=1, то операция выполнена успешно. Если success=0, то произошла ошибка. Дополнительная информация об ошибке содержится в поле info 
- 
-==== Пример ответа сервера ==== 
- 
-Ниже приведен пример ответа сервера в формате XML 
- 
-<file xml> 
-</file>