Specifkace XML feedu pro import produktů

XML feed je připravený pro výrobce, prodejce nebo katalogy. Je možné v tomto vašem feedu definovat základní údaje produktů, které budou zobrazeny v TryIn katalogu pro hodnocení uživateli, testování a vyhledávání.

Poslední modifikace XML

Doporučujeme uvádět HTTP hlavičku "Last-Modified" pro kontrolu, zda se soubor změnil od posledního importování. Tímto způsobem se předchází nevýznamné zátěži na obou stranách z důvodu stahování a zpracování nezměněných XML souborů.

Vytvořený XML soubor je nutné mít dostupný pro TryIn, který je stahován s danou frekvencí, která je udávána v hodinách. V tuto chvíli je tento proces plánován jednou denně (je ale možné nastavit i nižší hodnutu než 24 hodin, která zatím bude v pozadí nahrazená právě hodnotou 24 hodin). Velikost souboru je omezena na 150MB (cca 250 000 záznamů).

Feed musí být dostupný z těchto rozsahů IP adres:
  • 77.78.97.112/28
  • 81.0.231.96/28

Popis elementů

Zde jsou popsány jednotlivé elementy XML feedu. Dále je možné vycházet ze samotného XSD, které se používá pro prvotní kontrolu korektnosti daného feedu.

Hlavička: <?xml version="1.0" encoding="UTF-8"?> povinný

Definice xml a enkódování daného dokumentu.

<PRODUCTSFEED VERSION="1"> povinný

Kořenový element, který definuje verzi dané specifikace. Dále definuje xsd, podle které se dokument validuje.

<PRODUCTS> - výpis produktů povinný

Obalovací element pro následný výčet produktů.

<PRODUCT> - definice product povinný

Element pro jednotlivé produkty.

<ID> - interní identifikátor povinný

Identifikátor daného produktu v zdrojové databázi. Na základě tohoto identifikátoru je možné aktualizvoat jednotlivé záznamy produktů.

Může obsahovat alfanumerické znaky.

<NAME> - název produktu povinný

Název produktu. Maximální délka je 200 znaků. Pokud jsou v souboru duplicitní jména, budou všechny ignorovány kromě první zpracované.

Je doporučené se držet obecného pojmenování: Výrobce - produktová řada - produktové označení - varianta

<DESCRIPTION> - popis produktu

Popis produktu v podobě plain textu nebo je možné použít markdown syntaxi.

Nejsou dovoleny odkazy na cizí stránky nebo reklamní texty na internetové obchody. Popis dále nesmí obsahovat nadmíru se opakující se klíčová slova nebo fráze.

<BRAND> - značka povinný

Pro přesné zařazení uvádějte ID značky v TryIn přímo v těle elementu, pro pokus o napárování nebo vytvoření nové značky stačí zadat do těla elementu název.

<BRAND [ID="TryIn Id značky"]>Jméno značky</BRAND>

Maximální délka jména je 150 znaků.

<CATEGORY> - kategorie povinný

Pro přesné zařazení uvádějte ID kategorie v TryIn přímo v těle elementu, pro pokus o napárování kategori stačí zadat do těla elementu název. Je také možné místo jména zadat celou cestu kategorie, kde jsou dané kategorie odděleny svislítkem (tzv. pipe).
Elektronika | Chytré hodinky a příslušenství | Chytré hodinky

<CATEGORY [ID="TryIn Id kategorie"]>Jméno kategorie</CATEGORY>

Maximální délka jména je 150 znaků.

<MANUFACTURER> - výrobce

Pro přesné zařazení uvádějte ID výrobce v TryIn přímo v těle elementu, pro pokus o napárování nebo vytvoření nového výrobce stačí zadat do těla elementu název.

<MANUFACTURER [ID="TryIn Id výrobce"]>Jméno výrobce</MANUFACTURER>

Maximální délka jména je 200 znaků.

<NUMBER> - produktové číslo

Může obsahovat alfanumerické znaky.

<GROUPINGID> - slučovací identifikátor

Označení skupiny produktů, které jsou si navzájem variantami. Například barevné variace trička nebo rozdílné kapacity uložistě stejného typu mobilního telefonu.

Může obsahovat alfanumerické znaky.

<CODE> - EAN a ISBN

EAN: Platný EAN13 kód výrobku. Musí se jednat o validní kód včetně kontrolní číslice.

ISBN: ISBN alfanumerický kód určený pro jednoznačnou identifikaci knižních vydání. Formáty ISBN-10 a ISBN-13.

<ATTRIBUTES> - parametry produktu

Element ATTRIBUTES obsahuje opakující se element ATTRIBUTE, který definuje jednotlivé parametry daného produktu. Je nutné uvést buď ID (TryIn Id atributu) nebo pouze jméno, které se automaticky/manuálně pokusíme napárovat/vytvořit.

  • VAL - hodnota atributu. Tento element je povinný a může obsahovat alfanumerické znaky.
  • UNIT - jedná se o jednotu daného parametru. Tento element je nepovinný.

