Download OpenAPI specification:
Všechny požadavky musí obsahovat hlavičku X-API-KEY s aktivním API klíčem z administrace Exitshopu. Ukázková ID a API klíč nahraďte vlastními údaji.
Úspěšná odpověď má HTTP 200 a data v poli result. Výjimkou je vytvoření inventury, které vrací prázdné JSON pole []. Chyby mají pole error; chyby autentizace a omezení počtu požadavků navíc obsahují status: false.
Limit je uveden u každé operace a platí zvlášť pro každý API klíč. Hodina se počítá od prvního požadavku; změna parametrů kvótu neobnovuje. Při překročení API vrací HTTP 429. Individuální výjimky mohou limity vypnout.
Klíč zaměstnance respektuje jeho oprávnění a přístup k e-shopům, stavům objednávek a skladu.
Naskladní 1 až 10000 kusů mateřského produktu. Objekt placement je povinný; pro výchozí hodnoty jeho položek lze poslat prázdný objekt {}. Nákupní cena se při vynechání převezme z produktu a měna z účtu. Pozice při vynechání jednotlivých souřadnic používá nuly.
Pohyb se uloží do historie, zboží se případně doplní do objednávek, kde chybí. Nevytváří se příjemka. Kusy na cestě se odečítají u výchozího dodavatele.
Limit: 2000 požadavků za hodinu.
| primary_id required | integer ID mateřského produktu. |
| quantity required | integer [ 1 .. 10000 ] Počet naskladňovaných kusů. |
required | object (Stock_placement_input) |
{- "primary_id": 52665,
- "quantity": 1,
- "placement": {
- "purchase_price": 100,
- "purchase_price_currency": "CZK",
- "AA": 10,
- "BB": 20,
- "CC": 30,
- "DD": 40,
- "alternative": null,
- "warehouse": null
}
}{- "result": {
- "inserted": 1
}
}Slouží k přeskladnění zadaných kusů na novou pozici. Volitelně umí i nastavit výchozí pozici. Limit: 200 požadavků za hodinu. Jeden požadavek smí obsahovat nejvýše 1000 položek; větší dávku rozdělte do více požadavků.
required | Array of objects non-empty |
{- "placements": [
- {
- "placement_id": 25918109,
- "placement": {
- "AA": 10,
- "BB": 20,
- "CC": 30,
- "DD": 40,
- "alternative": null,
- "warehouse": null
}, - "set_as_default_position": true
}
]
}{- "result": {
- "updated": 1
}
}Zadejte jedno nebo více ID mateřských produktů oddělených čárkou (případně EANů nebo názvů produktů). Vrací informace o mateřských produktech a pozice jednotlivých kusů. Kusy na cestě jsou součtem od všech dodavatelů.
Skladová pole jsou aktuální hodnoty mateřského produktu:
quantity: počet kusů dostupných ve skladu po skladových pohybech objednávek. Může být záporný. Neobsahuje fiktivní navýšení fake_quantity.reserved: fyzické kusy ve skladu přiřazené objednávkám ve stavech s rezervací; chybějící kusy se nezahrnují. Hodnota je součtem rezervovaných kusů ze všech skladových pozic. quantity se o tuto hodnotu v odpovědi dále nesnižuje.reserved_total: všechny kusy v objednávkách ve stavech s rezervací, včetně chybějících. Odpovídá hodnotě „Rezervováno“ v detailu produktu.fake_quantity: nastavené fiktivní navýšení dostupnosti; nejde o fyzickou zásobu. Použije se nastavení produktu, případně dodavatele. Dostupnost na konkrétním e-shopu se může lišit podle jeho nastavení.on_road: aktuální počet kusů vedených na cestě od všech dodavatelů.Limit: 600 požadavků za hodinu. Hledání smí odpovídat nejvýše 1000 produktům; počet kusů jednoho produktu omezený není. Širší hledání vrátí chybu 400 a je potřeba ho upřesnit; výsledek se nikdy nezkracuje.
U účtů se striktním hledáním se všechny předané kódy porovnávají přesně s vlastním kódem, hlavním nebo dalším čárovým kódem a číselné kódy také s ID mateřského produktu. Názvy se ve striktním režimu neprohledávají. Pokud se nenajde dostatek produktů pro zadanou dávku, vrátí se chyba 403 pro celý požadavek.
Pokud produkt nemá žádný kus na konkrétní pozici, příslušné pole pozic v jeho odpovědi chybí.
| primaries required | string Example: 52665,57928 ID mateřských produktů, EANy nebo názvy oddělené čárkou; mezery a další zvláštní znaky v URL zakódujte. |
GET /api/v1/products/placements/52665,57928 HTTP/1.1 Host: www.exitshop.cz X-API-KEY: VAS_API_KLIC Accept: application/json
{- "result": [
- {
- "primary_id": 52665,
- "name": "Povlečení - modré XL",
- "quantity": 3,
- "fake_quantity": 0,
- "reserved": 0,
- "reserved_total": 0,
- "on_road": 5,
- "user_id": 33,
- "supplier": "Můj dodavatel",
- "own_id": "XYZ12",
- "purchase_price": 100,
- "default_placement": {
- "AA": "10",
- "BB": "20",
- "CC": "30",
- "DD": "40",
- "alternative": "",
- "warehouse": null
}, - "placement": [
- {
- "placement_id": 25918109,
- "AA": "10",
- "BB": "20",
- "CC": "30",
- "DD": "40",
- "alternative": null,
- "warehouse": null
}, - {
- "placement_id": 25918110,
- "AA": "10",
- "BB": "20",
- "CC": "30",
- "DD": "40",
- "alternative": null,
- "warehouse": null
}, - {
- "placement_id": 25918111,
- "AA": "10",
- "BB": "20",
- "CC": "30",
- "DD": "50",
- "alternative": null,
- "warehouse": null
}
]
}, - {
- "primary_id": 57928,
- "name": "Mobil Nokia 3310",
- "quantity": 1,
- "fake_quantity": 0,
- "reserved": 0,
- "reserved_total": 0,
- "on_road": 0,
- "user_id": 33,
- "supplier": "Můj dodavatel",
- "own_id": "",
- "purchase_price": 100,
- "default_placement": {
- "AA": "0",
- "BB": "0",
- "CC": "0",
- "DD": "0",
- "alternative": "",
- "warehouse": null
}, - "placement": [
- {
- "placement_id": 25918163,
- "AA": "0",
- "BB": "0",
- "CC": "0",
- "DD": "0",
- "alternative": null,
- "warehouse": null
}
]
}
]
}Upraví cenu, název nebo volbu custom_price zadaných mateřských produktů. price je základní prodejní cena; při uložení se zohlední cenový modifikátor produktu.
Při save_all_translations: true se název propíše do napárovaných produktů, které přepis názvu povolují. Volitelný save_all_translations_lang omezuje přepis na daný jazyk (cs, sk, hu, pl, ...); pro všechny jazyky tento parametr vynechte. Při zadání jazyka se název uloží i jako překlad mateřského produktu.
custom_price zapíná nebo vypíná volbu „Nenastavovat automaticky prodejní ceny od dodavatele“. Alias PUT /products/prices sdílí stejný limit.
Limit: 200 požadavků za hodinu. Jeden požadavek smí obsahovat nejvýše 1000 položek; větší dávku rozdělte do více požadavků.
required | Array of objects non-empty |
{- "primaries": [
- {
- "primary_id": 52665,
- "name": "Povlečení - modré XL",
- "save_all_translations": true,
- "save_all_translations_lang": "cs"
}, - {
- "primary_id": 57928,
- "price": 120,
- "custom_price": true
}
]
}{- "result": {
- "updated": 2
}
}Vrací stejné údaje jako GET /products/placements/{primaries}, ale jednotlivé kusy seskupuje podle pozice do pole placement_grouped s položkami quantity a position. Zadejte ID mateřských produktů, EANy nebo názvy oddělené čárkou.
Skladová pole jsou aktuální hodnoty mateřského produktu:
quantity: počet kusů dostupných ve skladu po skladových pohybech objednávek. Může být záporný. Neobsahuje fiktivní navýšení fake_quantity.reserved: fyzické kusy ve skladu přiřazené objednávkám ve stavech s rezervací; chybějící kusy se nezahrnují. Hodnota je součtem rezervovaných kusů ze všech skladových pozic. quantity se o tuto hodnotu v odpovědi dále nesnižuje.reserved_total: všechny kusy v objednávkách ve stavech s rezervací, včetně chybějících. Odpovídá hodnotě „Rezervováno“ v detailu produktu.fake_quantity: nastavené fiktivní navýšení dostupnosti; nejde o fyzickou zásobu. Použije se nastavení produktu, případně dodavatele. Dostupnost na konkrétním e-shopu se může lišit podle jeho nastavení.on_road: aktuální počet kusů vedených na cestě od všech dodavatelů.Limit: 600 požadavků za hodinu. Hledání smí odpovídat nejvýše 1000 produktům; počet kusů jednoho produktu omezený není. Širší hledání vrátí chybu 400 a je potřeba ho upřesnit; výsledek se nikdy nezkracuje.
V ukázkové odpovědi jsou u prvního produktu dva kusy na pozici 10_20_30_40 a jeden kus na pozici 10_20_30_50. Hodnota position spojuje souřadnice AA, BB, CC a DD podtržítky; každá souřadnice má alespoň dvě číslice. Pole placement_grouped nahrazuje pole placement.
U účtů se striktním hledáním se všechny předané kódy porovnávají přesně s vlastním kódem, hlavním nebo dalším čárovým kódem a číselné kódy také s ID mateřského produktu. Názvy se ve striktním režimu neprohledávají. Pokud se nenajde dostatek produktů pro zadanou dávku, vrátí se chyba 403 pro celý požadavek.
Pokud produkt nemá žádný kus na konkrétní pozici, příslušné pole pozic v jeho odpovědi chybí.
Seskupení používá pouze souřadnice AA, BB, CC a DD; alternativní označení pozice ani sklad do něj nevstupují.
| primaries required | string Example: 52665,57928 ID mateřských produktů, EANy nebo názvy oddělené čárkou; mezery a další zvláštní znaky v URL zakódujte. |
GET /api/v1/products/details/52665,57928 HTTP/1.1 Host: www.exitshop.cz X-API-KEY: VAS_API_KLIC Accept: application/json
{- "result": [
- {
- "primary_id": 52665,
- "name": "Povlečení - modré XL",
- "quantity": 3,
- "fake_quantity": 0,
- "reserved": 0,
- "reserved_total": 0,
- "on_road": 5,
- "user_id": 33,
- "supplier": "Můj dodavatel",
- "own_id": "XYZ12",
- "purchase_price": 100,
- "default_placement": {
- "AA": "10",
- "BB": "20",
- "CC": "30",
- "DD": "40",
- "alternative": "",
- "warehouse": null
}, - "placement_grouped": [
- {
- "quantity": 2,
- "position": "10_20_30_40"
}, - {
- "quantity": 1,
- "position": "10_20_30_50"
}
]
}, - {
- "primary_id": 57928,
- "name": "Mobil Nokia 3310",
- "quantity": 1,
- "fake_quantity": 0,
- "reserved": 0,
- "reserved_total": 0,
- "on_road": 0,
- "user_id": 33,
- "supplier": "Můj dodavatel",
- "own_id": "",
- "purchase_price": 100,
- "default_placement": {
- "AA": "0",
- "BB": "0",
- "CC": "0",
- "DD": "0",
- "alternative": "",
- "warehouse": null
}, - "placement_grouped": [
- {
- "quantity": 1,
- "position": "00_00_00_00"
}
]
}
]
}Vytvoří nákupní seznamy seskupené podle dodavatelů. Pole placements musí mít 1 až 1000 položek. Každý produkt musí mít dodavatele a kladné množství. Objekt placement je povinný, ale může být prázdný; souřadnice pak používají nuly a nákupní cena se převezme z produktu.
Limit: 200 požadavků za hodinu.
required | Array of objects [ 1 .. 1000 ] items |
{- "placements": [
- {
- "primary_id": 52665,
- "quantity": 2,
- "placement": {
- "purchase_price": 100,
- "purchase_price_currency": "CZK",
- "AA": 10,
- "BB": 20,
- "CC": 30,
- "DD": 40,
- "alternative": null,
- "warehouse": null
}
}
]
}{- "result": {
- "shopping_lists_created": 1,
- "primaries_created": 1
}
}Vrátí seznam zboží na dané pozici ve skladu. Pozice musí mít minimálně dva znaky (AA). Může být tedy AA, AABB, AABBCC nebo plně zadaná AABBCCDD. Vrací seznam produktů, které mají odpovídající výchozí pozici. Dále seznam produktů ze skladu a rezervovaných objednávek, které mají odpovídající pozici a jejich počet - tento seznam je seskupen podle ID produktu a pozice. Limit: 2000 požadavků za hodinu.
| AABBCCDD required | string [ 2 .. 8 ] characters Example: 10203040 Pozice AA, AABB, AABBCC nebo AABBCCDD, tedy přesně 2, 4, 6 nebo 8 znaků. |
GET /api/v1/stocktaking/whatishere/10203040 HTTP/1.1 Host: www.exitshop.cz X-API-KEY: VAS_API_KLIC Accept: application/json
{- "result": {
- "default_placements": [
- {
- "primary_id": 52665,
- "name": "Povlečení - modré XL",
- "AA": "10",
- "BB": "20",
- "CC": "30",
- "DD": "40"
}
], - "real_placements": [
- {
- "primary_id": 52665,
- "quantity": 2,
- "name": "Povlečení - modré XL",
- "AA": "10",
- "BB": "20",
- "CC": "30",
- "DD": "40"
}
]
}
}Vytvoří seznam produktů v sekci Inventura v administraci Exitshopu. Samotné vytvoření inventury nemění skladové množství. Povinné pole content obsahuje ID produktů a zjištěná množství; opakované ID produktu se v inventuře sčítá. Při vynechání name se název doplní automaticky.
Při úspěchu API vrací prázdné JSON pole [].
Limit: 200 požadavků za hodinu.
| name | string Název inventury; při vynechání se vytvoří automaticky. |
required | Array of objects non-empty |
{- "name": "Inventura povlečení",
- "content": [
- {
- "primary_id": 52665,
- "quantity": 15
}
]
}[ ]Vrátí informaci o aktuálně přihlášeném uživateli (podle použitého API klíče) Limit: 2000 požadavků za hodinu.
GET /api/v1/user/detail HTTP/1.1 Host: www.exitshop.cz X-API-KEY: VAS_API_KLIC Accept: application/json
{- "result": {
- "user": {
- "email": "test@exitshop.cz",
- "id": "33",
- "name": "Testovací účet"
}
}
}Vrátí prodeje po mateřských produktech se stejným výpočtem jako produktový report v administraci. Zohledňuje současné nastavení zahrnutí objednávek do statistik a aktivní dobropisy. Samostatné slevové řádky, například kupóny, se na produkty nerozpočítávají.
Primárně používejte order_date_from / order_date_to pro datum objednání. date_from / date_to označují datum faktury a nejsou povinné. Zadejte alespoň jednu úplnou dvojici od–do: objednání nebo fakturace. Oba druhy filtrů lze kombinovat a použijí se současně. Bez fakturačních filtrů se zahrnují i objednávky bez faktury.
Začátek každého intervalu je včetně, konec se nezahrnuje. Pro objednávky za celý říjen použijte order_date_from=2026-10-01&order_date_to=2026-11-01. Formáty jsou YYYY-MM-DD, YYYY-MM-DD HH:MM nebo YYYY-MM-DD HH:MM:SS, v čase používaném administrací. Každé úplné zadané období smí mít nejvýše 16 kalendářních měsíců; pokud cílový měsíc nemá odpovídající den, hranicí je jeho poslední den.
Bez group_by vrací jeden řádek za produkt za celé období. group_by=utm_source nebo group_by=utm_medium vrací řádky za produkt a zdroj či médium; chybějící hodnota je null. Součet za zdroj nebo médium lze sestavit sečtením částek jeho produktů; aktuální sklad se v jednotlivých skupinách opakuje. group_by=day přidá date a vrací produkt po dnech objednání, i při omezení datem faktury; dny bez prodeje nedoplňuje. Týdenní a měsíční součty lze sestavit z denních výsledků.
Finanční částky jsou v základní měně účtu uvedené jako currency_code. margin je absolutní částka bez DPH, tedy revenue_vat_exc minus purchase_price_total. Používá se uložený kurz a nákupní cena položky objednávky. Dobropis zpětně ovlivňuje období původní objednávky.
Skladová pole jsou aktuální a nezávislá na období prodejů:
quantity: množství k dispozici ve skladu (bez rezervovaných kusů). Může být záporné a neobsahuje fiktivní navýšení.reserved: fyzicky rezervované kusy ve skladu.reserved_total: všechny rezervované kusy včetně chybějících v objednávkách.fake_quantity: nastavené fiktivní navýšení dostupnosti produktu nebo jeho dodavatele, nikoli fyzická zásoba.on_road: počet kusů vedených na cestě od všech dodavatelů.Obě hodnoty rezervací jsou za celý sklad účtu, nezávisle na vybraných e-shopech a stavech.
Přístup odpovídá oprávnění ke statistikám v administraci. Zaměstnanec vidí jen dostupné e-shopy a stavy; prázdné přiřazení znamená všechny dostupné v účtu. Objednávky bez stavu zahrnuje klíč vlastníka. ID e-shopů získáte z /eshops/all, dodavatelů z /suppliers/all, produktů z detailu produktu, objednávek nebo tohoto reportu. Výslovný filtr mimo vlastní nebo povolený rozsah vrátí 403. Prázdný výsledek má HTTP 200 a products: [].
Limit: 200 požadavků za hodinu.
| order_date_from | string Example: order_date_from=2026-10-01 Začátek období podle data objednání, včetně. Primární způsob výběru období spolu s order_date_to. |
| order_date_to | string Example: order_date_to=2026-11-01 Konec období podle data objednání, bez tohoto okamžiku. Nejvýše 16 kalendářních měsíců od order_date_from. |
| date_from | string Example: date_from=2026-10-01 Volitelný začátek období podle data faktury, včetně. Při výběru podle objednání lze vynechat. |
| date_to | string Example: date_to=2026-11-01 Volitelný konec období podle data faktury, bez tohoto okamžiku. Při výběru podle objednání lze vynechat. |
| eshop_id | integer >= 1 Example: eshop_id=2 ID dostupného e-shopu. Bez filtru všechny dostupné e-shopy. |
| country | string Example: country=CZ Kód země e-shopu, například CZ nebo SK. Zahrne všechny dostupné e-shopy v dané zemi; s eshop_id platí oba filtry současně. |
| supplier_id | integer >= 1 Example: supplier_id=123 ID vlastního dodavatele. Bez filtru všichni dodavatelé. |
| primary_id | string Example: primary_id=52665,57928 Nejvýše 1000 kladných ID vlastních mateřských produktů oddělených čárkou. |
| utm_source | string UTM filtr podle obsaženého textu, alespoň 2 znaky. |
| utm_medium | string UTM filtr podle obsaženého textu, alespoň 2 znaky. |
| utm_campaign | string UTM filtr podle obsaženého textu, alespoň 2 znaky. |
| group_by | string Enum: "day" "utm_source" "utm_medium" Rozpad po produktech a dnech, zdrojích nebo médiích. Bez parametru součet za celé období. |
GET /api/v1/reports/sales?order_date_from=2026-10-01&order_date_to=2026-11-01&group_by=day HTTP/1.1 Host: www.exitshop.cz X-API-KEY: VAS_API_KLIC Accept: application/json
{- "result": {
- "currency_code": "CZK",
- "products": [
- {
- "primary_id": 52665,
- "own_id": "XYZ12",
- "name": "Povlečení - modré XL",
- "supplier_id": 123,
- "supplier": "Dodavatel XY",
- "quantity_sold": 3,
- "revenue_vat_exc": 600,
- "purchase_price_total": 300,
- "margin": 300,
- "quantity": 15,
- "reserved": 3,
- "reserved_total": 5,
- "on_road": 5,
- "fake_quantity": 0,
- "date": "2026-10-01"
}
]
}
}Vrátí seznamy neprázdných UTM zdrojů, médií a kampaní z aktivních objednávek dostupných e-shopů a stavů. Zahrnuje i objednávky vyřazené z finančních statistik.
Zadejte úplné období order_date_from / order_date_to nebo date_from / date_to podle data faktury. Oba typy lze kombinovat. Začátek je včetně, konec se nezahrnuje; maximum je 16 kalendářních měsíců. Přístup odpovídá statistikám. Limit: 200 požadavků za hodinu.
| order_date_from | string Example: order_date_from=2026-10-01 Začátek období podle data objednání. |
| order_date_to | string Example: order_date_to=2026-11-01 Konec období podle data objednání, bez tohoto okamžiku. |
| date_from | string Začátek období podle data faktury. |
| date_to | string Konec období podle data faktury, bez tohoto okamžiku. |
| eshop_id | integer >= 1 ID dostupného e-shopu. |
| country | string Example: country=CZ Země dostupných e-shopů. |
{- "result": {
- "sources": [
- "facebook",
- "google"
], - "mediums": [
- "cpc",
- "social"
], - "campaigns": [
- "brand",
- "sale"
]
}
}Vrátí ležáky podle stejného skladového reportu jako v administraci: aktivní mateřské produkty s kladnou současnou zásobou, mimo sady, bez prodejního skladového pohybu ve zvoleném období. Současně musí být dostupné na začátku období nebo doplněné naskladněním či stornem během něj. Dobropis ani vratka nemažou předchozí prodejní pohyb.
stock_date_from / stock_date_to určují období skladových pohybů. Nejde o datum objednání ani faktury. Začátek je včetně, konec se nezahrnuje. Formáty jsou YYYY-MM-DD, YYYY-MM-DD HH:MM nebo YYYY-MM-DD HH:MM:SS, v čase používaném administrací. Období smí mít nejvýše 16 kalendářních měsíců; pokud cílový měsíc nemá odpovídající den, hranicí je jeho poslední den.
days_without_stock je počet celých kalendářních dní ve zvoleném období, kdy dostupná fyzická zásoba po celý den nebyla kladná. Počítají se pouze celé dny uvnitř období a nejvýše do konce včerejšího dne. Hodnota se dopočítává ze současného stavu a zaznamenaných skladových pohybů; přesnost závisí na úplnosti historie. Fake sklad ani dostupnost na jednotlivých e-shopech nezohledňuje.
quantity je současná zásoba. Report zahrnuje celý vlastní sklad bez filtru e-shopů a stavů objednávek. Přístup odpovídá oprávnění k historii skladu v administraci. Skrytý sklad zaměstnanci přístup zakazuje.
ID dodavatele získáte z /suppliers/all. Filtr cizího dodavatele vrátí 403. Prázdný výsledek má HTTP 200 a products: [].
Limit: 200 požadavků za hodinu.
| stock_date_from required | string Example: stock_date_from=2026-10-01 Začátek období skladových pohybů, včetně. |
| stock_date_to required | string Example: stock_date_to=2026-11-01 Konec období skladových pohybů, bez tohoto okamžiku. Nejvýše 16 kalendářních měsíců od stock_date_from. |
| supplier_id | integer >= 1 Example: supplier_id=123 ID vlastního dodavatele. Bez filtru všichni dodavatelé. |
GET /api/v1/reports/not_sold?stock_date_from=2026-10-01&stock_date_to=2026-11-01&supplier_id=123 HTTP/1.1 Host: www.exitshop.cz X-API-KEY: VAS_API_KLIC Accept: application/json
{- "result": {
- "products": [
- {
- "primary_id": 52665,
- "own_id": "XYZ12",
- "name": "Povlečení - modré XL",
- "supplier_id": 123,
- "supplier": "Dodavatel XY",
- "quantity": 15,
- "days_without_stock": 3
}
]
}
}Vrátí číselník dodavatelů vlastního účtu. Výsledek obsahuje pouze ID a název dodavatele; ID lze použít jako supplier_id ve filtrech. Zaměstnanec musí mít přístup do skladu. Pokud účet nemá dodavatele, vrátí se prázdné pole result.suppliers.
Limit: 2000 požadavků za hodinu.
GET /api/v1/suppliers/all HTTP/1.1 Host: www.exitshop.cz X-API-KEY: VAS_API_KLIC Accept: application/json
{- "result": {
- "suppliers": [
- {
- "id": 123,
- "name": "Dodavatel XY"
}, - {
- "id": 456,
- "name": "Druhý dodavatel"
}
]
}
}Vrátí seznam stavů objednávek dostupných držiteli použitého API klíče. U zaměstnance respektuje povolené stavy.
exclude_orders_from_statistics: při hodnotě true se objednávka při přechodu do tohoto stavu vyřadí z prodejních statistik.
Limit: 2000 požadavků za hodinu.
GET /api/v1/statuses/all HTTP/1.1 Host: www.exitshop.cz X-API-KEY: VAS_API_KLIC Accept: application/json
{- "result": {
- "statuses": [
- {
- "id": 12,
- "name": "Dokončeno",
- "color": "c5f0cb",
- "storno": 0,
- "return_goods": 0,
- "storno_without_returning": 0,
- "exclude_orders_from_statistics": false
}, - {
- "id": 13,
- "name": "Storno",
- "color": "f5d5f5",
- "storno": 1,
- "return_goods": 0,
- "storno_without_returning": 0,
- "exclude_orders_from_statistics": true
}
]
}
}Vrátí aktivní e-shopy dostupné držiteli použitého API klíče. U zaměstnance respektuje přiřazené e-shopy. Interní sklad TEMP se nevrací. Výsledek obsahuje ID, název, doménu (url) a typ e-shopu.
Limit: 2000 požadavků za hodinu.
GET /api/v1/eshops/all HTTP/1.1 Host: www.exitshop.cz X-API-KEY: VAS_API_KLIC Accept: application/json
{- "result": {
- "eshops": [
- {
- "id": 2,
- "name": "Můj e-shop",
- "url": "mojeshop.cz",
- "type": "eshop"
}, - {
- "id": 34,
- "name": "Druhý e-shop",
- "url": "druhyeshop.cz",
- "type": "solo"
}
]
}
}Vrátí vlastní CSS pro aktuální šablonu a její variantu. Pokud vlastní CSS neexistuje, vrátí prázdný řetězec. Přístup mají zaměstnanci s oprávněním upravovat vzhled a přístupem k danému e-shopu.
Limit: 2000 požadavků za hodinu.
| shop_id required | integer >= 1 ID e-shopu dostupného držiteli API klíče. |
{- "result": {
- "shop_id": 2,
- "theme": "next",
- "variant": "default",
- "css": "body { color: black; }"
}
}Nahradí celé vlastní CSS aktuální šablony a varianty. Prázdný řetězec vlastní CSS odstraní. Předchozí verze se uloží do historie stejně jako při změně v administraci. Ostatní šablony a e-shopy zůstanou beze změny.
Limit: 200 požadavků za hodinu.
| shop_id required | integer >= 1 ID e-shopu dostupného držiteli API klíče. |
| css required | string Celé vlastní CSS, nejvýše 16777215 bajtů. |
{- "css": "body { color: black; }"
}{- "result": {
- "shop_id": 2,
- "theme": "next",
- "variant": "default"
}
}Vrátí až 50 předchozích verzí vlastního CSS aktuální šablony a varianty, od nejnovější. Verze starší než tři měsíce se průběžně odstraňují. Po prvním uložení CSS historie ještě neobsahuje žádnou předchozí verzi. Pro obnovení pošlete její obsah pomocí PUT /eshops/css/{shop_id}. Přístup mají zaměstnanci s oprávněním upravovat vzhled a přístupem k danému e-shopu.
Limit: 600 požadavků za hodinu.
| shop_id required | integer >= 1 ID e-shopu dostupného držiteli API klíče. |
{- "result": {
- "shop_id": 2,
- "theme": "next",
- "variant": "default",
- "history": [
- {
- "id": 123,
- "created_at": "2026-10-27 10:30:00",
- "css": "body { color: black; }"
}
]
}
}Vrátí nastavené písmo, seznam dostupných písem a informaci, zda aktuální šablona změnu písma podporuje. Prázdná hodnota znamená výchozí písmo šablony. Přístup mají zaměstnanci s oprávněním upravovat vzhled a přístupem k danému e-shopu.
Limit: 2000 požadavků za hodinu.
| shop_id required | integer >= 1 ID e-shopu dostupného držiteli API klíče. |
{- "result": {
- "shop_id": 2,
- "theme": "next",
- "variant": "default",
- "font": "inter",
- "supported": true,
- "available_fonts": {
- "inter": "Inter",
- "roboto": "Roboto"
}
}
}Nastaví písmo e-shopu. Zadejte kód ze seznamu available_fonts, který vrací GET, nebo prázdný řetězec pro výchozí písmo šablony. Aktuální šablona musí změnu písma podporovat. Nastavení platí pro e-shop a při změně šablony zůstává uložené; vlastní CSS ho může přepsat.
Limit: 200 požadavků za hodinu.
| shop_id required | integer >= 1 ID e-shopu dostupného držiteli API klíče. |
| font required | string Kód písma nebo prázdný řetězec pro výchozí písmo. |
{- "font": "inter"
}{- "result": {
- "shop_id": 2,
- "theme": "next",
- "variant": "default",
- "font": "inter"
}
}Naplánuje změnu stavu objednávky. Změna proběhne při následném zpracování požadavků. Volitelný přepínač options.fast: true provede změnu ihned (požadavek může trvat déle). Tělo požadavku lze vynechat; výchozí režim je naplánování změny.
Limit: 2000 požadavků za hodinu.
| ORDER_NUMBER required | string Example: 2301011235 |
| STATUS_ID required | string Example: 12 |
object |
{- "options": {
- "fast": true
}
}{- "result": {
- "ok": 1
}
}Odešle objednávku prostřednictvím odpovídajícího API (aktuálně je podporována Zásilkovna, DPD, PPL a Česká pošta; v případě GLS použijte rovnou get_label_raw). Limit: 2000 požadavků za hodinu.
| ORDER_NUMBER required | string Example: 2301011235 |
POST /api/v1/orders/send_packet/2301011235 HTTP/1.1 Host: www.exitshop.cz X-API-KEY: VAS_API_KLIC Accept: application/json
{- "result": {
- "order_number": "2301011235",
- "message": "Balík byl nahrán"
}
}Vrací PDF štítek (A6) prostřednictvím odpovídajícího API (aktuálně je podporována Zásilkovna, DPD, PPL, a Česká pošta). Limit: 2000 požadavků za hodinu.
| ORDER_NUMBER required | string Example: 2301011235 |
GET /api/v1/orders/get_label/2301011235 HTTP/1.1 Host: www.exitshop.cz X-API-KEY: VAS_API_KLIC Accept: application/json
{- "result": {
- "order_number": "2301011235",
- "pdf": "JVBERi0xLjQKLi4u"
}
}Vrací URI s protokolem exitshop: obsahující štítek pro tiskárny Citizen nebo Zebra (aktuálně je podporována Zásilkovna, DPD, PPL, GLS a Česká pošta). Pokud máte nainstalovaný Exitshop Print a tiskárnu, tak tiskne přímo bez nutnosti otevírat PDF. Limit: 2000 požadavků za hodinu.
| ORDER_NUMBER required | string Example: 2301011235 |
GET /api/v1/orders/get_label_raw/2301011235 HTTP/1.1 Host: www.exitshop.cz X-API-KEY: VAS_API_KLIC Accept: application/json
{- "result": {
- "order_number": "2301011235",
- "uri": "exitshop:ABCDEFGHIJKLMN"
}
}Každá objednávka obsahuje utm_source, utm_medium a utm_campaign; pokud údaj chybí, jeho hodnota je null.
Vrátí stránkovaný seznam aktivních objednávek s položkami. Alespoň jeden z filtrů tracking_number, status_id, eshop_id, number, date_from, date_to, order_date_from, order_date_to musí být zadán. UTM filtry jsou pouze doplňující.
total je celkový počet odpovídajících objednávek před stránkováním. Výsledky jsou z historických důvodů v poli invoices, i když objednávka nemá fakturu. Pokud nic neodpovídá filtrům, vrací se HTTP 200, total: 0 a invoices: [].
order_status_name je zákaznický název stavu v jazyce objednávky; order_status_internal_name je interní název. Chybějící názvy nebo tracking URL mohou být null.
date_from / date_to filtrují datum faktury, order_date_from / order_date_to datum objednání. Oba typy filtrů lze kombinovat. Přijímané formáty jsou YYYY-MM-DD, YYYY-MM-DD HH:MM a YYYY-MM-DD HH:MM:SS, v čase používaném administrací. Meze jsou včetně; datum bez času označuje půlnoc. Pro celý koncový den použijte čas 23:59:59. Neplatný formát nebo neexistující datum vrátí chybu 400.
currency zůstává symbolem měny. currency_code obsahuje její ISO kód, například CZK nebo EUR; u nerozpoznané měny je null.
Limit: 2000 požadavků za hodinu.
| page | integer >= 0 Default: 0 Example: page=0 Číslo stránky (výchozí 0) |
| per_page | integer >= 1 Default: 10 Example: per_page=10 Počet objednávek na stránku; výchozí 10. Hodnoty nad 1000 se omezí na 1000. |
| date_from | string Example: date_from=2020-01-01 Datum a případně čas faktury od, včetně. Vynechání nebo prázdná hodnota neomezují výsledek. |
| date_to | string Example: date_to=2020-01-01 Datum a případně čas faktury do, včetně. Datum bez času znamená půlnoc. Vynechání nebo prázdná hodnota neomezují výsledek. |
| order_date_from | string Example: order_date_from=2026-10-01 00:00:00 Datum a případně čas objednání od, včetně. Vynechání nebo prázdná hodnota neomezují výsledek. |
| order_date_to | string Example: order_date_to=2026-10-31 23:59:59 Datum a případně čas objednání do, včetně. Datum bez času znamená půlnoc. Vynechání nebo prázdná hodnota neomezují výsledek. |
| invoice | integer Default: 0 Enum: 0 1 Example: invoice=1 Jen objednávky s fakturou: použijte 1 nebo true. Pro vypnutí filtr vynechte nebo pošlete 0 či false; jiná hodnota vrátí chybu 400. |
| number | string Example: number=2301011235 Číslo objednávky (hledání podle obsaženého textu). |
| tracking_number | string >= 3 characters Example: tracking_number=Z123456789 Sledovací číslo (hledání podle obsaženého textu). Použije se od 3 znaků; kratší hodnota se ignoruje. |
| status_id | integer >= 1 Example: status_id=12345 ID stavu objednávky Musí jít o jedno kladné celé číslo. |
| eshop_id | integer >= 1 Example: eshop_id=123 ID e-shopu, ze kterého se mají objednávky vrátit Musí jít o jedno kladné celé číslo. |
| utm_source | string Example: utm_source=google UTM parametr source (minimálně 2 znaky). Hledá se podle obsaženého textu; kratší zadaná hodnota vrátí chybu 400. |
| utm_medium | string Example: utm_medium=cpc UTM parametr medium (minimálně 2 znaky). Hledá se podle obsaženého textu; kratší zadaná hodnota vrátí chybu 400. |
| utm_campaign | string Example: utm_campaign=summer_sale UTM parametr campaign (minimálně 2 znaky). Hledá se podle obsaženého textu; kratší zadaná hodnota vrátí chybu 400. |
GET /api/v1/orders/details?eshop_id=2&page=0&per_page=10 HTTP/1.1 Host: www.exitshop.cz X-API-KEY: VAS_API_KLIC Accept: application/json
{- "result": {
- "total": 1,
- "used_filters": {
- "page": "0",
- "per_page": "10",
- "facture_date_from": null,
- "facture_date_to": null,
- "date_from": null,
- "date_to": null,
- "invoice": false,
- "post_filters": [ ],
- "shop": "2"
}, - "invoices": [
- {
- "number": 2301011235,
- "currency": "Kč",
- "currency_code": "CZK",
- "country": "CZ",
- "order_date": "2026-10-12 11:00:27",
- "invoice_date": "2026-10-12 00:00:00",
- "utm_source": "google",
- "utm_medium": "cpc",
- "utm_campaign": "brand",
- "customer": {
- "name": "Jan Novák",
- "street": "Testovní 7",
- "city": "Praha",
- "zip": "10000",
- "ic": null,
- "dic": null,
- "phone": "777123456",
- "email": "jan@example.cz"
}, - "seller": {
- "name": "Testovací prodejce",
- "street": "Měcholupská 88",
- "city": "Praha",
- "zip": "12000",
- "ic": "12345678",
- "dic": "CZ12345678",
- "phone": "777666555",
- "email": "prodejce@example.cz"
}, - "order_status_id": 12,
- "order_status_name": "Vyřízeno",
- "order_status_internal_name": "Dokončeno",
- "shipping_name": "Packeta",
- "goods": [
- {
- "id": 3996331,
- "primary_id": 52665,
- "quantity": 2,
- "price": "250",
- "name": "Povlečení - modré XL",
- "primary_name": "Povlečení - modré XL",
- "vat": "21",
- "barcodes": "1234567890128,",
- "own_id": "XYZ12",
- "AA": "10",
- "BB": "20",
- "CC": "30",
- "DD": "40",
- "alternative": null,
- "warehouse": null,
- "is_service": false,
- "dispatchable": true
}
]
}
]
}
}Vytvoří objednávku v zadaném vlastním e-shopu. internal_id je vaše označení objednávky a musí být pro daný účet a objednávky vytvořené přes API unikátní. shipping_id musí patřit k zadanému e-shopu a primary_id musí označovat vlastní mateřský produkt.
Ceny položek i dopravy jsou včetně DPH a v měně cílového e-shopu. Cena položky je za jeden kus. API použije dodané ceny bez dalších množstevních nebo hodnotových slev.
Doručovací adresa, doprava a položky objednávky jsou povinné. Fakturační adresu a poznámku lze vynechat. Pokud fakturační adresu posíláte, vyplňte alespoň jméno, ulici, město a PSČ; telefon a e-mail se jinak převezmou z doručovací adresy.
Pro výdejní místo Zásilkovny pošlete branch_type: "ZAS", kladné branch_id a branch_name uvnitř objektu shipping. Jiné typy výdejních míst tato metoda nepřenáší.
Limit: 200 požadavků za hodinu.
required | object |
{- "order": {
- "internal_id": "MOJE-2026-001",
- "shop_id": 2,
- "shipping_address": {
- "name": "Jan Novák",
- "street": "Vinohradská 91",
- "city": "Praha",
- "zip": "12000",
- "email": "jan@example.cz",
- "phone": "777123456"
}, - "invoice_address": {
- "name": "Jan Novák",
- "street": "Vinohradská 91",
- "city": "Praha",
- "zip": "12000",
- "email": "jan@example.cz",
- "phone": "777123456",
- "ic": "12345678",
- "dic": "CZ12345678"
}, - "shipping": {
- "shipping_id": 1,
- "price": 79,
- "branch_type": "ZAS",
- "branch_id": 12345,
- "branch_name": "Praha - výdejní místo"
}, - "items": [
- {
- "primary_id": 52665,
- "quantity": 2,
- "price": 250,
- "name": "Povlečení - modré XL"
}
], - "note": "Prosím o brzké dodání."
}
}{- "result": {
- "order_number": "2301011235",
- "message": "Objednávka vytvořena"
}
}Přiřadí objednávkám volné pickovací košíky přidělené držiteli API klíče. Pole orders obsahuje čísla objednávek. Každý košík musí mít dostatečnou velikost; pokud nelze přiřadit všechny objednávky, neprovede se žádné přiřazení.
Limit: 2000 požadavků za hodinu.
| orders required | Array of strings |
{- "orders": [
- "2301011235",
- "2301011236"
]
}{- "result": {
- "orders": [
- {
- "cart": "A01",
- "order_number": "2301011235"
}, - {
- "cart": "A02",
- "order_number": "2301011236"
}
]
}
}Zruší přiřazení košíkům ke všem objednávkám zaměstnance. Limit: 2000 požadavků za hodinu.
DELETE /api/v1/orders/dispatch HTTP/1.1 Host: www.exitshop.cz X-API-KEY: VAS_API_KLIC Accept: application/json
{- "result": {
- "updated": 2
}
}Importuje marketingové náklady k zadanému vlastnímu e-shopu. Pro každou kombinaci data, utm_source a utm_medium se náklad vloží nebo aktualizuje, pokud se hodnota změnila.
expenses je neprázdné pole, nejvýše 5000 řádků. Datum musí být ve formátu RRRR-MM-DD. Částka musí být nezáporné konečné číslo; hodnota null smaže existující záznam dané kombinace. Klíč expenses musí být přítomen v každém řádku i při mazání.
UTM parametry lze vynechat; prázdné hodnoty se sjednotí na null a text se omezí na 255 znaků. Výsledek uvádí počty vložených, změněných, nezměněných a smazaných řádků. Mazání neexistující kombinace žádný z počtů nezvýší.
Limit: 200 požadavků za hodinu.
| shop_id required | integer >= 1 ID vlastního e-shopu. |
required | Array of objects [ 1 .. 5000 ] items |
{- "shop_id": 2,
- "expenses": [
- {
- "date": "2026-10-12",
- "utm_source": "google",
- "utm_medium": "cpc",
- "expenses": 150.5
}, - {
- "date": "2026-10-13",
- "utm_source": "google",
- "utm_medium": "cpc",
- "expenses": 200
}, - {
- "date": "2026-10-14",
- "utm_source": "bing",
- "utm_medium": "cpc",
- "expenses": null
}
]
}{- "result": {
- "inserted": 1,
- "updated": 1,
- "skipped": 0,
- "deleted": 1
}
}