YML фид для ElasticSearch

Описание дополнений формата от IMSHOP.IO и примеры

Общая структура фида (пример)

<?xml version="1.0" encoding="UTF-8"?>
<yml_catalog date="2017-02-05 17:22">
  <shop>
    <categories>
      <category.........>...</category>
      ...
    </categories>
    <offers>
      <offer........>
        ...
      </offer>
      ...
    </offers>
  </shop>
</yml_catalog>

Описание формата

offers -> offer (атрибуты)

  • available - обязательный атрибут. Товары с available = false не будут отображаться в приложении вне зависимости от каких либо других факторов api / остатков.

  • publishedOn - дата релиза товара для подключения автоматической сортировки по старым/новым товарам

  • id - атрибут, идентификатор товарного предложения - обязательна уникальность в рамках каталога.

  • itemPreviewUrl - атрибут, URL-ссылка на страницу с 3D-моделью товара (на страницу с 3D предпросмотром, не на карточку товара).

  • fraction - кратность товара, с которой можно добавлять его в корзину. Например, если fraction=0.2, то добавлять в корзину можно только 0.2, 0.4, 0.6 и т.д. единиц товара.

    fraction необходим для включения функционала. По умолчанию кратность всегда 1 к 1.

    Цена указывается за 1 (одну) полную единицу товара (не за 0.2, 0.3 и т.д).

  • group_id - атрибут, элемент объединяет все предложения, которые являются вариациями одной модели и должен иметь одинаковое значение.

  • uuid - атрибут, дополнительный идентификатор товара (например, из 1С).

  • sizeGridImage - атрибут, URL-ссылка на картинку с размерами для примерки.

<offer id="700996" available="true" uuid="a43c03a5-3d1d-5791-b9a5-1ef95438cd8e" group_id="111111">
</offer>
<offer id="998822" publishedOn="2014-11-12 00-00-00" available="true" group_id="222222" sizeGridImage="https://https://xxx.ru/upload/xxx.jpg">
</offer>
<offer id="898822" available="true" group_id="222222" sizeGridImage="https://https://xxx.ru/upload/xxx.jpg">
</offer>
<offer id="198820" available="true" fraction="5">
</offer>

offers -> offer (дочерные элементы)

  • barcode - штрихкод товара от производителя в одном из форматов: EAN-13, EAN-8, UPC-A, UPC-E. Элемент offer может содержать несколько элементов barcode, в этом случае каждый из штрихкодов передается в отдельном теге.

  • name - полное название предложения, в которое входит: тип товара, производитель, модель и название товара, важные характеристики. Составляйте по схеме: что (тип товара) + кто (производитель) + товар (модель, название) + важные характеристики.

  • url - URL страницы товара на сайте магазина

  • sort - порядок сортировки по популярности

  • guid - параметр необходимый при прямой интеграции mindbox чтобы определять какой товар смотрел юзер. Значение должно быть то же которое настроено в mindbox

  • vendor - производитель.

  • vendorCode - код производителя для данного товара.

  • model - модель и название товара.

  • typePrefix - тип / категория товара (например, «мобильный телефон», «стиральная машина», «угловой диван»).

  • categoryId - идентификатор категории товара, присвоенный магазином. Элемент offer может содержать несколько элементов categoryId, в этом случае каждая из категорий передается в отдельном теге.

  • googleProductCategory - google product category (GPC) taxonomy для товара.

  • param - все важные характеристики товара — цвет, размер, объем, материал, вес, возраст, пол, и т. д. Элемент offer может содержать несколько элементов param (один элемент param — одна характеристика), в этом случае каждая характеристика передается в отдельном теге. (при использовании перелинковки цвета отдавать в hex формате или указывать URL изображения в атрибуте itemImage).

    • noFilter="true" - скрыть параметр из фильтров

    • noDetails="true" - скрыть параметр на карточке товара

    • numeric="true" - сделать фильтр слайдером

  • picture - URL-ссылка на картинку товара. Элемент offer может содержать несколько элементов picture, в этом случае каждая из картинок передается в отдельном теге.

  • currencyId - валюта, в которой указана цена товара: RUR, USD, EUR, UAH, KZT, BYN.

  • price - актуальная цена товара.

  • priceByCard - цена товара по скидочной карте (в разработке), должна быть ниже обычной цены. Несовместимо с oldrice.

  • priceUnits - единица измерения.

  • oldprice - старая цена товара, должна быть выше текущей.

  • richDescription - Rich-контент в карточке товара, передавать в формате markdown.

Так же есть возможность показывать старую цену в зависимости от сегмента пользователя.

