Základní pravidla

  • XML se používá pro import do UPgates i export z UPgates
  • můžete se podívat na prázdné vzorové XML
  • k testování struktury XML je možno použít naše XSD
  • tagy končící na _YN> jsou typu boolean a mohou hodnoty 0, 1, true, false
  • tagy reprezentující datum (většinou končící na _FROM> nebo _TO>) používají formát YYYY-MM-DD, kde Y je rok, M je měsíc a D je den (např. 2017-03-07)
  • atributy language označující jazykovou mutaci používají kódy podle ISO 639-1 a jsou povinné

Import

  • neuvádějte prázdné obalové tagy (např. tag <IMAGES>, pokud neobsahuje žádné obrázky)
  • v případě editace se prázdný tag chápe jako vymazání původní hodnoty v databázi
  • produkty, varianty a kategorie se při importu párují podle kódu (tag <CODE>). Pokud chcete produkty a varianty importem aktualizovat, musí být tagy <CODE> vyplněny
  • všechny tagy jsou nepovinné, kromě kořenových tagů <PRODUCTS> a <PRODUCT>. Při importu nových produktů (nebo při založení další jazykové mutace produktu) je povinný tag <TITLE> (s celou nadřezenou strukturou), protože z názvu produktu se tvoří URL. Ve variantách jsou pak povinné parametry, opět pouze při importu nových variant. Dále je všude povinný atribut language.
  • pokud budete chtít produkty aktualizovat, musí být vyplněny tagy <CODE> u produktů a u variant, jinak se budou zakládat při každém importu nové produkty
  • tagy které mohou obsahovat HTML formátování je možno zapsat buď převedeno do HTML entit, nebo pomocí CDATA (<![CDATA[ <h1>Nadpis</h1> ]]>)
  • číslelné hodnoty se uvádí nezformátované bez znaku jednotky (např. ceny, hmotnost nebo DPH). Jako oddělovač desetinných míst použijte tečku nebo čárku.
  • další chování importu můžete ovlivnit nastavením v administraci
  • více informací o importu najdete v článku Import dat do e-shopu

Export

  • exportují se všechny tagy z výjimkou tagů s prázdnou hodnotou, ty mohou v exportu chybět, u některých je uvedeno že jsou pouze pro import nebo export
  • export z jednoho projektu UPgates je možno použít pro import do jiného projetu UPgates

