Dokumentace

ShopAPI XML

Doporučujeme používat pro napojení tento formát, protože bude obsahovat vždy nejvíce informací a bude podporovat pokročilejší funkce.

Obsah exportu

Množství informací se může lišit podle dodavatele - u některých dodavatelů například mohou být k dispozici podrobné parametry, zatímco u jiných je pouze kód a cena. Informace mohou také z exportu ubývat a přibývat podle toho, jak dodavatel dává k dispozici nová data.
Doporučujeme proto implementovat i zde uvedené hodnoty, přestože třeba aktuálně nejsou obsaženy ve feedu vašeho dodavatele.

Vyjímečně se může stát, že čas poslední změny se aktualizuje i většiny/všech produktů. Dojde k tomu například pokud se vylepší pravidla pro vyčištění popisů a změny v produktu mohou být jen kosmetické.

URL exportu

Při stahování změněných položek lze využít relativní zápis času (dokumentace) jako například -1 hour.
Export změn navíc obsahuje i položky smazané během požadovaného intervalu (označené atributem deleted).

• (bez parametrů) - standardní export obsahující všechny aktivní položky.
• /feed/abcdefgh12345?preview=true - obsahuje prvních 50 položek pro rychlý náhled bez nutnosti stahovat celý export.
• /feed/abcdefgh12345?updatedFrom=today - položky přidané/změněné/smazané od půlnoci
• /feed/abcdefgh12345?updatedFrom=-3%20hours - položky přidané/změněné/smazané za posledních 3 hodiny

Identifikátory

Exportované položky (produkty, varianty, značky, …) jsou označovány atributem UID. Tento atribut je přidělován v ShopAPI a dodavatel ho (zřejmě) nezná. UID je unikátní vždy v rámci typu a napříč všemi eshopy.

Pokud bude mít jeden produkt UID například abcedf123, tak je garantováno, že žádný produkt v žádném eshopu nebude používat stejné UID. Teoreticky se může stát, že stejné UID bude použito například pro identifikaci obrázku, ale je to silně nejpravděpodobné.

Kromě UID může být produkt/variant identifikován ještě pomocí code a/nebo EAN. Výskyt těchto atributů záleží na dodavateli a není zaručena jejich unikátnost.

Obrázky

Cache obrázků je ukládána na serverech ShopAPI, což zajišťuje maximální rychlost stahování. Obrázky jsou navíc filtrovány - pokud dodavatel uvádí neexistující URL nebo je obrázek neplatný (například URL vede na html stránku), tak tyto obrázky nejsou v ShopAPI zobrazeny.

Každý obrázek má unikátní idenntifikátor UID. Název obrázku je pak tvořen MD5 otiskem obrázku - pokud se změní obrázek, změní se vždy i adresa. Identické obrázky mají vždy stejnou adresu.
Koncovka názvu obrázku odpovídá skutečnému formátu souboru - bez ohledu na to, jak obrázek označil dodavatel.

Nedoporučujeme používat URL obrázků pro zobrazení v eshopu. Pokud se obrázek změní nebo smaže dodavatele, zmizí i u nás. Obrázky jsou navíc obvykle neoptimalizované a ve vysokém rozlošení, takže nejsou vhodné pro použití na webu bez předchozího zpracování.

Popis struktury

• export
  • (atribut) generated – datum a čas vygenerování exportu
  • (atribut) source – název dodavatele
  • product – hlavní značka
    • (atribut) created – datum vzniku produktu
    • (atribut) updated – datum poslední změny
    • (atribut) deleted – položka smazána (true/false) - má význam jen u exportu změn
    • uid – unikátní identifikátor ShopAPI
    • name – název produktu
    • ean – čárový kód
    • code – kód dodavatele
    • description – popis
    • fulldescription – delší popis
    • warranty – záruka (roky)
    • url – URL produktu u dodavatele
    • vat – daňová sazba (procenta)
    • price_vat – cena včetně DPH (pokud je stejná pro varianty)
    • price_retail_vat – maloobchodní cena včetně DPH (pokud je stejná pro varianty)
    • brand – značka produktu
      • (atribut) uid – unikátní identifikátor ShopAPI
    • availability – dostupnost produktu
      • (atribut) code – kód dostupnosti (in_stock, out_of_stock, unavailable, pre_order, unknown)
      • (atribut) hours – dostupnost v hodinách
      • (atribut) quantity – kusů skladem
    • stock – počet kusů skladem
    • weight – hmotnost v gramech
    • category – celá kategorie produktu (může se vyskytnout vícekrát)
      • (atribut) uid – unikátní identifikátor ShopAPI
    • img – URL obrázku
      • (atribut) uid – unikátní identifikátor ShopAPI
      • (atribut) md5 – MD5 hash souboru
      • (atribut) updated – datum poslední změny
    • video
      • (atribut) uid – unikátní identifikátor ShopAPI
      • (atribut) type – typ úložiště (youtube, vimeo)
      • (atribut) code – kód videa (pro sestavení URL)
      • (atribut) updated – datum poslední změny
      • url – URL videa
      • duration – délka videa
    • attribute – parametr (může se opakovat)
      • (atribut) updated – datum poslední změny
      • (atribut) uid – unikátní identifikátor ShopAPI
      • name – název parametru
      • value – hodnota parametru (může se vyskytnout vícekrát)
    • variant – varianta produktu (může se opakovat)
      • (atribut) updated – datum poslední změny
      • uid – unikátní identifikátor ShopAPI
      • name – název varianty
      • availability – dostupnost varianty
        • (atribut) code – kód dostupnosti (in_stock, out_of_stock, unavailable, pre_order, unknown)
        • (atribut) hours – dostupnost v hodinách
        • (atribut) quantity – kusů skladem
      • stock – počet kusů skladem
      • weight – hmotnost v gramech
      • ean – čárový kód
      • code – kód dodavatele
      • price_vat – cena včetně DPH (pokud se liší podle varianty)
      • price_retail_vat – maloobchodní cena včetně DPH (pokud se liší podle varianty)
      • img – URL obrázku
        • (atribut) uid – unikátní identifikátor ShopAPI
        • (atribut) updated – datum poslední změny
      • attribute – parametr (může se opakovat)
        • (atribut) updated – datum poslední změny
        • (atribut) uid – unikátní identifikátor ShopAPI
        • name – název parametru
        • value – hodnota parametru (může se vyskytnout vícekrát)