<oldprice>20000</oldprice>
<oldprice priceTier="silver">19500</oldprice>
<oldprice priceTier="gold">19400</oldprice>
<oldprice priceTier="platina">19300</oldprice>
<oldprice priceTier="vip">19200</oldprice>

  • saleEndsDateIso - Дата время до окончания акции по аналогии с датой фида у яндекса.

  • retailPrice - РРЦ товара (цена товара в оффлайне в случае если отличается от price).

  • deferPrice - цена на случай отсрочки получения, должна быть ниже price.

  • listPrice - необязательно, справочные цены, если нужно показать несколько цен, только для отображения, в расчетах не используются.

    • title - атрибут, текстовое описание цены.

  • description - описание предложения.

  • rec - идентификаторы товаров для блока рекомендаций через запятую. Возможно передавать несколько блоков с подборками товаров, например "Похожие товары", "С этим покупают", "Дополни образ" итд. Для этого следует передать несколько тегов rec с атрибутом title (см пример).

  • maxPromocodeDiscountPercent - максимальный процент скидки на данный товар, например, по купону. Используется для ограничения размера скидки, например, для товаров с низкой маржинальностью.

  • vat - значение ставки НДС для товара. Для всех ставок НДС предусмотрены специальные значения.

    • НДС не облагается - 6 или NO_VAT

    • 0% - 5 или VAT_0

    • 10% - 2 или VAT_10

    • 20% - 7 или VAT_20

  • useBonuses - возможность частичной или полной оплаты данного товара с бонусного счета при наличии программы лояльности.

  • overSized - крупногабаритный товар.

  • preorder -параметр для товаров по предзаказу.

  • badge- бейджик на картинке товара. Элемент offer может содержать несколько элементов badge, в этом случае каждый из бейджик передается в отдельном теге. В одном бейдже может быть либо только текстовый вариант, либо только с картинкой. И текст и картинка в одной бейдже быть не могут.

    • type , необязательно атрибут - тип бейджа - строка (text, color,smallImage) по умолчанию тип text

    • textColor, атрибут, необязательно - цвет текста в формате #rrggbb

    • bgColor, атрибут, необязательно - цвет фона для текстового бейджа в формате #rrggbb , в случае если тип бейджа color - используется как цвет заполнения и становится обязательным полем

    • link, атрибут, необязательно - ссылка при нажатии на бейджик

    • picture, атрибут, необязательно - используется для передачи картинки типа бейджа smallImage, ссылка на картинку

    • position - атрибут, необязательно - строка, может быть одним из 4 типов (top-left, top-right, bottom-left, bottom-right), управляет положением бейджа относительно угла, по умолчанию top-left(либо значение из настроек), также нужно обратиться к продукту что вы хотите сами управлять положением бейджей на товаре

    • annotation - атрибут, необязательно - строка, текст описания бейджа, которое появляется при нажатии на бейдж

  • video - видео товара (можно передать несколько). Видео должны быть в формате H.264.

    • main - если true, то видео будет отображаться в слайдере с фотографиями товара

    • title - опциональный заголовок видео

    • image - URL на картинку, которая отображается, пока грузится видео

  • file - релевантные документы.

    • title - название

    • size (опционально) - вес файла для отображения на кнопке в приложении

    • icon (опционально) - иконка для отображения на кнопке в приложении

    • url - ссылка на скачивание

  • rating - рейтинг товара для отображения на карточке товара сверху (не путать с хуком отзывов на товары).

  • reviews_count - количество отзывов для отображения в ячейке и на карточке товара сверху (не путать с хуком отзывов на товары).

  • othercolors- блок товаров "еще в другом цвете", перечислить group Id товаров с альтернативными цветами. Не используется вместе с parentVendorCode.

  • parentVendorCode - по данному параметру объединяем товары для перелинковки (позволяет добавлять переключаемые параметры на карточку товара) не должен пересекаться с group id, не используется вместе с othercolors

  • showMultipleFractionsCounter - показывать для этого товара двойной пикер: один по единице измерения, который передан priceUnits, а второй пикер по упаковкам. fraction отвечает за количество единиц в упаковке, купить товар можно будет только по упаковкам (в разработке)

  • cashback - кол-во кэшбека

Так же есть возможность показывать кэшбек в зависимости от сегмента пользователя.

