Различия

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

--- doc:dev:api:warehouse [09.07.2015 19:54]
rlysov создано
+++ doc:dev:api:warehouse [20.10.2020 12:31] (текущий)
sshevchuk [Пример запроса на добавление/изменение данных]
@@ Строка 4: / Строка 4: @@
-===== Пример запроса =====
+===== Пример запроса на получение данных =====
 Пример запроса на получение данных об остатках товаров:
@@ Строка 11: / Строка 11: @@
 ==== Параметры запроса ====
+Параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры.
   * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр.
-  * **format** - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
+  * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
-  * **id** - код магазина, для которого надо вернуть данные. Если не указан, то возвращаются данные обо всех магазинах.
+  * **id** (get only) - код магазина, для которого надо вернуть данные. Если не указан, то возвращаются данные обо всех магазинах.
-  * **external_id** - код магазина во внешней системе учета (например, в 1С)
+  * **external_id** (get only) - код магазина во внешней системе учета (например, в 1С)
+  * **fields** - список дополнительных полей, которые будут добавлены в ответ сервера. Имена полей разделены символом ":". Необязательный параметр. Поддерживаются следующие поля:
+    * organisation_name - название организации
@@ Строка 50: / Строка 52: @@
 			<lon>37.60998200000000</lon>
 			<minusale>1</minusale>
+                        <show_in_shop>1</show_in_shop>
 			<location_id>1</location_id>
 			<location_name>Москва</location_name>
@@ Строка 70: / Строка 73: @@
 			<lon>37.84508900000000</lon>
 			<minusale>1</minusale>
+                        <show_in_shop>1</show_in_shop>
 			<location_id>1</location_id>
 			<location_name>Москва</location_name>
@@ Строка 79: / Строка 83: @@
 </root>
 </file>
+===== Пример запроса на добавление/изменение данных =====
+Пример запроса на получение данных о точке продаж:
+ https://mycompany.myvirtualpos.ru/api/warehouse/update?apikey=MySecret&create_if_not_exist=0&external_id=666
+==== Параметры запроса ====
+Параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры.
+  * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр.
+  * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
+  * **id** (get only) - код магазина, данные которого надо обновить
+  * **external_id** (get only) - код магазина во внешней системе учета, например, в 1С, данные которого надо обновить
+  * **create_if_not_exist** (get only) - Если истина, то при неудачном поиске магазин будет добавлен в систему.
+  * **location_name** (get only) - Название территории. Если значение указано, то происходит проверка, есть ли территория с таким именем в справочнике. Если нет, то она будет добавлена. Параметр игнорируется, если указан location_id
+  * Также в качестве параметров могут быть переданы все поля для магазина (name, address, phone и т.д.)
+==== Ответ сервера ====
+В ответ получаем XML или JSON. В ответе обязательно присутствует поле success. Если success=1, то операция выполнена успешно. Если success=0, то произошла ошибка. Дополнительная информация об ошибке содержится в поле info.
+Также возвращается id записи, которая была обновлена или добавлена. Флаг isnew равен "1", если запись была создана, и "0" если обновлена.
+==== Пример ответа сервера ====
+<file xml>
+<?xml version="1.0" encoding="UTF-8"?>
+<root>
+	<success>1</success>
+	<id>11</id>
+	<isnew>1</isnew>
+</root>
+</file>