Інструкція з формування XML фіду для сервісу порівняння цін

Документація описує структуру XML файлу для передачі товарного каталогу вашого інтернет-магазину на сервіс порівняння цін.

---

Загальна структура

<?xml version="1.0" encoding="UTF-8"?>
<yml_catalog>
    <shop>
        <name>Назва магазину</name>
        <url>https://example.com</url>
        <currencies>...</currencies>
        <categories>...</categories>
        <offers>...</offers>
    </shop>
</yml_catalog>

Кодування — UTF-8. Кореневий елемент <yml_catalog> містить один елемент <shop>.

---

1. Елемент <shop>

Тег	Опис	Обов’язковий
<name>	Назва інтернет-магазину	Так
<url>	Посилання на головну сторінку магазину	Так
<currencies>	Блок валют	Так
<categories>	Блок категорій товарів	Так
<offers>	Блок товарних пропозицій	Так

---

2. Елемент <currencies>

Містить перелік валют. Кожна валюта задається елементом <currency>.

Атрибут	Опис	Обов’язковий
id	Код валюти (UAH, USD, EUR)	Так
rate	Курс відносно базової валюти (для UAH завжди 1)	Так

<currencies>
    <currency id="UAH" rate="1"/>
</currencies>

---

3. Елемент <categories>

Містить перелік категорій. Категорії можуть мати ієрархію через атрибут parentId.

Атрибут	Опис	Обов’язковий
id	Унікальний ідентифікатор категорії	Так

Текстове значення елемента — назва категорії.

<categories>
    <category id="1">Приманки</category>
    <category id="2">Воблери</category>
    <category id="3">Жилки та шнури</category>
    <category id="4">Жилки</category>
</categories>

---

4. Елемент <offer>

Кожен товар описується елементом <offer> всередині блоку <offers>.

Атрибути

Атрибут	Опис	Обов’язковий
id	Унікальний ідентифікатор товару	Так
available	Доступність товару (true / false)	Так

Дочірні теги

Тег	Опис	Обов’язковий
<name>	Назва товару	Так
<url>	Пряме посилання на сторінку товару	Так
<price>	Актуальна ціна	Так
<priceOld>	Стара ціна до знижки (для відображення перекресленої ціни)	Ні
<currency>	Валюта ціни (UAH, USD, EUR)	Так
<categoryId>	ID категорії, до якої належить товар (відповідає id з <categories>)	Так
<vendor>	Виробник / бренд	Так
<code>	Код товару	Так
<image>	Посилання на зображення товару. Може бути кілька тегів <image>	Ні
<param>	Характеристика товару. Атрибут name — назва параметра, значення елемента — значення параметра	Ні
<availability>	Статус наявності товару. Допустимі значення: inStock, outOfStock, preOrder, backOrder	Так
<label>	Маркетинговий бейдж товару. Може бути кілька тегів <label>. Допустимі значення: discounted, new, endsSoon, promo, outlet, bestseller	Ні

Значення <availability>

Значення	Опис
inStock	Товар є в наявності
outOfStock	Товару немає в наявності
preOrder	Товар доступний для передзамовлення
backOrder	Товар можна замовити під запит (очікується)

Значення <label>

Значення	Опис
discounted	Товар з уцінкою (пошкоджена упаковка, вітринний зразок тощо)
new	Новинка в асортименті
endsSoon	Скоро закінчиться (обмежена кількість на складі)
promo	Акційна пропозиція (тимчасова знижка)
outlet	Розпродаж (залишки, зняті з виробництва)
bestseller	Хіт продажів

Може бути кілька тегів <label> одночасно. Наприклад, товар може бути одночасно новинкою та акційним.

Приклад

<offer id="199513" available="true">
    <name>Воблер Flagman Swim Spark 90мм A020</name>
    <url>https://example.com/vobler-flagman-swim-spark-90mm-a020/p199513</url>
    <price>315</price>
    <priceOld>315</priceOld>
    <vendor>Flagman</vendor>
    <code>SS90-A020</code>
    <currency>UAH</currency>
    <categoryId>2</categoryId>
    <image>https://example.com/catalog/199513/1285299.jpg</image>
    <image>https://example.com/catalog/199513/1285300.jpg</image>
    <param name="Тип воблера">Swimbait</param>
    <param name="Довжина">90</param>
    <param name="Вага">7.4 г</param>
    <param name="Заглиблення">0.3 - 1 м</param>
    <param name="Плавучість">Повільно тоне</param>
    <param name="Колір">A020</param>
    <param name="Вага (діапазон)">5-12</param>
    <param name="Розмір (діапазон)">80-110</param>
    <availability>inStock</availability>
    <label>new</label>
    <label>promo</label>
</offer>

Приклад XML фіду

---

Рекомендації

Спецсимволи. Значення тегів, що містять спецсимволи (<, >, &), загортайте в CDATA:

<name><![CDATA[Воблер 5" & більше]]></name>

Кілька зображень. Просто додайте кілька тегів <image> послідовно:

<image>https://example.com/catalog/199513/1285299.jpg</image>
<image>https://example.com/catalog/199513/1285300.jpg</image>

Попередня генерація. Якщо генерація XML займає багато часу, генеруйте файл заздалегідь за розкладом, щоб у момент завантаження він вже був готовий на сервері.