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С)
• string item_article - артикул товара.
• fields - список дополнительных полей, которые будут добавлены в ответ сервера. Имена полей разделены символом «:». Необязательный параметр. Поддерживаются следующие поля:
  • item_id
  • item_name
  • item_description
  • item_enabled
  • item_created_date
  • item_created_by
  • item_last_update_date
  • item_last_update_by
  • item_sales_weight
  • item_external_source
  • item_external_id
  • item_manufacturer_id
  • item_article
  • item_type
  • item_weight_good_flag
  • item_not_show_in_shop
  • item_param0
  • item_param1
  • item_param2
  • item_param3
  • item_param4
  • item_category_id
  • item_volume
  • item_attribute1
  • item_attribute2
  • item_attribute3
  • item_attribute4
  • item_attribute5
  • item_attribute6
  • item_attribute7
  • item_attribute8
  • item_attribute9
  • item_attribute10
  • item_attribute11
  • item_attribute12
  • item_attribute13
  • item_attribute14
  • item_attribute15
  • item_vat_percent
  • item_html_template_id
  • item_quantity_per_box
  • item_preferred_supplier
  • item_percent_of_motivation
  • item_ean13
  • item_manufacturer_name

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>