API :: ItemGroup. Получение/изменение данных о номенклатурных группах

В системе реализован программный интерфейс для получения, добавления и изменения данных о группах номенклатуры. Данные выгружаются по http протоколу. Формат на выбор - xml или json.

Пример запроса на получение данных о товарных группах:

http://mycompany.virtpos.ru/api/itemGroup?apikey=MySecret&format=xml

• apikey - Секретный ключ для доступа к данным. Обязательный параметр.

• format - формат, в котором сервер отдаст данные. Может принимать значения «xml» или «json». Необязательный параметр.

• id - код товара, для которого надо вернуть данные. Если не указан, то возвращаются данные о всех товарных группах.

• external_id - код товара во внешней системе учета (например, в 1С)

В ответ получаем XML или JSON. В ответе обязательно присутствует поле success. Если success=1, то операция выполнена успешно. Если success=0, то произошла ошибка. Дополнительная информация об ошибке содержится в поле info

Ниже приведен пример ответа сервера в формате XML

<?xml version="1.0" encoding="UTF-8"?>
<root>
	<success>1</success>
	<type>item_group</type>
	<count>2</count>
	<item_groups>
		<item_group>
		<id>1</id>
		<external_id>1231</external_id>
		<name>Группа 1</name>
		<parent_id/>
		<parent_ext_id/>
		<not_show_in_shop>0</not_show_in_shop>
		<index_tree>1:</index_tree>
		<created_date>2015-07-11 17:39:10</created_date>
		<last_update_date>2015-07-11 17:39:10</last_update_date>
	</item_group>
	<item_group>
		<id>2</id>
		<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>

Пример запроса на получение данных о товарных группах:

http://mycompany.virtpos.ru/api/itemGroup/update?apikey=MySecret&create_if_not_exist=0&external_id=666

• apikey - Секретный ключ для доступа к данным. Обязательный параметр.

• format - формат, в котором сервер отдаст данные. Может принимать значения «xml» или «json». Необязательный параметр.

• id - код товарной группы, данные которой надо обновить

• external_id - код товарной группы во внешней системе учета (например, в 1С), данные которой надо обновить

• create_if_not_exist - Если истина, то при неудачном поиске товарная группа будет добавлена в систему.

• Также в качестве параметров могут быть переданы все поля для товарно группы (name, parent_id, external_id, parent_ext_id и т.д.)

В ответ получаем XML или JSON. В ответе обязательно присутствует поле success. Если success=1, то операция выполнена успешно. Если success=0, то произошла ошибка. Дополнительная информация об ошибке содержится в поле info.

Также возвращается id записи, которая была обновлена или добавлена.

• Флаг isnew равен «1», если запись была создана, и «0» если обновлена.

<?xml version="1.0" encoding="UTF-8"?>
<root>
	<success>1</success>
	<id>11</id>
	<isnew>1</isnew>
</root>