API :: Pricelist. Получение данных о ценах на товары

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

Получение данных о ценах

Получение розничных цен из определенного прайслиста

http://mycompany.virtpos.ru/api/pricelist?apikey=MySecret&format=xml&external_id=ex1

Параметры, которые не отмечены как get only, могут быть переданы как get- или как post-параметры.

Параметры:

  • int id (get only) - внутренний ID прайслиста
  • string external_id (get only) - ID прайслиста во внешней системе (например, 1С)
  • int item_id (get only) -внутренний ID товара. Если не указан, то будут возвращены все товары
  • string item_ext_id (get only) - ID товара во внешней системе (например, 1С)

Создание/обновление прайслиста

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

Создает или обновляет шапку прайслиста.

Параметры, которые не отмечены как get only, могут быть переданы как get- или как post-параметры.

Параметры:

  • id (get only) - ID прайслиста
  • external_id (get only) - ID прайслиста во внешней системе (например, 1С)
  • create_if_not_exist (get only) - если «1», то запись будет создана при неуспешном поиске
  • name (get only) - название прайслиста
  • description (get only) - описание прайслиста

Назначение прайслиста в магазин

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

Параметры, которые не отмечены как get only, могут быть переданы как get- или как post-параметры.

Параметры:

  • int id (get only) - внутренний ID прайслиста
  • string external_id (get only) - ID прайслиста во внешней системе
  • int warehouse_id (get only) - внутренний ID магазина
  • string warehouse_ext_id (get only) - ID магазина во внешней системе
  • boolean main (get only) - признак «Основной прайслист» (не используется)

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

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

Параметры, которые не отмечены как get only, могут быть переданы как get- или как post-параметры.

Параметры:

  • int warehouse_id (get only) - внутренний ID магазина
  • string warehouse_external_id (get only) - ID магазина во внешней системе

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

<?xml version="1.0" encoding="UTF-8"?>
<root>
	<success>1</success>
	<warehouse_id>1</warehouse_id>
	<warehouse_external_id>111</warehouse_external_id>
	<default_pricelist_id>2</default_pricelist_id>
	<default_pricelist_external_id>2222</default_pricelist_external_id>
	<pricelist_ids>2,2</pricelist_ids>
	<pricelist_external_ids>2222,2222</pricelist_external_ids>
</root>

Обновление розничной цены на товар в прайслисте

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

Обновляет цену товара в прайслисте

Параметры, которые не отмечены как get only, могут быть переданы как get- или как post-параметры.

Параметры:

  • int id (get only) - ID прайслиста
  • string external_id (get only) - внешний ID прайслиста
  • int item_id (get only) - ID товара
  • string item_ext_id (get only) - внешний ID товара
  • float price (get only) - новая цена товара

Массовое обновление цен на товары

https://mycompany.virtpos.ru/api/pricelist/batchUpdate/?apikey=MySecret&format=xml&batch=batch

Можно использовать как POST запрос, так и GET запрос

Пример batch:

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<batch>
    <!-- Может использоваться либо id, либо external_id -->
    <id>pricelist_id</id>
    <external_id>pricelist_external_id</external_id>
    <items>
        <item>
            <!-- Может использоваться либо id, либо external_id --->
            <id>item_id</id>
            <external_id>item_external_id</external_id>
            <price>new_price</price>
        </item>    
    </items>
</batch>