Dokumentace XML - kategorie
Základní pravidla
- XML kategorií se používá pro import i export z Upgates.
- Zde je k náhledu prázdné vzorové XML.
- K testování struktury XML je možno použít naše XSD.
- Tagy končiace na
_YN>
jsou typu boolean a mohou nabývat hodnoty 0, 1, true, false. - Datum je zapsané jako řetězec znaků ve formátu YYYY-MM-DD dle ISO 8601. Y je rok, M je měsíc a D je den. Příklad: 2020-12-30.
- 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 (při importu) se prázdný tag chápe jako vymazání původní hodnoty v databázi.
- Kategorie se při importu párují podle kódu kategorie (tag
<CODE>
). Pokud chcete kategorie aktualizovat, musí být tagy<CODE>
vyplněny. - Všechny tagy jsou nepovinné, kromě kořenových tagů
<CATEGORIES>
a<CATEGORY>
. Při importu nových kategorií je povinný tag<NAME>
(s celou nadřezenou strukturou), protože z názvu kategorie se tvoří URL. Dále je všude povinný atributlanguage
. - Tagy, které mohou obsahovat HTML formátování, je možno zapsat buď jako převedeno do HTML entit nebo pomocí CDATA (
<![CDATA[ ]]>
). - Číselné hodnoty se uvádí nezformátované bez znaku jednotky (např. ceny, hmotnost nebo DPH). Pro zápis můžete použít buď desetinnou tečku nebo čárku.
- Další chování importu můžete ovlivnit nastavením v administraci (viz. nápověda).
Export
- Exportují se všechny tagy s výjimkou tagů s prázdnou hodnotou. Ty mohou v exportu chybět.
- Export z jednoho e-shopu Upgates je možno použít pro import do jiného e-shopu Upgates.
Struktura XML
<CATEGORIES>
version
- verze formátu XML, aktuálně je to 1.0<CATEGORY>
<CODE>
- Kód kategorie. Pokud není zadaný v importním souboru, pak se nevytváří automaticky.<CATEGORY_ID>
- ID kategorie, unikátní identifikátor kategorie, používá se pro zařazení kategorií do stromu<PARENT_ID>
- ID / kód nadřazené kategorie, unikátní identifikátor nadřazené kategorie, používá se pro zařazení kategorií do stromu. Pokud budete chtít zařadit kategorie do horního menu bude hodnota "1", levé menu "2" a spodní menu "3". Pokud bude prázdné, vloží se do kategorie podle nastavení importu.<POSITION>
- Číselná hodnota pozice v seznamu (v nadřazené kategorii)<ACTIVE_YN>
- Zobrazit kategorii na webu<TYPE>
- Typ kategorie, možné hodnoty:- homepage - odkaz na hlavní stránku
- news - odkaz na aktuality
- individual - odkaz na samostatnou stránku
- url - externí odkaz
- site - stránka
- siteWithProducts - stránka s produkty
- manufacturers - stránka s výrobci
- linkCategory - odkaz na kategorii
- advisor - odkaz na rádce
<TYPE_OF_ITEMS>
- Typ položek, možné hodnoty:- withoutSubcategories - bez podkategorií (výchozí, v kategorii budou ručně vložené produkty)
- label - štítek (v kategorii budou produkty které mají aktivní určený štítek)
- manufacturer - výrobce (v kategorii budou produkty které mají určeného výrobce)
<MANUFACTURER>
- Název výrobce. Páruje se podle existující hodnoty v databázi, nebo vytvoří novou. Bere se v úvahu pouze pokud je hodnota tagu<TYPE_OF_ITEMS>
manufacturer.<LABEL>
- Název štítku. Páruje se podle existující hodnoty v databázi, nebo vytvoří novou. Bere se v úvahu pouze pokud je hodnota tagu<TYPE_OF_ITEMS>
label.<SHOW_IN_MENU_YN>
- Zobrazit kategorii v menu<EXCLUDE_FROM_SEARCH_YN>
- vyřazeno z vyhledávání (pouze export)<CUSTOMER_GROUPS>
- Zobrazit kategorii pouze vybrané skupině zákazníků<GROUP>
- Název skupiny
<DESCRIPTIONS>
- Texty<DESCRIPTION>
language
- Specifikace jazykové mutace<ACTIVE_YN>
- Aktivní v jazykové mutaci. Pokud se neuvede, pak se bere jako aktivní. Použitelné pouze pro deaktivaci v jazykové mutaci.<NAME>
- Název kategorie<NAME_H1>
- Nadpis stránky v kategorii<DESCRIPTION_TEXT>
- Text stránky<URL>
- URL kategorie<LINK_URL>
- URL adresa, na kterou bude vést kategorie. Bere se v úvahu pouze pokud je hodnota tagu<TYPE>
linkCategory.
<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
<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í<POSITION>
- Pozice obrázku
<FILES>
- Soubory<FILE>
<URL>
- URL adresa souboru<TITLES>
- Popisky souborů<TITLE>
language
- Specifikace jazykové mutace
<POSITION>
- Pozice souboru
<METAS>
- vlastní pole<META
type
- typ vlastního pole, možné hodnoty:- radio - přepínač
- checkbox - zaškrtávací políčko
- input - textové pole
- date - datum
- email - email
- number - číslo
- select - rozbalovací nabídka
- multiselect - multi rozbalovací nabídka
- textarea - víceřádkové textové pole
- formatted - víceřádkové textové pole formátované (WYSIWYG)
<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