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

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

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

http://mycompany.virtpos.ru/api/item?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"?>

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

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

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

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

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

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

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

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

В ответ получаем 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>