Struktura XML

  • <PRODUCTS>
    • version - verze formátu XML, aktuálně je to 1.0
    • <PRODUCT>
      • last_update_time - datum poslední aktualizace produktu (pouze import) ve formátu Y-m-dTH:i:s (např. 2017-03-07T13:35:08). Pokud bude při importu toto datum starší než datum poslední aktualizace produktu v databázi, produkt se přeskočí.
      • <CODE> - kód produktu, páruje se podle existující hodnoty v databázi, nebo vytvoří nový produkt
      • <PRODUCT_ID> - interní ID produktu (pouze export)
      • <ACTIVE_YN> - zobrazit produkt na webu
      • <ARCHIVED_YN> - archivovaný produkt
      • <REPLACEMENT_PRODUCT_CODE> - kód náhradního produktu, pouze pokud je produkt archivovaný
      • <CAN_ADD_TO_BASKET_YN> - lze vložit do košíku
      • <NEW_YN> - zobrazení příznaku Novinka
      • <NEW_FROM> - datum, od kterého se zobrazí příznak Novinka
      • <NEW_TO> - datum, do kterého je zobrazen příznak Novinka
      • <SPECIAL_YN> - zobrazení příznaku Akce
      • <SPECIAL_FROM> - datum, od kterého se zobrazí příznak Akce
      • <SPECIAL_TO> - datum, do kterého je zobrazen příznak Akce
      • <SELLOUT_YN> - zobrazení příznaku Výprodej
      • <SELLOUT_FROM> - datum, od kterého se zobrazí příznak Výprodej
      • <SELLOUT_TO> - datum, do kterého je zobrazen příznak Výprodej
      • <LABELS>- štítky
        • <LABEL>
          • <NAME> - název štítku, páruje se podle existující hodnoty v databázi, nebo vytvoří novou
          • <ACTIVE_YN> - aktivní
          • <ACTIVE_FROM> - datum od kterého bude štítek aktivní
          • <ACTIVE_TO> - datum do kterého bude štítek aktivní
      • <DESCRIPTIONS>- texty
        • <DESCRIPTION>
          • language - specifikace jazykové mutace
          • <ACTIVE_YN> - aktivní v jazykové mutaci, pokud se neuvede tak se bere jako aktivní. Použitelné pouze pro deaktivaci jazykové mutace (skrytí produktu v jazykove mutaci)
          • <URL> - URL produktu
          • <TITLE> - název (POVINNÝ v případě vytváření nového produktu). Pokud není definovaný, nezaloží se ani jazyková mutace produktu (související data se přeskočí)
          • <SHORT_DESCRIPTION> - krátký popis, bez HTML formátování
          • <LONG_DESCRIPTION> - dlouhý popis, může obsahovat formátování pouze pomocí HTML značek
      • <SEO_OPTIMALIZATION>- SEO
        • <SEO>
          • language - specifikace jazykové mutace
          • <SEO_URL> - vlastní koncovka URL adresy
          • <SEO_TITLE> - SEO titulek produktu
          • <SEO_META_DESCRIPTION> - META popisek stránky produktu
          • <SEO_KEYWORDS> - klíčová slova stránky produktu, oddělená čárkou
      • <MANUFACTURER> - název výrobce, páruje se podle existující hodnoty v databázi, nebo vytvoří novou
      • <MANUFACTURER_IMAGE_URL> - URL na obrázek výrobce (pouze import)
      • <MANUFACTURER_DESCRIPTIONS> - popisy výrobce (pouze import)
        • <DESCRIPTION>
          • language - specifikace jazykové mutace
      • <SUPPLIER_CODE> - kód u dodavatele
      • <EAN> - čárkový kód
      • <AVAILABILITY> - název dostupnosti, páruje se podle existující hodnoty v databázi, nebo vytvoří novou. Neimportuje se u položek s nastavením dostupnosti dle stavu zásob. Pokud však v tomto případě stav zásob není definován (tag <STOCK> musí být prázdný nebo úplně chybět), dostupnost se importuje
      • <STOCK> - počet jednotek na skladě, v případě mínusové hodnoty se zapíše 0
      • <WEIGHT> - hmotnost v gramech
      • <UNIT> - název měrné jednotky, páruje se podle stejné hodnoty, nebo založí novou
      • <SHIPMENT_GROUP> - skupina doprav, páruje se podle stejné hodnoty, nebo založí novou
      • <VATS>- DPH
        • <VAT>- páruje se podle existující hodnoty v databázi, nebo vytvoří novou. Pokud není vyplněno bere se výchozí DPH pro daný jazyk
          • language - specifikace jazykové mutace
      • <LENGTH>- množtví
        • <ACTIVE_YN> - aktivní
        • <LABELS>- popisky
          • <LABEL>
            • language - specifikace jazykové mutace
        • <LENGTH_FROM> - minimální množství
        • <LENGTH_TO> - maximální množství
        • <UNIT> - název měrné jednotky, páruje se podle stejné hodnoty, nebo založí novou
        • <STEPS_TYPE>- typ krokování metřáže, možné hodnoty:
          • neither - žádné krokování, výchozí
          • multiples - násobky
          • select - výběr z možností
        • <STEPS>- hodnota podle typu krokování:
          • neither - může být prázdné
          • multiples - hodnota násobku
          • select - každá hodnota na nový řádek
        • <NOTE> - poznámka
      • <PRIVATE_YN> - zobrazit produkt pouze přihlášeným uživatelům
      • <PRIVATE_CUSTOMERS_ONLY_YN> - zobrazit pouze uživatelům, kteří mohou vidět skryté stránky
      • <GROUPS>- skupiny
        • <GROUP> - název skupiny
      • <CATEGORIES>- kategorie
        • <CATEGORY
          • <CODE> - kód kategorie, do které bude produkt zařazen. V případě, že se vyskytne více stejných kódů kategorie v jednom produktu, zpracuje se první v pořadí. Páruje se podle existujícího kódu kategorie
          • <NAME> - název kategorie, do které je produkt zařazen (export)
          • <PRIMARY_YN> - informace, zda je kategorie primární. V případě, že se vyskytne více primárních kategorií v jednom produktu, bere se první v pořadí
          • <POSITION> - pozice produktu v kategorii
      • <PRICES>- ceny
        • <PRICE>
          • language - specifikace jazykové mutace
          • <PRICELISTS>- ceníky
            • <PRICELIST>
              • <NAME> - název ceníku, pokud je při importu prázdné, chápe se jako výchozí ceník
              • <PRICE_ORIGINAL> - původní cena, základní ceníková cena od které se odvozují další
              • <PRODUCT_DISCOUNT> - sleva na produkt v procentech
              • <PRODUCT_DISCOUNT_REAL> - reálná sleva na produkt použitá pro výpočet výsledné ceny (pouze export), vypočítává se takto:
                • hodnota slevy na produkt (<PRODUCT_DISCOUNT>) + sleva na výrobce + sleva na kategorii (bere se sleva z hlavní kategorie ve které je produkt zařazen). Výsledná hodnota slevy se omezí na hodnotu z nastavení Maximální procento slevy.
              • <PRICE_SALE> - akční cena, exportuje se pouze tehdy, pokud je produkt v akci (štítek akce)
              • <PRICE_WITH_VAT> - koncová cena s DPH (pouze export)
              • <PRICE_WITHOUT_VAT> - koncová cena bez DPH (pouze export)
          • <PRICE_PURCHASE> - nákupní cena, interní údaj pro orientaci administrátora
          • <PRICE_COMMON> - běžná cena, pro orientaci při nákupu, může to být např. cena v kamenných obchodech
          • <CURRENCY> - měna (pouze export)
      • <IMAGES>- obrázky
        • <IMAGE>
          • <URL> - URL adresa obrázku
          • <TITLES>- popisky obrázku
            • <TITLE>
              • language - specifikace jazykové mutace
          • <MAIN_YN> - obrázek je hlavní, v případě, že se vyskytne více hlavních obrázků v jednom produktu, zpracovává se první v pořadí
          • <LIST_YN> - obrázek je seznamový, v případě, že se vyskytne více seznamových obrázků v jednom produktu, zpracovává se první v pořadí
      • <FILES>- soubory
        • <FILE>
          • <URL> - URL adresa souboru
          • <TITLES>- popisky souboru
            • <TITLE>
              • language - specifikace jazykové mutace
      • <BENEFITS>- benefity
        • <BENEFIT>
          • <NAME> - název benefitu, páruje se podle existující hodnoty v databázi (v hlavním jazyku), nebo vytvoří novou
      • <PARAMETERS>- parametry
        • <PARAMETER>
          • <NAME> - název parametru, páruje se podle existující hodnoty v databázi (v hlavním jazyku), nebo vytvoří novou
          • <VALUE> - hodnota parametru, v případě, že se vyskytne více stejných hodnot parametru v jednom produktu, zpracovává se první v pořadí. Páruje se podle existující hodnoty v databázi, nebo vytvoří novou
          • <IMAGE_URL> - URL obrázku, v případě že bude uveden, nastaví se parametr jako obrázkový
      • <CONFIGURATIONS>- konfigurace
        • <CONFIGURATION>
          • type- typ konfigurace:
            • one_value - možno vybrat pouze jednu hodnotu (select)
            • more_values - možno vybrat více hodnot (checkboxy)
            • group - skupina konfigurací, v tagu <NAME> musí být název skupiny který je uveden v administraci. Pokud je typ konfigurace group neuvádí se hodnota <VALUE>
            • text - jako hodnota je použito textové pole (textarea), nemá hodnotu <VALUE>
            • separator - oddělovač, nemá hodnotu <VALUE>
          • <NAME> - název parametru konfigurace, páruje se podle existující hodnoty v databázi (v hlavním jazyku), nebo vytvoří novou (neplatí pokud je typ konfigurace group)
          • <VALUE>- hodnota parametru konfigurace, páruje se podle existující hodnoty v databázi, nebo vytvoří novou (může být uvedeno vícekrát)
            • <NAME> - název hodnoty
            • <IMAGE_URL> - URL obrázku, v případě že bude uveden, nastaví se parametr jako obrázkový
            • <DEFAULT_YN> - výchozí hodnota parametru konfigurace
            • <PRICE>- cena (nepovinné)
              • language - specifikace jazykové mutace
              • operation- operace která se provede s cenou poduktu při vybrání hodnoty, povolené hodnoty jsou:
                • + sčítání (výchozí)
                • - odčítání
                • * násobení
                • / dělení
      • <VARIANTS>- varianty
        • <VARIANT
          • <CODE> - kód varianty, páruje se podle existující hodnoty v databázi, nebo vytvoří novou
          • <MAIN_YN> - výchozí varianta, v případě, že se vyskytne více výchozích variant v jednom produktu, bere se první v pořadí
          • <ACTIVE_YN> - zobrazit variantu na webu
          • <CAN_ADD_TO_BASKET_YN> - lze vložit do košíku
          • <SUPPLIER_CODE> - kód u dodavatele
          • <EAN> - čárkový kód
          • <NEW_YN> - zobrazení příznaku Novinka
          • <NEW_FROM> - datum, od kterého se zobrazí příznak Novinka
          • <NEW_TO> - datum, do kterého je zobrazen příznak Novinka
          • <SPECIAL_YN> - zobrazení příznaku Akce
          • <SPECIAL_FROM> - datum, od kterého se zobrazí příznak Akce
          • <SPECIAL_TO> - datum, do kterého je zobrazen příznak Akce
          • <SELLOUT_YN> - zobrazení příznaku Výprodej
          • <SELLOUT_FROM> - datum, od kterého se zobrazí příznak Výprodej
          • <SELLOUT_TO> - datum, do kterého je zobrazen příznak Výprodej
          • <LABELS>- štítky variant
            • <LABEL>
              • <NAME> - název štítku. Páruje se podle existující hodnoty v databázi, nebo vytvoří novou.
              • <ACTIVE_YN> - aktivní
              • <ACTIVE_FROM> - datum od kterého bude štítek aktivní
              • <ACTIVE_TO> - datum do kterého bude štítek aktivní
          • <AVAILABILITY_NOTES>- poznámky k dostupnosti
            • <AVAILABILITY_NOTE>
              • language - specifikace jazykové mutace
          • <AVAILABILITY> - název dostupnosti, páruje se podle existující hodnoty v databázi, nebo vytvoří novou. Neimportuje se u položek s nastavením dostupnosti dle stavu zásob. Pokud však v tomto případě stav zásob není definován (tag <STOCK> musí být prázdný nebo úplně chybět), dostupnost se importuje
          • <STOCK> - počet jednotek na skladě. V případě mínusové hodnoty se zapíše 0
          • <WEIGHT> - hmotnost v gramech (pro výběr dopravy)
          • <IMAGE_URL> - URL adresa obrázku
          • <PARAMETERS>- parametry variant
            • <PARAMETER>
              • <NAME> - název parametru. V případě, že se vyskytne více stejných názvů parametru v jednom produktu, bere se první v pořadí. Páruje se podle existující hodnoty v databázi (v hlavním jazyku), nebo vytvoří novou
              • <VALUE> - hodnota parametru. V případě, že se vyskytne více stejných hodnot parametru v jednom produktu, zpracovává se první v pořadí. Páruje se podle existující hodnoty v databázi (v hlavním jazyku), nebo vytvoří novou
              • <IMAGE_URL> - URL obrázku, v případě že bude uveden, nastaví se parametr jako obrázkový
          • <PRICES>- ceny
            • <PRICE>
              • language - specifikace jazykové mutace
              • <PRICELISTS>- ceníky
                • <PRICELIST>
                  • <NAME> - název ceníku, pokud je při importu prázdné, chápe se jako výchozí ceník
                  • <PRICE_ORIGINAL> - základní cena
                  • <PRODUCT_DISCOUNT> - procentní sazba slevy pro produkt
                  • <PRODUCT_DISCOUNT_REAL> - reálná hodnota slevy použitá pro výpočet výsledné ceny (pouze export), vypočítává se takto:
                    • hodnota slevy na produkt (<PRODUCT_DISCOUNT>) + sleva na výrobce + sleva na kategorii (bere se sleva z hlavní kategorie ve které je produkt zařazen). Výsledná hodnota slevy se omezí na hodnotu z nastavení Maximální procento slevy.
                  • <PRICE_SALE> - akční cena, exportuje se pouze tehdy, pokud je produkt v akci (štítek akce)
                  • <PRICE_WITH_VAT> - koncová cena s DPH (pouze export)
                  • <PRICE_WITHOUT_VAT> - koncová cena bez DPH (pouze export)
              • <PRICE_PURCHASE> - nákupní cena, interní údaj pro orientaci administrátora
              • <PRICE_COMMON> - běžná cena, pro orientaci při nákupu, může to být např. cena v kamenných obchodech
              • <CURRENCY> - měna (pouze export)
          • <METAS>- vlastní pole variant
            • <META>
              • type - typ vlastního pole, možné hodnoty: radio, checkbox, input, date, email, number, select, multiselect, textarea (výchozí), formatted
              • <META_KEY>- Klíč vlastního pole - povolené znaky jsou malá písmena, čísla (nesmí být na první pozici) a podtržítko
                • <META_VALUE> - hodnota vlastního pole, uvádí se pokud je stejná pro všechny jazykové mutace
                • <META_VALUES>- hodnoty vlastního pole pro jednotlivé jazykové mutace
                  • <META_VALUE>
                    • language - specifikace jazykové mutace
      • <RELATED_PRODUCTS>- související produkty
        • <CODE> - kód souvisejícího produktu, páruje se podle existující hodnoty v databázi
      • <ALTERNATIVE_PRODUCTS>- alternativní produkty
        • <CODE> - kód alternativního produktu, páruje se podle existující hodnoty v databázi
      • <ACCESSORIES>- příslušenství
        • <CODE> - kód produktu příslušenství, páruje se podle existující hodnoty v databázi
      • <GIFTS>- dárky
        • <CODE> - kód dárku k produktu, páruje se podle existující hodnoty v databázi
      • <SETS>- sada
        • <CODE> - kód produktu, páruje se podle existující hodnoty v databázi
      • <METAS>- vlastní pole
        • <META
          • type - typ vlastního pole, možné hodnoty: radio, checkbox, input, date, email, number, select, multiselect, textarea (výchozí), formatted
          • <META_KEY>- Klíč vlastního pole - povolené znaky jsou malá písmena, čísla (nesmí být na první pozici) a podtržítko
            • <META_VALUE> - hodnota vlastního pole, uvádí se pokud je stejná pro všechny jazykové mutace
            • <META_VALUES>- hodnoty vlastního pole pro jednotlivé jazykové mutace
              • <META_VALUE>
                • language - specifikace jazykové mutace