Dokumentácia XML - kategórie

Základné pravidlá

• XML kategórií sa používa pre import aj export z Upgates.
• Tu je k náhľadu prázdne vzorové XML.
• Na testovanie štruktúry XML je možné použiť naše XSD.
• Tagy končiace na _YN> sú typu boolean a môžu nadobúdať hodnoty 0, 1, true, false.
• Dátum je zapísaný ako reťazec znakov vo formáte YYYY-MM-DD podľa ISO 8601. Y je rok, M je mesiac a D je deň. Príklad: 2020-12-30.
• Atribúty language označujúce jazykovú mutáciu používajú kódy podľa ISO 639-1 a sú povinné.

Import

• Neuvádzajte prázdne obalové tagy (napr. tag <IMAGES>, pokiaľ neobsahuje žiadne obrázky).
• V prípade editácie (pri importe) sa prázdny tag chápe ako vymazanie pôvodnej hodnoty v databáze.
• Kategórie sa pri importe párujú podľa kódu kategórie (tag <CODE>). Pokiaľ chcete kategórie aktualizovať, musia byť tagy <CODE> vyplnené.
• Všetky tagy sú nepovinné, okrem koreňových tagov <CATEGORIES> a <CATEGORY>. Pri importe nových kategórií je povinný tag <NAME> (s celou nadradenou štruktúrou), pretože z názvu kategórie sa tvorí URL. Ďalej je všade povinný atribút language.
• Tagy, ktoré môžu obsahovať HTML formátovanie je možné zapísať buď ako prevedené do HTML entit alebo pomocou CDATA (<![CDATA[ ]]>).
• Číselné hodnoty sa uvádzajú nenaformátované bez znaku jednotky (napr. ceny, hmotnosť alebo DPH). Pre zápis môžete použiť buď desatinnú bodku alebo čiarku.
• Ďalšie správanie importu môžete ovplyvniť nastavením v administrácii (viď nápoveda).

Export

• Exportujú sa všetky tagy s výnimkou tagov s prázdnou hodnotou. Tie môžu v exporte chýbať.
• Export z jedného e-shopu Upgates je možné použiť pre import do iného e-shopu Upgates.

Štruktúra XML

• <CATEGORIES>
• version - verzia formátu XML, aktuálne je to 1.0
• <CATEGORY>
• <CODE> - Kód kategórie
• <CATEGORY_ID> - ID kategórie, unikátny identifikátor kategórie, používa sa pre zaradenie kategórií do stromu
• <PARENT_ID> - ID nadradenej kategórie, unikátny identifikátor nadradenej kategórie (<CATEGORY_ID> inej kategórie), používa sa pre zaradenie kategórií do stromu. Pokiaľ budete chcieť zaradiť kategórie do horného menu bude hodnota "1", ľavé menu "2" a spodné menu "3". Pokiaľ bude prázdne, vloží sa do kategórie podľa nastavenia importu.
• <POSITION> - Číselná hodnota pozície v zozname (v nadradenej kategórii)
• <ACTIVE_YN> - Zobraziť kategóriu na webe
• <TYPE> - Typ kategórie, možné hodnoty:
• homepage - odkaz na hlavnú stránku
• news - odkaz na aktuality
• individual - odkaz na samostatnú stránku
• url - externý odkaz
• site - stránka
• siteWithProducts - stránka s produktmi
• linkCategory - odkaz na kategóriu
• advisor - odkaz na radcu
• <TYPE_OF_ITEMS> - Typ položiek, možné hodnoty:
• withoutSubcategories - bez podkategórií (východisková, v kategórii budú ručne vložené produkty)
• label - štítok (v kategórii budú produkty, ktoré majú aktívny určený štítok)
• manufacturer - výrobca (v kategórii budú produkty, ktoré majú určeného výrobcu)
• <MANUFACTURER> - Názov výrobcu. Páruje sa podľa existujúcej hodnoty v databáze, alebo vytvorí novú. Berie sa do úvahy len pokiaľ je hodnota tagu <TYPE_OF_ITEMS> manufacturer.
• <LABEL> - Názov štítka. Páruje sa podľa existujúcej hodnoty v databáze, alebo vytvorí novú. Berie sa do úvahy len pokiaľ je hodnota tagu <TYPE_OF_ITEMS> label.
• <SHOW_IN_MENU_YN> - Zobraziť kategóriu v menu
• <CUSTOMER_GROUPS> - Zobraziť kategóriu len vybranej skupine zákazníkov
• <GROUP> - Názov skupiny
• <DESCRIPTIONS> - Texty
• <DESCRIPTION>
• language - Špecifikácie jazykovej mutácie
• <ACTIVE_YN> - Aktívne v jazykovej mutácii, pokiaľ sa neuvedie tak sa berie ako aktívne. Použiteľné len pre deaktiváciu v jazykovej mutácii.
• <NAME> - Názov kategórie
• <NAME_H1> - Nadpis stránky v kategórii
• <DESCRIPTION_TEXT> - Text stránky
• <URL> - URL kategória
• <LINK_URL> - URL adresa, na ktorú bude viesť kategória. Berie sa do úvahy len pokiaľ je hodnota tagu <TYPE> linkCategory.
• <SEO_OPTIMALIZATION> - SEO
• <SEO>
• language - Špecifikácie jazykovej mutácie
• <SEO_URL> - Vlastná koncovka URL adresy
• <SEO_TITLE> - SEO titulok produktu
• <SEO_META_DESCRIPTION> - META popis stránky produktu
• <IMAGES> - Obrázky
• <IMAGE>
• <URL> - URL adresa obrázka
• <TITLES> - Popisky obrázka
• <TITLE>
• language - Špecifikácie jazykovej mutácie
• <MAIN_YN> - Obrázok je hlavný. V prípade, že sa vyskytne viac hlavných obrázkov v jednom produkte, spracováva sa prvý v poradí
• <LIST_YN> - Obrázok je zoznamový. V prípade, že sa vyskytne viac zoznamových obrázkov v jednom produkte, spracováva sa prvý v poradí
• <POSITION> - Pozícia obrázka
• <FILES> - Súbory
• <FILE>
• <URL> - URL adresa súboru
• <TITLES> - Popisky súborov
• <TITLE>
• language - Špecifikácie jazykovej mutácie
• <POSITION> - Pozícia súboru
• <METAS> - vlastné pole
• <META
• type - typ vlastného poľa, možné hodnoty:
• radio - prepínač
• checkbox - zaškrtávacie políčko
• input - textové pole
• date - dátum
• email - e-mail
• number - číslo
• select - rozbaľovacia ponuka
• multiselect - multi rozbaľovacia ponuka
• textarea - viacriadkové textové pole
• formatted - viacriadkové textové pole formátované (WYSIWYG)
• <META_KEY> - kľúč vlastného poľa - povolené znaky sú malé písmená, čísla (nesmú byť na prvej pozícii) a podtržítko
• <META_VALUE> - hodnota vlastného poľa, uvádza sa pokiaľ je rovnaká pre všetky jazykové mutácie
• <META_VALUES> - hodnoty vlastného poľa pre jednotlivé jazykové mutácie
• <META_VALUE>
• language - špecifikácie jazykovej mutácie