Различия

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

--- doc:dev:api:manufacturer [16.12.2016 18:03]
amalchenko создано
+++ doc:dev:api:manufacturer [02.06.2018 10:42] (текущий)
@@ Строка 1: / Строка 1: @@
-====== API :: ItemGroup. Получение/изменение данных о номенклатурных группах ======
+====== API :: Manufacturer. Получение/изменение данных о производителях ======
-В системе реализован программный интерфейс для получения, добавления и изменения данных о группах номенклатуры. Данные выгружаются по http протоколу. Формат на выбор - xml или json.
+В системе реализован программный интерфейс для получения, добавления, изменения и удаления производителей. Данные выгружаются по http протоколу. Формат на выбор - XML или JSON.
 ===== Пример запроса на получение данных =====
-Пример запроса на получение данных о товарных группах:
+Пример запроса на получение данных о производителях:
- http://mycompany.virtpos.ru/api/itemGroup?apikey=MySecret&format=xml
+ http://mycompany.virtpos.ru/api/manufacturer?apikey=MySecret&format=xml
 ==== Параметры запроса ====
+параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры.
   * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр.
-  * **format** - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
+  * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
-  * **id** - код товара, для которого надо вернуть данные. Если не указан, то возвращаются данные о всех товарных группах.
+  * **id** (get only) - код производителя, для которого надо вернуть данные. Если не указан, то возвращаются данные о всех производителях.
-  * **external_id** - код товара во внешней системе учета (например, в 1С)
@@ Строка 34: / Строка 31: @@
 <?xml version="1.0" encoding="UTF-8"?>
 <root>
-	<success>1</success>
+   <success>1</success>
-	<type>item_group</type>
+   <type>manufacturer</type>
-	<count>2</count>
+   <count>2</count>
-	<item_groups>
+   <manufacturers>
-		<item_group>
+      <manufacturer>
-		<id>1</id>
+         <id>1</id>
-		<external_id>1231</external_id>
+         <name>Газмяс</name>
-		<name>Группа 1</name>
+         <created_date>2015-05-15 18:21:02</created_date>
-		<parent_id/>
+         <last_update_date>2016-12-13 20:21:02</last_update_date>
-		<parent_ext_id/>
+      </manufacturer>
-		<not_show_in_shop>0</not_show_in_shop>
+      <manufacturer>
-		<index_tree>1:</index_tree>
+         <id>2</id>
-		<created_date>2015-07-11 17:39:10</created_date>
+         <name>Водолей</name>
-		<last_update_date>2015-07-11 17:39:10</last_update_date>
+         <created_date>2015-05-15 18:21:02</created_date>
-	</item_group>
+         <last_update_date>2015-05-15 18:21:02</last_update_date>
-	<item_group>
+      </manufacturer>
-		<id>2</id>
+   </manufacturers>
-		<external_id>{123-343-23423}</external_id>
-		<name>Группа 2</name>
-		<parent_id/>
-		<parent_ext_id/>
-		<not_show_in_shop>0</not_show_in_shop>
-		<index_tree>2:</index_tree>
-		<created_date>2015-07-11 17:39:27</created_date>
-		<last_update_date>2015-07-11 17:39:27</last_update_date>
-	</item_group>
 </root>
 </file>
 ===== Пример запроса на добавление/изменение данных =====
-Пример запроса на получение данных о товарных группах:
+Пример запроса на обновление данных о производителе:
- http://mycompany.virtpos.ru/api/itemGroup/update?apikey=MySecret&create_if_not_exist=0&external_id=666
+ http://mycompany.virtpos.ru/api/manufacturer/update/?apikey=MySecret&format=xml&id=1&name=NewName
 ==== Параметры запроса ====
+параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры.
   * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр.
-  * **format** - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
+  * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
-  * **id** - код товарной группы, данные которой надо обновить
+  * **id** (get only) - код производителя, данные которого нужно обновить
-  * **external_id** - код товарной группы во внешней системе учета (например, в 1С), данные которой надо обновить
+  * **create_if_not_exist** (get only) - Если истина, то при неудачном поиске производитель будет добавлен в систему.
-  * **create_if_not_exist** - Если истина, то при неудачном поиске товарная группа будет добавлена в систему.
+  * Также в качестве параметров могут быть переданы все поля для производителя, на данный момент это только name
-  * Также в качестве параметров могут быть переданы все поля для товарно группы (name, parent_id, external_id, parent_ext_id и т.д.)
@@ Строка 100: / Строка 84: @@
 <root>
 	<success>1</success>
-	<id>11</id>
+	<id>1</id>
-	<isnew>1</isnew>
+	<isnew>0</isnew>
 </root>
 </file>
+===== Пример запроса на удаление данных =====
+Пример запроса на удаление производителя:
+ http://mycompany.virtpos.ru/api/manufacturer/delete/?apikey=MySecret&format=xml&id=1
+==== Параметры запроса ====
+параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры.
+  * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр.
+  * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
+  * **id** (get only) - код производителя который будет удален
+==== Ответ сервера ====
+В ответ получаем XML или JSON. В ответе обязательно присутствует поле success. Если success=1, то операция выполнена успешно. Если success=0, то произошла ошибка. Дополнительная информация об ошибке содержится в поле info.
+Также возвращается id записи, которая была удалена.
+==== Пример ответа сервера ====
+<file xml>
+<?xml version="1.0" encoding="UTF-8"?>
+<root>
+   <success>1</success>
+   <id>1</id>
+</root>
+</file>