Kompletní obecný XML export

Tento export obsahuje naprosto všechna data, která je možná z DataDepa dostat. Postupně jsou do něj vkládány další informace, vždy se ale jedná o zpětně kompatibilní úpravy a rozšíření.

Kde se kompletní XML export nachází?

Export Vám aktivujeme na požádání, stačí nám napsat na podporu. Odkaz na jeho stažení a statistiky jeho používání následně naleznete v Propojení > Propojení s e-shopem.

Jak export nastavit?

Export obsahuje v jeden okamžik všechny schválené produkty. Obecně platí pravidlo, že pokud se produkt do exportu dostane tak tam už zůstane navždy, produkty tedy nejsou z dat odstraňovány, jsou u nich pouze aktualizovány stavy (Je / není aktivní, je / není dostupný atd … ).

Jak export zpracovávat?

Export vždy obsahuje aktuální data, která jsou generována realtime. Nedochází tedy k žádnému ukládání do cache a jeho obnově po několika minutách nebo hodinách. Pokud budete stahovat kompletní export tak vždy dostanete aktuální data. U větších exportů jen doporučujeme nastavit vyšší timeout při čekání na kompletní obsah souboru.

Přírůstkový export

Daleko lepší je zpracovávat tzv. přírůstkový export. Pomocí GET parametru lastModify si můžete nechat zaslat pouze produkty, u kterých došlo od zvoleného data k nějaké změně. Příklad volání tedy bude:

https://client.datadepo.cz/api-x/client/user/?password=xxxx&lastModify=2018-05-13 17:13:26

Nejvýhodnější je pak nastavit periodické dotazování na změny dat a ptát se DataDepa klidně každých pár minut na změny. I u přírůstkového exportu je ale potřeba počítat s nárazovými nárůsty počtu položek. Dodavatel může udělat hromadné přecenění produktů a i do přírůstkového exportu se ihned dostane veliké množství dat. Obecně je tedy dobré se i k přírůstkovému typu chovat stejně jako ke kompletnímu exportu.

V každém exportu je u elementu <SHOP> uveden atribut generatedAt, který označuje přesné datum generování souboru. Toto datum je potřeba si po každém volání ukládat a při přístím dotazu se ptát na obsah souboru právě od tohoto data. Příklad:

<SHOP generatedAt=“2018-05-13 17:13:26″>

Identifikátory

Export obsahuje dva typy identifiktárů – <ID> a <CODE> . Identifkátor ID je primární klíč produktu, který mu přiřadilo přímo DataDepo. Toto ID se nikdy nemění a doporučujeme na něj navázat unikátní identifikaci produktu ve Vašem importu. CODE se ve většině případech také nemění, někdy je ale potřebují změnit přímo klienti a je tak lepší mít import na tuto změnu připraven.

Stavy

V exportu najdete několik stavů (více o nich v sekci obsah souboru). Důležitý je stav <USER_DELETED>, který identifkuje stav odstranění produktu. Pokud má tento element hodnotu 1 tak byl uživatelem ručně odstraněn. Takový produkt by mél být na e-shopu skrytý (nebo minimálně neprodejný). V DataDepu nejsou žádné produkty fyzicky odstraňovány a mohou být kdykoliv opět obnoveny, všechny změny jsou vždy vratné. Připravte tedy svůj import i na stav, kdy bude produkt do exportu opět vrácen s USER_DELETED=0.

Přesměrování

Produkt se může dostat do stavu přesměrování. Stane se tak pokud se dva produkty spojí dohromady (například pomocí aktualizace EANu). Starší produkt se přesméruje na novější, takový produkt pak nebude mít stadardní strukturu, ale bude pouze obsahovat kód produktu, na který přesměrovává. Stejně jako standarní produkt bude obsahovat <ID> a <CODE>, navíc ale bude obsahovat i element <ID_MOVED> a <CODE_MOVED> s identifikací produktu, na který je nově přesmérovaný. Žádné další elementy uvedené nebudou.

Obsah souboru

