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

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

http://mycompany.virtpos.ru/api/store?apikey=MySecret&format=xml&warehouseid=1&fields=itemname:article

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

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

• stockonly - если «1», то возвращает только те товары, которые есть в наличии (остаток больше нуля)

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

• itemid - код товара, данные о котором надо вернуть. Если не задан, то будут отданы данные обо всех товарах.

• article - артикул товара, данные о котором надо вернуть. Если не задан, то будут отданы данные обо всех товарах.

• itemname - название товара, данные о котором надо вернуть. Если не задан, то будут отданы данные обо всех товарах.

• fields - список дополнительных полей, которые будут добавлены в ответ сервера. Имена полей разделены символом «:». Необязательный параметр. Поддерживаются следующие поля:
  • itemname - название товара
  • article - артикул товара
  • cogs - себестоимость товара
  • price - цена продажи по основному прайслисту
  • optionalprices - цены товара по дополнительным прайслистам

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

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

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>1</success>
    <type>store</type>
    <stockonly>1</stockonly>
    <count>1</count>
    <warehouses>
        <warehouse>
            <id>3</id>
            <name>Магазин 1</name>
            <count>1</count>
            <items>
                <item>
                    <id>17007</id>
                    <quantity>1.000</quantity>
                    <name>63838 Корм для собак 2кг</name>
                    <article>63838</article>
                    <cogs>0.00</cogs>
                    <price>1126.00</price>
                    <prices>
                        <price>
                            <pricelistid>4</pricelistid>
                            <price>1126.00</price>
                        </price>
                        <price>
                            <pricelistid>3</pricelistid>
                            <price>866.00</price>
                        </price>
                    </prices>
                </item>
            </items>
        </warehouse>
    </warehouses>
</root>

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

http://mycompany.virtpos.ru/api/store/updateonhand?apikey=MySecret&format=xml&warehouseid=1&itemd=1

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

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

• warehouseid - код магазина, в котором надо изменить данные об остатках.

• itemid - код товара, данные о котором надо изменить.

• ext_warehouseid - код магазина внешней системе (например, 1С), в котором надо изменить данные об остатках. Используется только если не указан warehouseid

• ext_itemid - код товара внешней системе (например, 1С), данные о котором надо изменить. . Используется только если не указан itemid

• Поля, которые можно изменить:
  • quantity - количество товара
  • manuf_date - дата изготовления товарного остатка
  • cogs - себестоимость товарного остатка
  • expir_date - срок годности товарного остатка
  • lot_number - серия или партия товарного остатка

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

• itemid - внутренний идентификатор товара, данные о котором были обновлены
• warehouseid - внутренний идентификатор магазина(склада), на котором был обновлен остаток товара
• isnew - «1» если остаток был впервые добавлен в систему. 0 - если остаток был обновлен
• quantity_before - количество товара до обновления

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

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>1</success>
    <id>3</id>
    <itemid>8</itemid>
    <warehouseid>1</warehouseid>
    <isnew>0</isnew>
    <quantity_before>1.700</quantity_before>
</root>