API reference
API reference
Obsahuje kompletní přehled všech endpointů REST API systému Upgates, které umožňuje programově spravovat a propojovat váš e-shop s externími systémy.
Tags
Aktuality
- více o aktualitách v Upgates e-shopech naleznete zde.
Ceníky
- pro práci s ceníky lze využívat webhooky.
- více na téma ceníky v Upgates naleznete zde.
Články
- více o článcích v Upgates e-shopech naleznete zde.
Dostupnosti
- více o dostupnostech v Upgates e-shopech naleznete zde.
Dopravy
- pro práci s dopravami lze využívat webhooky.
- více o dopravách v Upgates e-shopech naleznete zde.
Faktury
- více o fakturaci v Upgates e-shopech naleznete zde.
Grafika - editor kódu
- slouží pro práci se soubory na testovací verzi grafiky e-shopu, obdobně lze využít nástroj Editor kódu v administraci.
- seznamy souborů ovlivňuje zapnutý či vypnutý grafický editor Designer.
- více informací ohledně struktury souborů a složek nebo základní dokumentace naleznete v nápovědách.
- všechny cesty jsou vzhledem k root složce
/. Dle verze grafiky se mohou měnit názvy a umístění systémových souborů.
Grafika - zálohy
- slouží pro přehled grafických záloh a správu manuálních záloh.
Jazyky
- pro práci s jazyky lze využívat webhooky.
- více na téma jazyky a jazykové mutace v Upgates naleznete zde.
Kategorie
- unikátním identifikátorem kategorie je kód (
code) nebo ID (category_id). - pro práci s kategoriemi lze využívat webhooky.
- více o kategoriích v Upgates najdete zde.
Konverzní kódy
- konverzní kódy jsou vázány na uživatele API. Odstraněním API přístupu (anebo odinstalaci doplňku), se konverzní kódy smažou.
- pokud budete využívat měřící scripty, můžete nahlédnout do naší dokumentace Dynamických zástupců.
- v rámci API, nelze zasáhnout do vlastních konverzních kódů, které si vytváří majitel e-shopu ručně v adminsitraci.
- konverzní kód (
code) je vložen přímo do HTML, tzn. že JavaScriptový kód musí být obalen do tagu<script>.
Košíky
- více o košících v Upgates e-shopech naleznete zde.
Nastavení eshopu
- informace o nastavení e-shopu
Objednávky
- unikátním identifikátorem objednávek je číslo objednávky (
order_number) - pro práci s objednávkami lze využívat webhooky
- více o objednávkách v Upgates e-shopech najdete zde
Objednávky - historie
- unikátním identifikátorem objednávek je číslo objednávky (
order_number) - pro práci s objednávkami lze využívat webhooky
- více o objednávkách v Upgates e-shopech najdete zde
Objednávky - přílohy
- existují dva druhy příloh, soubor a odkaz
- více o přílohách v objednávkách v Upgates e-shopech najdete zde.
Parametry
- více o produktech v Upgates e-shopech naleznete zde.
- názvy parametrů a hodnot parametrů a musí být vždy ve všech jazycích, ty které chybí se vezmou z výchozího jazyka, pokud není tak z prvního co je na řadě.
Platby
- pro práci s platbami lze využívat webhooky.
- více o platbách v Upgates e-shopech naleznete zde.
Produkty
- unikátním identifikátorem produktů a variant je kód (
code). - pokud produkt nemá vyplněný kód, není možné jej založit, editovat a ani mazat.
- pro práci s produkty lze využívat webhooky.
- více o produktech v Upgates e-shopech naleznete zde.
Produkty - seznamy
- pro práci s produkty lze využívat webhooky.
- více o produktech v Upgates e-shopech naleznete zde.
Produkty - recenze a hodnocení
- pro práci s produkty lze využívat webhooky.
- recenze a hodnocení jsou spojeny do jednoho záznamu.
- více informací na Hodnocení a recenze
Provozovatel eshopu
- více na téma provozovatel e-shopu v Upgates najdete zde
Přesměrování
- více o přesměrování v Upgates e-shopech naleznete zde.
Rádce
- více o rádcích v Upgates e-shopech naleznete zde.
Sklady
- komunikace prostřednictvím těchto endpointů se vztahuje výhradně pro propojení s doplňujícími sklady, které jsou k dispozici po aktivaci doplňku Více skladů.
- pro komunikaci s hlavním skladem, slouží endpoint na Produkty.
Skupiny zákazníků
- více o skupinách v Upgates e-shopech naleznete zde.
Slevové kupóny
- více o slevových kupónech v Upgates e-shopech naleznete zde.
Soubory
- více o rádcích v Upgates e-shopech naleznete zde.
Stavy objednávek
- pro práci se stavy objednávky lze využívat webhooky
- typy stavů Homecredit se zakládají automaticky při zapnutí doplňku Homecredit
- více o stavech objednávek v Upgates e-shopech naleznete zde.
Štítky
- pro práci se štítky lze využívat webhooky.
- více o štítcích v Upgates e-shopech naleznete zde.
Uživatelé
- unikátním identifikátorem uživatele je ID (
user_id). - role definují oprávnění uživatele k jednotlivým modulům administrace, seznam modulů a možných úrovní oprávnění lze zjistit endpointem pro práva.
- pro práci s uživateli lze využívat webhooky, pro práci s rolemi webhooky.
Vlastní pole
- více o vlastních polích v Upgates e-shopech naleznete zde.
Výrobci
- více o výrobcích v Upgates e-shopech naleznete zde.
Webhooky
- endpoint nevyžaduje nastavení oprávnění, je povolen vždy pro všechny API uživatele.
- více na téma webhooky v Upgates najdete zde
Zákazníci
- unikátním identifikátorem zákazníků je
email - pro práci se zákazníky lze využívat webhooky.
- více o zákaznících v Upgates e-shopech naleznete zde.