<IMAGES> - hlavní fotografie

Uvnitř elementu se nachází element IMAGE a jejím atributu URL je url adresa obrázku produktu

<IMAGE URL="https://domena.cz/images/products/1254875.png"/>

<RELEASEDATE> - datum vydání

Datum počátku prodeje produktu v ČR ve formátu YYYY-MM-DD

<PRODUCTURL> - odkaz na produkt (týká se pouze výrobce)

Slouží pouze pro odkazování na oficiální produktovou web adresu.

Ukázka XML dokumentu

Zde je struktura s vysvětlujícími pojmy. V případě hodnot v [] (např. [ID="TryIn Id značky"]) se jedná o nepovinný parametr, ale doporučený pro bezproblémové párování a dokazuje do čísleníků našich značek, výrobců, kategorií a parametrů

              
                <?xml version="1.0" encoding="UTF-8"?>
                <PRODUCTSFEED VERSION="1"
                  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                  xsi:noNamespaceSchemaLocation="https://tryin.cz/schemas/tryinfeed.xsd">
                  <PRODUCTS>
                    <PRODUCT>
                      <ID>Identifikátor v DB partnera</ID>
                      <NAME>Produktové jméno</NAME>
                      <DESCRIPTION>Popis produktu</DESCRIPTION>
                      <BRAND [ID="TryIn Id značky"]>Jméno značky</BRAND>
                      <CATEGORY [ID="TryIn Id kategorie"]>Jméno/cesta kategorie</CATEGORY>
                      <MANUFACTURER [ID="TryIn Id výrobce"]>Jméno výrobce</MANUFACTURER>
                      <NUMBER>Produktové číslo od výrobce</NUMBER>
                      <GROUPINGID>Číslo pro indikaci propojení stejných produktů</GROUPINGID>
                      <CODE>
                        <EAN>EAN produktu</EAN>
                        <ISBN>ISBN knihy</ISBN>
                      </CODE>
                      <ATTRIBUTES>
                        <ATTRIBUTE [ID="TryIn Id atributu" | NAME="Jméno atributu"]>
                          <VAL>Hodnota atributu</VAL>
                          <UNIT>Jednotka atributu</UNIT>
                        </ATTRIBUTE>
                      </ATTRIBUTES>
                      <IMAGES>
                        <IMAGE URL="URL obrázku"/>
                      </IMAGES>
                      <RELEASEDATE>2015-02-25</RELEASEDATE>
                      <PRODUCTURL>URL produktu (pouze od výrobce)</PRODUCTURL>
                    </PRODUCT>
                  </PRODUCTS>
                </PRODUCTSFEED>
                        
              

XML feed může vypadat například takto:

            
              <?xml version="1.0" encoding="UTF-8"?>
              <PRODUCTSFEED VERSION="1"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                xsi:noNamespaceSchemaLocation="https://tryin.cz/schemas/tryinfeed.xsd">
                <PRODUCTS>
                  <PRODUCT>
                    <ID>kd1547</ID>
                    <NAME>Dell XPS 15 9500</NAME>
                    <DESCRIPTION>Nová generace neuvěřitelně kompaktního 15.6" notebooku se špičkovým displejem InfinityEdge.</DESCRIPTION>
                    <BRAND>DELL</BRAND>
                    <CATEGORY ID="107"></CATEGORY>
                    <MANUFACTURER>DELL</MANUFACTURER>
                    <NUMBER>TN-9500-N2-712S</NUMBER>
                    <GROUPINGID>1</GROUPINGID>
                    <CODE>
                      <EAN>5397184433454</EAN>
                    </CODE>
                    <ATTRIBUTES>
                      <ATTRIBUTE NAME="Úhlopříčka displeje">
                        <VAL>15,6"</VAL>
                      </ATTRIBUTE> 
                      <ATTRIBUTE NAME="Operační paměť">
                        <VAL>32</VAL>
                        <UNIT>GB</UNIT>
                      </ATTRIBUTE>
                      <!-- záznam dalšího parametru... -->
                      </ATTRIBUTE>
                      <!-- ... -->
                    </ATTRIBUTES>
                    <IMAGES>
                      <IMAGE URL="https://adresa.cz/obrazky/dell9500.jpg"/>
                    </IMAGES>
                    <RELEASEDATE>2015-02-25</RELEASEDATE>
                    <PRODUCTURL>https://www.dell.com/cz/p/xps-15-9500-laptop/pd</PRODUCTURL>
                  </PRODUCT>
                  <!-- záznam dalšího produktu... -->
                  </PRODUCT>
                  <!-- ... -->
                </PRODUCTS>
              </PRODUCTSFEED>