<cashback>100</cashback>
<cashback priceTier="silver">110</cashback>
<cashback priceTier="gold">120</cashback>
<cashback priceTier="platina">130</cashback>
<cashback priceTier="vip">140</cashback>
<offer id="998822" available="true" group_id="222222">
<barcode>4627077842287</barcode>
<name>Ботинки кожаные</name>
<url>https://xxx.ru/xxx./</url>
<sort>8</sort>
<price>450</price>
<oldprice>650</oldprice>
<priceByCard>390</priceByCard>
<retailPrice>790</retailPrice>
<deferPrice>550</deferPrice>
<priceUnits>м²</priceUnits>
<currencyId>RUB</currencyId>
<saleEndsDateIso>2020-11-22T14:37:38</saleEndsDateIso>
<guid configurationId="3573311">
<vendor>BrandName</vendor>
<vendorCode>0000-667838</vendorCode>
<categoryId>1728</categoryId>
<model>V198605N-1568C68</model>
<typePrefix>Ботинки</typePrefix>
<param name="Размер">39</param>
<param name="Цвет" hex="#0000FF">Синий</param>
<param name="Материал подошвы">Каучук</param>
<param name="Материал верха">Кожа</param>
<description>Прекрасные ботинки известного бренда</description>
<googleProductCategory>Apparel &amp; Accessories > Clothing > Shirts &amp; Tops</googleProductCategory>
<rec title="Похожие товары">213741,1899435,1630074</rec>
<rec title="Дополни образ">666000,777000</rec>
<badge textColor="#000" bgColor="#CCFF33">НОВИНКА</badge>
<badge picture="https://xxxxx/xxxxxx.png"></badge>
<badge type="smallImage" picture="https://xxxxx/xxxxxx.png" position="top-left"></badge>
<badge type="color" bgColor="#02d3b4" position="bottom-right"></badge>
<badge type="color" bgColor="#02d3b4" annotation="Длинное описание бейджа о том, что он значит, можно добавить 
переносы прямо в текст, также разрешены ссылки прямо в тексте, которые будут кликабельны"></badge>
<maxPromocodeDiscountPercent>0</maxPromocodeDiscountPercent>
<vat>vat_20</vat>
<picture>https://xxxx/xxxx/image1.jpg</picture>
<picture>https://xxxx/xxxx/image2.jpg</picture>
<useBonuses>true</useBonuses>
<preorder>true</preorder>
<showMultipleFractionsCounter>true</showMultipleFractionsCounter>
<rating>4.5</rating>
<reviews_count>130</reviews_count>
<video main="true" image="https://xxxxxx">https://xxx.ru/xxx.mp4</video>
<video title="Видео-инструкция" image="https://xxx.ru/xxx.mp4</video>
<file title="Руководство пользователя" size="24mb" icon="https://xxx.ru/xxx.png" url="https://xxxxxxx/x.pdf" />

categories -> category (атрибуты)

  • id - идентификатор категории

  • parentId - идентификатор родительской категории

  • picture - URL картинки категории

  • textColor - цвет текста (опционально)

  • backgroundColor - цвет фона (опционально)

<categories>
<category id="6323" picture="https://xxx/xxx/xxx.jpg">Смартфоны и гаджеты</category>
<category id="183" parentId="6323" picture="https://xxx/xxx/xxx.jpg">Смартфоны</category>
</categories>

Синонимы (поиск по ключевым словам, которых нет в названии/модели оффера):

<offers>
  <offer id="61b06345-c404-11e0-ad14-3c4a926c6ba4" available="true">
    ...
    <name>Harry Potter™ Hogwarts™ Crests</name>
    <alias>Гарри поттер</alias>
    <alias>Хогвартс</alias>
  </offer>
  ...     
</offers>

Вывод таба "Бренды" в приложении

В фиде создается категория бренды, в нее вкладываются подкатегории-бренды. Если какие-то бренды не вложены в основную категорию-они не отобразятся во вкладке.

Если во вкладке с брендами необходимо сделать разделение на сегменты (например: мужчинам, женщинам, детям).

<category id="1">Бренды</category>
<category id="brands_679" parentId="1" picture="https://xxx.ru/xxx.jpg">Дети</category>
<category id="brands_678" parentId="1" picture="https://xxx.ru/xxx.jpg">Женщины</category>
<category id="brands_677" parentId="1" picture="https://xxx.ru/xxx.jpg">Мужчинам</category>

Для вывода "Топ брендов" нужно передать бренды в том порядке, в котором они должны быть отображены:

<category id="1">Бренды</category>
<category id="brands_679" parentId="1" picture="https://xxx.ru/xxx.jpg">Дети</category>
 <category id="brands_679455" parentId="brands_6799" picture="https://xxx.ru/xxx.jpg">Balmain</category>
 <category id="brands_679456" parentId="brands_6799" picture="https://xxx.ru/xxx.jpg">Burberry</category>
 ...