• <ID> (int) – unikátní a neměnné ID produktu (ID generuje DataDepo a je neměnné).
• <CODE> (string) – kód produktu.
• <USER_DELETED> (bool) – zda byl produkt uživatelem v DataDepu označen jako odstraněný.
• <USER_DELETED_DATE> (date) – datum odstranění produktu, zobrazí se pouze pokud USER_DELETED=1.
• <NAME> (string) – název produktu.
• <EAN> (string) – EAN produktu.
• <MANUFACTURER> (string) – výrobce.
• <UNIT> (string) – měrná jednotka produktu.
• <WARRANTY> (string) – záruka.
• <SHORT_DESCRIPTION> (string) – krátký popisek produktu. Může i nemusí obsahovat HTML značky.
• <DESCRIPTION> (string) – dlouhý popisesk produktu. Může i nemusí obsahovat HTML značky.
• <CATEGORIES> – seznam kategorií, ve kterých je produkt umístěn. První kategorie v pořadí se dá brát jako hlavní (pokud Vás systém takovou strukturu vyžaduje)
  • <CATEGORY> (string) – název kategorie. Jako atribut obsahuje id, které určuje jednoznačný identifkátor kategorie
• <PARAMETERS>
  • <PARAMETER>
    • <NAME> (string) – Název parametru
    • <VALUE> (string) – Hodnota parametru
• <IMAGES> – seznam URL adres obrázků produktu. První obrázek je brán jako hlavní, pořadí obrázkků je nutné po importu zachovat.
  • <IMAGE> (string) – URL obrázku, v případě změny obsahu souboru se zméní hash, který je uveden jako parametr
• <BUSINESS_DATA>
  • <SUPPLIER_SET_PRODUCT_ID> (int) – ID produktu dodavatele, který byl vybrán jako prodejně nejvýhodnější, na e-shopu by měly být vidět ceny a dostupnosti od tohoto produktu.
  • <SUPPLIERS> – seznam všech dodavatelů daného produktu. Jeden dodavatel může být v seznamu zastoupen i vícekrát.
    • <SUPPLIER> – business data dodavatele.
      • <PRODUCT_ID> (int) – ID produktu dodavatele (ID generuje DataDepo a je neměnné)..
      • <CODE> (string) – Kód produktu dodavatele.
      • <SUPPLIER_ID> (id)– ID dodavatele, pod kterého produkt patří.
      • <SUPPLIER_NAME> (string) – Název dodavatele, pod který produkt patří.
      • <PRICES> – ceny produktu
        • <VAT> (float) – DPH v %.
        • <STANDARD_PRICE> (float) – Doporučená maloobchodní cena produktu bez DPH.
        • <STANDARD_PRICE_VAT> (float) – Doporučená maloobchodní cena produktu s DPH.
        • <PURCHASE_PRICE> (float) – Nákupní cena bez DPH.
        • <PURCHASE_PRICE_VAT> (float) – Nákupní cena s DPH.
        • <PHE> (float) – Poplatek za likvidaci bez DPH.
        • <PHE_VAT> (float) – Poplatek za likvidaci s DPH.
        • <MIN_PRICE> (float) – Minimální prodejní cena bez DPH.
        • <MIN_PRICE_VAT> (float) – Minimální prodejní cena s DPH.
        • <PRICE> (float) – Prodejní cena bez DPH.
        • <PRICE_VAT> (float) – Prodejní cena s DPH.
        • <MARKUP_PERCENT> (float) – vypočítaná přirážka v %, zobrazuje se pouze pokud je známá nákupní cena.
        • <MARKUP_MARGIN> (float) – vypočítaná přirážka v %, zobrazuje se pouze pokud je známá nákupní cena.
        • <CURRENCY> (string) – měna produktu, například CZK, EUR, PLN.
      • <AVAILABILITY_DATA> – informace o dostupnosti produktu
        • IS_AVAILABLE (bool) – zobrazuje zda je produkt dostupný (objednatelný).
        • <DATE_LAST_AVAILABLE> (date) – datum kdy byl produkt naposledy dostupný. Zobrazuje se pouze pokud je produkt aktuálně nedostupný.
        • <COUNT> (int) – počet aktuálně dostupných produktů (pouze pokud dodavatel tuto informaci uvádí).
        • <AVAILABILITY_TEXT> (string) – textové vyjádření dostupnosti. Zobrazuje se pouze pokud je v Datadepu nastaveno a nebo se přebírá přímo od dodavatele.
        • <NOTE> (string) – interní poznámka k dostupnosti (může jich být uvedeno více).
        • <AVAILABILITY_DAYS> (int) – dostupnost produktu ve dnech.
        • <AVAILABILITY_DAYS_MIN> (int) – minimální dostupnost produktu ve dnech.
        • <AVAILABILITY_DAYS_MAX> (int) – maximální dostupnost produktu ve dnech.