<category id="brands_678" parentId="1" picture="https://xxx.ru/xxx.jpg">Женщины</category>
<category id="brands_679457" parentId="brands_6798" picture="https://xxx.ru/xxx.jpg">>Relaxsan</category>
<category id="brands_679458" parentId="brands_6798" picture="https://xxx.ru/xxx.jpg">>Anita</category>
...

Перелинковка товаров

Перелинковка на карточке товара позволяет отобразить параметры на выбор юзера по клику на которые юзер переходит на подходящую конфигурацию товара.

  • interlinkingParam - название параметра по которому происходит линковка (цвет, памят, жесткость)

  • value - значение конфигурации которое выбирает юзер, если есть color то выводится в виде цветного кружка

  • groupID - id конфигурации на которую линкуем пользователя, может быть передан groupID или id товара.

Товары между которыми происходит линк не могут быть в одной группе товаров

<offer available="true" publishedOn="2018-09-12" id="1033089" group_id="31063-FEF5EC" itemPreviewUrl="https://webgl.elarbis.com/viewer/index.html?vendor=askona&amp;model=gracia_krovat_160_s_pm" fraction="1">
        <name>Кровать с подъемным механизмом Gracia</name>
        <vendor>Askona</vendor>
        <typePrefix>Кровать с подъемным механизмом</typePrefix>
        <sort>1</sort>
        <categoryId>1860669</categoryId>
        <picture>https://cdn.askona.ru/upload/resize_cache/feed_images/400x225/krovati_gracia-pm_graciaa.webp</picture>
        <currencyId>RUR</currencyId>
        <description>Благородство и статус, нежность и романтичность   вот, что сочетает в себе новая кровать Грация от Askona  Модель, выполненная в классическом стиле, имеет самый высокий периметр (39 см) среди остальных моделей нашего ассортимента, что добавляет ей величия  Высокая спинка кровати с мягкими утяжками обрамлена массивной фигурной рамой, которая буквально притягивает взгляд, подчеркивая изысканный стиль комнаты  Возможность выбора расцветки обивочного материала дает простор фантазии для оформления Вашей спальни  Комплектация решеткой или подъемным механизмом  Высота спинки   151 см</description>
        <rating>5</rating>
        <reviews_count>3</reviews_count>
        <model>Gracia</model>
        <othercolors>31063-989CA3,31063-FFC0CB,31063-D9D7D8,31063-FFE2C2,31063-0529DC,31063-79DBFF,31063-CC9933,31063-854629,31063-21929E,31063-CC061D,31063-19904B,31063-A162A1</othercolors>
        <price>101972</price>
        <oldprice>196100</oldprice>
        <param name="Цвет">Белый</param>
        <param name="Размер спального места" unit="см">200x200</param>
        <param name="Тип ткани">Велюр</param>
        <interlinking>
          <interlinkingParam name="Цвет">
            <interlinkingParamValue value="Белый" groupId="31063-FEF5EC" color="#FEF5EC"/>
            <interlinkingParamValue value="Темно-серый" groupId="31063-989CA3" color="#989CA3"/>
            <interlinkingParamValue value="Розовый" groupId="31063-FFC0CB" color="#FFC0CB"/>
            <interlinkingParamValue value="Светло-серый" groupId="31063-D9D7D8" color="#D9D7D8"/>
            <interlinkingParamValue value="Бежевый" groupId="31063-FFE2C2" color="#FFE2C2"/>
            <interlinkingParamValue value="Синий" groupId="31063-0529DC" color="#0529DC"/>
            <interlinkingParamValue value="Голубой" groupId="31063-79DBFF" color="#79DBFF"/>
            <interlinkingParamValue value="Желтый" groupId="31063-CC9933" color="#CC9933"/>
            <interlinkingParamValue value="Коричневый" groupId="31063-854629" color="#854629"/>
            <interlinkingParamValue value="Бирюзовый" groupId="31063-21929E" color="#21929E"/>
            <interlinkingParamValue value="Красный" groupId="31063-CC061D" color="#CC061D"/>
            <interlinkingParamValue value="Зеленый" groupId="31063-19904B" color="#19904B"/>
            <interlinkingParamValue value="Сиреневый" groupId="31063-A162A1" color="#A162A1"/>
          </interlinkingParam>
        </interlinking>
      </offer>
PreviousФид наличия товаровNextПередача наличия и цен по регионам, персональные цены, cashback

Last updated