REST rozhranie
Overené
V skratke
Sekcia „V skratke“REST rozhranie je na /api/v1 a odpovedá iba na GET. Čokoľvek iné dostane 405 skôr, než sa server pozrie na kľúč.
Prístup sa preukazuje hlavičkou — viď Prehľad.
Volania
Sekcia „Volania“| Adresa | Rozsah | Čo vráti |
|---|---|---|
GET /account/connection |
stores:read |
Diagnostika tohto pripojenia: aplikácia, kto a kedy povolil, udelené a neudelené rozsahy po oblastiach, e-shopy, režim zápisu cez AI a odtlačok katalógu nástrojov. |
GET /account/entitlements |
account:read |
Tarifa klienta, funkcie a limity s aktuálnym využitím. |
GET /account/team |
team:read |
Tím klienta: mená, roly, aktívne účty, posledné prihlásenie a kto koho vedie; e-mail iba s právom na osobné údaje. |
GET /affiliate/articles/:key |
affiliate:read |
Jeden článok nápovedy so znením (HTML) vo všetkých alebo v jednom jazyku; premenné nedosadené. |
GET /affiliate/articles |
affiliate:read |
Články nápovedy partnerského portálu: kľúč, predvolený/vlastný, zapnutie, poradie, stav po jazykoch (názov, adresa, vyplnené, totožné s predvoleným). |
GET /affiliate/campaigns/:campaignId |
affiliate:read |
Jedna kampaň partnerského programu. |
GET /affiliate/campaigns |
affiliate:read |
Kampane partnerského programu e-shopu s odmenou, dostupnosťou a počtami. |
GET /affiliate/code-requests |
affiliate:read |
Žiadosti partnerov o vlastný zľavový kód so stavom a dôvodom; čakajúce prvé. |
GET /affiliate/conversions/:conversionId |
affiliate:read |
Detail jednej konverzie: sumy, provízia, stav provízie s dôvodom, stav objednávky v e-shope, dobropis, výplata. |
GET /affiliate/conversions |
affiliate:read |
Konverzie partnerského programu e-shopu: základ provízie a celá objednávka s DPH, provízia, stav provízie s dôvodom, stav objednávky v e-shope, väzba na výplatu. |
GET /affiliate/discount-codes |
affiliate:read |
Zľavové kódy partnerov na e-shope s počtom použití a obratom. |
GET /affiliate/documents/:key/content |
affiliate:read |
Jeden právny dokument programu so znením po jazykoch (uložený text, verejné znenie, verzia, odtlačky, zdroj, PDF metadáta) a otvorenými konceptmi. |
GET /affiliate/documents |
affiliate:read |
Dokumenty programu (podmienky, dohody): politika potvrdenia, podpísaná kópia, príloha e-mailu, verzie po jazykoch, pripravenosť a počty potvrdení. |
GET /affiliate/email-templates |
affiliate:read |
Šablóny e-mailov partnerom po jazykoch (predmet, zapnutie, s udalosťou aj telo) a automatické prílohy e-mailu Účet schválený. |
GET /affiliate/links/generate |
affiliate:read |
Sledovaný partnerský odkaz na domov, produkt alebo kategóriu e-shopu kampane; po kliknutí zachová priradenie partnerovi. |
GET /affiliate/partners/:partnerId |
affiliate:read |
Jeden partner programu s kampaňami, ktoré má k dispozícii. |
GET /affiliate/partners |
affiliate:read |
Partneri programu so stavom, výkonom a províziami; kontakt iba s osobnými údajmi. |
GET /affiliate/payouts |
affiliate:read |
Výplaty provízií partnerom so stavom; bez bankových a fakturačných údajov. |
GET /affiliate/portal |
affiliate:read |
Verejný portál partnera: adresy po e-shopoch, otvorenosť registrácie s dôvodom, vlastné domény, kontaktná osoba, vzhľad a stav textov po jazykoch. |
GET /affiliate/settings |
affiliate:read |
Nastavenie partnerského programu: provízie, kliky, minimum výplaty, privedenie. |
GET /affiliate/signatures/:signatureId |
affiliate:read |
Jeden elektronický podpis s podpísaným znením a snímkou hodnôt; nemenný záznam, PDF sa skladá v aplikácii. |
GET /affiliate/signatures |
affiliate:read |
Elektronicky podpísané dokumenty partnerov (kto, dokument, verzia, jazyk, e-shop, čas, spôsob, overenie, odtlačky, stav) a partneri, ktorým podpis chýba; iba čítanie — podpis vzniká výhradne v portáli. |
GET /affiliate/statistics |
affiliate:read |
Štatistika partnerského programu: vývoj po dňoch, zdroje priradenia, rebríček partnerov. |
GET /affiliate/summary |
affiliate:read |
Prehľad partnerského programu e-shopu za obdobie: kliky, konverzie, provízie, partneri. |
GET /affiliate/variables |
affiliate:read |
Register premenných obsahu a e-mailov partnerského programu: kanonické mená, aliasy, typ, plochy, príklad; voliteľná kontrola textu na neznáme premenné. |
GET /analytics/advertising |
reports:read |
Reklama: výdavky, rozpočet, ROAS, PNO, CPA, MER s porovnaním; Google Ads, Meta Ads a OpenAI Ads, kliky z GA4, 6 mesiacov. |
GET /analytics/channels |
analytics:read |
Rozloženie návštev, objednávok a obratu podľa marketingových kanálov. |
GET /analytics/comparison |
reports:read |
Obraty s porovnaním: obrat, objednávky, AOV, návštevy, CR a AI/LLM oproti predchádzajúcemu obdobiu alebo roku. |
GET /analytics/daily |
reports:read |
Obrat a objednávky po dňoch (najviac 92 dní), súčet za e-shopy alebo jeden e-shop. |
GET /analytics/funnels/catalog |
analytics-funnels:read |
Udalosti, parametre a vlastnosti používateľa z GA4 e-shopu pre nastavenie lievika. |
GET /analytics/funnels/:id |
analytics-funnels:read |
Lievik za obdobie: návštevníci krokov z GA4, nákupy a obrat z objednávok, rozpad podľa kanálov, porovnanie. |
GET /analytics/funnels |
analytics-funnels:read |
Lieviky z GA4 (napr. kvíz na webe): kroky, značka návštevníka, stav a posledný import. |
GET /analytics/monthly |
reports:read |
Obrat, objednávky a návštevy po mesiacoch (najviac 24), napríklad rok k roku. |
GET /analytics/order-coverage |
analytics:read |
Pokrytie objednávok a obratu meraním v analytike. |
GET /analytics/order-heatmap |
reports:read |
Kedy prichádzajú objednávky: deň v týždni × hodina, najsilnejší deň a hodina. |
GET /analytics/overview |
analytics:read |
Návštevy, objednávky, obrat, konverzný pomer a AI/LLM podiel za obdobie. |
GET /analytics/revenue-sources |
reports:read |
Odkiaľ prišli tržby: kanály, súčty AI/LLM, MitoOps a Affiliate, rozpad akvizície podľa GA4. |
GET /analytics/seo |
analytics:read |
Search Console: kliknutia, zobrazenia, CTR a pozícia podľa dopytov alebo stránok. |
GET /approvals/pending |
approvals:read |
Čo čaká na schválenie človekom: kroky AI v Denníku AI zmien a Návrhy od AI. |
GET /automations/catalog |
automations:read |
Katalóg automatizácií: spúšťače, podmienky, operátory, akcie, šablóny; catalogVersion pre návrhy. |
GET /automations/:workflowId |
automations:read |
Jedna automatizácia s DSL a výsledkom validácie. |
GET /automations |
automations:read |
Automatizácie klienta so stavom a rozsahom e-shopov. |
GET /automations/options |
automations:read |
Číselník pre pole automatizácie (stavy, dopravy, platby, šablóny, reklamácie…): value do DSL a názov. |
GET /automations/:workflowId/runs |
automations:read |
História behov jednej automatizácie. |
GET /automations/templates |
automations:read |
Hotové vzory automatizácií s DSL. |
GET /campaigns/discount-compute |
campaign-rules:read |
Skutočná zľava z plnej ceny pri akcii a kóde (násobia sa), alebo dopočet druhej časti k cieľovej zľave; porovnanie s limitom e-shopu. |
GET /campaigns/discount-rules |
campaign-rules:read |
Pravidlá zliav e-shopov: či je limit zapnutý, najvyššia súhrnná zľava z plnej ceny, rozsah, režim (ceny, kódy, oboje) a provízia partnerov. |
GET /chatbot/conversations/:sessionId |
chatbot-conversations:read |
Prepis jedného rozhovoru s webovým chatbotom aj so zdrojmi odpovedí bota. |
GET /chatbot/conversations |
chatbot-conversations:read |
Rozhovory zákazníkov s webovým chatbotom od naposledy aktívneho, s prvou otázkou; kurzor. |
GET /chatbot/outcomes |
chatbot:read |
Ako dopadli rozhovory chatbota: odkedy sa meria, merané a nemerané, známy a neznámy výsledok a miera s menovateľom. |
GET /chatbot/stats |
chatbot:read |
Štatistika webového chatbota za obdobie: lievik bublinky, otvorenia, rozhovory, výsledky, hodnotenia. |
GET /chatbot/topics |
chatbot:read |
O čom boli rozhovory: podiely tém, produkty, typ stránky začiatku a kandidáti na medzeru v znalostiach. |
GET /claims/config-drafts/:draftId |
claims-settings:read |
Stav návrhu zmeny nastavení reklamácií (čaká, zapísaný, zamietnutý). |
GET /claims/configuration |
claims-settings:read |
Nastavenia reklamácií: štítky, polia, spätná doprava, formulár na e-shope, typy formulára. |
GET /claims/deadlines |
claims:read |
Otvorené reklamácie podľa lehoty: po lehote a blízko lehoty, od najnaliehavejšej, s počtami po e-shopoch. |
GET /claims/:code |
claims:read |
Jeden prípad s položkami a väzbami: objednávka, dobropis, spätná zásielka, skladový pohyb. |
GET /claims |
claims:read |
Reklamácie a vrátenia jedného e-shopu od najnovšieho. |
GET /claims/refund-options |
claims-settings:read |
Vrátenie peňazí: zdroj variabilného symbolu, platnosť refundačného kupónu, kupón vo formulári, kedy formulár pýta číslo účtu. |
GET /claims/:code/refund-readiness |
claims:read |
Prípad pred refundáciou: čo zákazník žiada, maskovaný účet, variabilný symbol, režim a či sa dá prípad zmazať. |
GET /claims/refund-settings |
claims-settings:read |
Refundácie reklamácií: režim, bankové účty so spôsobilosťou na platobný príkaz (maskované), predvolený a ručný účet. |
GET /claims/routes |
claims-settings:read |
Spätná doprava reklamácií: trasy, adresy, profily dopravcov s ID a podporou vratky, typy prípadov. |
GET /claims/settings |
claims:read |
Procesy reklamácií s ID a názvami (typy, kroky, stavy, lehoty), štítky; nastavenia modulu s rozsahom claims-settings:read. |
GET /claims/statistics |
claims:read |
Štatistika reklamácií a vrátení za obdobie: počty, časy vybavenia, typy, hodnotenia, dôvody. |
GET /claims/templates |
claims-settings:read |
Šablóny e-mailov (predmet, text, kedy a či sa posielajú automaticky) a protokolov reklamácií. |
GET /content/articles |
products:read |
Články blogu e-shopu s adresou na webe a náhľadovým obrázkom. |
GET /coupons/activation-link |
coupons:read |
Odkaz, ktorý zákazníkovi uplatní EXISTUJÚCI kupón v košíku. Kupón nevytvára. |
GET /coupons/activation-status |
coupons:read |
Dá sa kupón na e-shope použiť cez aktivačný odkaz: zrkadlo kupónu + stav kódu na webe. |
GET /coupons/capabilities |
coupons:read |
Čo o kupónoch vie platforma daného e-shopu. Čítajte pred zakladaním. |
GET /coupons/:code |
coupons:read |
Jeden kupón z evidencie MitoOps. Keď v nej nie je, odpoveď je „nenašlo sa“. |
GET /coupons |
coupons:read |
Zľavové kupóny e-shopu s typom a výškou zľavy, platnosťou a odvodeným stavom. |
GET /coupons/web-box |
coupons:read |
Rámiky s cenou po zadaní kódu pri produktoch na e-shope: hlavný vypínač, kupóny, nastavenie a stav. |
GET /coupons/web-box/stats |
coupons:read |
Zobrazenia rámika, kópie kódu a uplatnenia v košíku po kupóne a produkte. |
GET /customers/:customerKey |
customers:read |
Jeden zákazník z adresára — identita, e-shopy, LIFETIME aj voliteľné PERIOD peniaze, rozpis podľa e-shopu. |
GET /customers |
customers:read |
Adresár zákazníkov: identita (s PII maskovaním), e-shopy, jazyk, LIFETIME počty a obrat po menách; voliteľný filter nákupnej aktivity v období. |
GET /customers/performance |
reports:read |
Zákazníci ako pseudonymy: počet objednávok, obrat, prvá a posledná objednávka, opakovaný nákup, LTV. |
GET /credit-notes |
invoices:read |
Hľadanie v dobropisoch. |
GET /documents |
invoices:read |
Účtovné doklady jedného druhu (faktúry, zálohové faktúry, dobropisy) po stranách so životným cyklom, stavom v zdroji, filtrom platnosti a dostupnosťou PDF. |
GET /documents/:documentType/:code/pdf |
invoices:read |
PDF faktúry, zálohovej faktúry alebo dobropisu (base64 a SHA-256), tie isté bajty ako na obrazovke. |
GET /invoices/:invoiceCode |
invoices:read |
Jedna faktúra s položkami, sumami, dobropismi a zálohovými faktúrami k nej. |
GET /invoices |
invoices:read |
Hľadanie vo faktúrach. |
GET /payments/matching |
payments:read |
Párovanie prijatých platieb s objednávkami: počty podľa výsledku a nespárované, nejednoznačné a chybné platby. |
GET /inventory/movements |
inventory:read |
História skladových pohybov: kedy, čo, o koľko, prečo a z akého zdroja. |
GET /inventory/availability |
inventory:read |
Stav zásoby pre viac položiek naraz. |
GET /inventory/product-statistics |
inventory:read |
Po produktoch za obdobie: stav skladu, predané, reklamované a vrátené kusy, miera reklamácií. |
GET /inventory/stock |
inventory:read |
Stav zásoby jednej položky aj so zdrojom hodnoty. |
GET /inventory/sync-status |
stock-sync:read |
Stav synchronizácie skladu medzi e-shopmi: fronta, konflikty, posledný beh a kontrola zhody, mapovanie, zdravie spojenia. |
GET /inventory/valuation |
inventory:read |
Hodnota skladu ako obrazovka: nákupná a predajná hodnota, hrubý a čistý potenciál, pod minimom, záporné, najväčšie položky; bez sád a balíkov. |
GET /messaging/deliveries |
messaging:read |
Doručenie e-mailov k zásielkam, objednávkam, reklamáciám a partnerom: súhrn, stavy a chyby (odrazené, spam, zablokované). |
GET /notifications |
notifications:read |
Upozornenia zo zvončeka: čo hlásia moduly, závažnosť, stav, počet neprečítaných a obrazovka, ktorá to rieši. |
GET /orders/:orderCode |
orders:read |
Jedna uložená objednávka vrátane položiek. |
GET /orders/:orderCode/line-discounts |
orders:read |
Historické ceny a zľavy po položkách objednávky: pôvodná cena, zľava, kupón, zaplatená hodnota a spoľahlivosť. |
GET /orders |
orders:read |
Uložené objednávky, od najnovšej; filter stavu, hľadanie, úhrada, obdobie a úplný počet vo filtri. |
GET /orders/packing-queue |
orders:read |
Fronta balenia podľa stavov, ktoré si klient nastavil ako pripravené na balenie: počet a objednávky na e-shop. |
GET /availabilities/drafts/:draftId |
products:read |
Stav návrhu zmeny číselníka dostupností: čaká na schválenie, zapísaný s výsledkom, zamietnutý, vypršaný. |
GET /availabilities/history |
products:read |
História synchronizácie dostupností: čo sa z ktorého e-shopu prenieslo kam a s akým výsledkom; obdobie, kurzor. |
GET /availabilities |
products:read |
Číselník dostupností e-shopu: názov, popis, naskladnenie, doručenie, význam pre Google, farba, predvolená úloha. |
GET /availabilities/pairing |
products:read |
Párovanie dostupností medzi e-shopmi: riadky s položkou každého e-shopu, návrhy, nespárované, stav synchronizácie. |
GET /availabilities/pairing-drafts/:draftId |
products:read |
Stav návrhu zmeny párovania dostupností: čaká na schválenie, uložený, zamietnutý, vypršaný. |
GET /catalog/category-content-drafts/:draftId |
category-content:read |
Stav návrhu textov kategórií: čaká na schválenie, zapísaný, zamietnutý, vypršaný. |
GET /categories/:guid/content |
category-content:read |
Texty kategórie (horný a dolný popis, SEO titulok a popis) s odtlačkom a zapisovateľnosťou poľa. |
GET /categories/:guid |
category-content:read |
Jedna kategória so živým stavom z e-shopu vrátane viditeľnosti (true/false, null = platforma ju nevedie) a plánov od–do. |
GET /categories |
products:read |
Kategórie e-shopu s počtom produktov. |
GET /categories/:guid/products |
products:read |
Produkty zaradené v kategórii, stránkovane, živo z e-shopu (pri výpadku zo zrkadla s vyznačením zdroja). |
GET /categories/visibility-plans |
category-content:read |
Plány zobrazenia kategórií od–do: čas, stav, pôvodná viditeľnosť, posledný zápis a chyba. |
GET /product-logistics/:code |
product-logistics:read |
Hmotnosť a rozmery predajného balenia variantu naživo z e-shopu (kg, cm), zdedené polia, revízia a posledné zápisy. |
GET /product-logistics/missing |
product-logistics:read |
Kódy e-shopu bez hmotnosti alebo rozmerov (alebo s neoverenými jednotkami); s codes hodnoty z kópie so zdrojom a istotou. |
GET /products/:code/categories |
products:read |
Všetky kategórie produktu po e-shopoch živo z e-shopu: hlavná a ďalšie zaradenia vrátane skrytých kategórií. |
GET /products/changes |
products:read |
Denník zmien produktovej karty: pole, e-shop, kedy, odkiaľ a náhľad starej a novej hodnoty; ceny iba s právom. |
GET /catalog/product-content-drafts/:draftId |
product-content:read |
Stav návrhu textov produktov: čaká na schválenie, zapísaný s upozorneniami e-shopu, zamietnutý, vypršaný. |
GET /products/:code/content |
product-content:read |
Texty produktu z e-shopu (popis, krátky popis, SEO titulok a popis) s odtlačkom a zapisovateľnosťou poľa. |
GET /product-content/policy |
product-content:read |
Politika obsahu na e-shope bez volania e-shopu: čo tento prístup smie čítať a navrhovať, ktoré polia platforma zapíše, režim schvaľovania a autonómny zápis, limity a odtlačky. |
GET /products/:code |
products:read |
Jeden produkt podľa kódu vrátane zaradenia a ceny z karty. |
GET /products/:code/offer |
products:read |
Ponuka produktu v e-shope: či ho e-shop ešte má, viditeľnosť, objednateľnosť, dostupnosť a cena s menou, DPH a cenou v predajnej mene e-shopu. |
GET /products |
products:read |
Hľadanie produktov podľa názvu, kódu, EAN alebo PLU; filter kategórie, aktívnosti a pod minimom s úplným počtom; stav v e-shope, produkty zmazané v e-shope iba na požiadanie. |
GET /products/:code/visibility |
products:read |
Živý stav produktu po e-shopoch: viditeľnosť (aj surový stav platformy), objednateľnosť a indexovateľnosť na čítanie, bežiaci plán od–do. |
GET /catalog/products/visibility-plans |
products:read |
Plány viditeľnosti produktov od–do: čas, stav, pôvodný stav e-shopu, posledný zápis, chyba a posledné kolo plánovača. |
GET /reports/cost-groups |
reports:read |
Kategórie a štítky nákladov a rozloženie skupín v Nákladoch. |
GET /reports/costs |
reports:read |
Ručné aj automatické náklady so sumou, ktorá sa započíta do obdobia; firemné a po e-shopoch. |
GET /reports/financial-summary |
reports:read |
Finančný súhrn obdobia: obrat, DPH, objednávky, AOV; s právami aj nákup, hrubý zisk, náklady a výsledok. |
GET /reports/history/:runId |
reports:read |
Stav jedného exportu a jeho súbory s adresou na stiahnutie cez REST. |
GET /reports/history |
reports:read |
História vygenerovaných reportov so súbormi, veľkosťou a SHA256. |
GET /reports/layout |
reports:read |
Rozloženie exportu reportu: obálka, poradie a zapnutie hárkov a sekcií, zlomy strán. |
GET /reports/notes |
reports:read |
Poznámka k reportom, ktorá ide do Word a PDF výkazu. |
GET /reports/order-status-rules |
reports:read |
Ktoré stavy objednávok sa rátajú do obratu, po e-shopoch, s počtom a obratom v stave. |
GET /reports/summary-all |
reports:read |
Súhrn viacerých e-shopov ako pri „Všetky“: celok, rozpad po e-shopoch, firemné náklady raz, computedAt a dataAsOf. |
GET /sales/order-performance |
reports:read |
Obrat po objednávkach v EUR so súčtami za celé obdobie; s právom aj nákup, hrubý zisk a marža na objednávku. |
GET /sales/product-performance |
reports:read |
Predaje po produktoch z dokladov; s právom aj nákupná cena v čase predaja a marža. |
GET /reviews/:kind/:reviewId |
reviews:read |
Jedna recenzia s históriou odpovedí, jazykom, tónom a podpisom e-shopu a čakajúcim návrhom odpovede. |
GET /reviews |
reviews:read |
Recenzie obchodu a produktov jedného e-shopu: hviezdičky, text, produkt, odpoveď e-shopu, čakajúci návrh; filtre a obdobie. |
GET /reviews/reply-drafts/:draftId |
reviews:read |
Stav návrhu odpovede na recenziu: čaká na schválenie, zverejnený, zamietnutý, vypršaný. |
GET /reviews/statistics |
reviews:read |
Štatistika recenzií e-shopu za obdobie: počet, bez odpovede, priemer, počet podľa hviezdičiek a po druhoch. |
GET /reviews/web-display |
reviews:read |
Blok recenzií na stránke produktu (skript na webe): či je zapnutý, podpora platformy a nastavenie (od akého hodnotenia, koľko, vlastné áno/nie, texty). |
GET /search-console/query |
search-console:read |
Search Console po dňoch, dopytoch, stránkach, krajinách a zariadeniach, so stránkovaním a odtlačkom. |
GET /search-console/status |
search-console:read |
Stav Search Console e-shopu: pripojenie, property, oprávnenie, synchronizácia a rozsah archívu. |
GET /shipping/carriers |
shipping:read |
Pripojení dopravcovia a ich profily, bez prístupových údajov. |
GET /shipping/overview |
shipping:read |
Prehľad expedície: na zabalenie, čaká na odovzdanie, na ceste, chyby dopravcu, dobierky, s rozpisom po e-shopoch. |
GET /shipping/packing-performance |
shipping:read |
Výkon balenia po ľuďoch: počet zabalených objednávok, čas balenia (priemer a medián), čas do zabalenia a do odovzdania, porovnanie s tímom. |
GET /shipping/pickups |
shipping:read |
Zvoz po dopravcoch: dokedy objednať, dokedy prevzatie, čo čaká na zvoz a objednané zvozy. |
GET /shipping/returns |
shipping:read |
Spätné zásielky (vratky) so stavom a reklamáciou, súčty na ceste a nevybavené po e-shopoch. |
GET /shipping/shipments/:shipmentId |
shipping:read |
Jedna zásielka so všetkými udalosťami sledovania. |
GET /shipping/shipments |
shipping:read |
Zásielky jedného e-shopu s dopravcom, krajinou a časmi odovzdania a doručenia. |
GET /shipping/stats |
shipping:read |
Štatistiky doručovania podľa dopravcov: počty, úspešnosť, medián a p90 času doručenia, krajiny. |
GET /stores/integration-status |
stores:read |
Stav MitoOps kódu na webe po e-shopoch: nainštalované, verzia, moduly, pripravenosť kupónu z adresy. |
GET /stores |
stores:read |
Zoznam e-shopov klienta aj s ich kódom. |
GET /purchasing/advisor |
purchasing:read |
Nákupný návrh: čo dokúpiť a koľko, naliehavosť, stav, minimum a odhad potreby; globálne za jeden sklad. |
GET /suppliers/:supplierId |
purchasing:read |
Jeden dodávateľ s ponukami produktov a nákladovými zložkami. |
GET /suppliers |
purchasing:read |
Dodávatelia klienta s počtom ponúk a napárovaných produktov. |
GET /webhooks/endpoints/:endpointId/deliveries |
webhooks:read |
Denník doručení jedného endpointu bez tela. |
GET /webhooks/endpoints/:endpointId |
webhooks:read |
Jeden webhook endpoint s počtom čakajúcich doručení. |
GET /webhooks/endpoints |
webhooks:read |
Webhook endpointy klienta bez tajomstiev a stav fronty. |
GET /webhooks/events |
webhooks:read |
Katalóg udalostí odchádzajúcich webhookov, obálka a podpis. |
| Adresa | Rozsah | Čo vráti |
|---|---|---|
GET /capabilities |
— | čo tento kľúč smie zavolať |
GET /openapi.json |
— | strojovo čitateľný popis rozhrania |
GET /capabilities je najrýchlejší spôsob, ako zistiť, čo kľúč otvára — vracia presne to, čo mu rozsahy dovolili, nie celý katalóg. Presné parametre a polia odpovede každého volania sú v openapi.json.
Tvar odpovede
Sekcia „Tvar odpovede“Každá odpoveď má dve časti: data a meta.
{ "data": [ { "market": "sk", "name": "Môj e-shop" } ], "meta": { "requestId": "…", "count": 1 }}meta.requestId je identifikátor volania. Ak sa niečo pokazí, je to údaj, ktorý podpore povie, o ktoré volanie išlo.
Pri výpisoch nesie meta navyše:
| Pole | Význam |
|---|---|
count |
koľko záznamov je v tejto odpovedi |
hasMore |
true, keď ďalšia strana existuje |
nextCursor |
hodnota, ktorou si o ďalšiu stranu poviete; null, keď žiadna nie je |
Pri súhrnoch (štatistiky, prehľad, finančný súhrn) je celá odpoveď v data ako jeden objekt.
Stránkovanie
Sekcia „Stránkovanie“Ďalšiu stranu si vypýtate tak, že nextCursor z odpovede pošlete späť v parametri cursor:
curl -H "Authorization: Bearer <váš kľúč>" \ "https://<vaša adresa>/api/v1/shipping/shipments?market=sk&from=2026-08-01&to=2026-08-31&limit=50&cursor=<nextCursor>"Tri veci, na ktorých to stojí:
- Ostatné parametre musia zostať rovnaké. Kurzor patrí k dopytu, s ktorým vznikol. So zmeneným e-shopom, obdobím alebo filtrom ho rozhranie odmietne (
400) — pokračovať v poradí, ktoré už neplatí, by ticho vrátilo nesúvislý výrez. - Koniec spoznáte podľa
hasMore, nie podľa počtu. Odpoveď môže mať presne toľko záznamov, koľko ste pýtali, a ďalšia strana napriek tomu existovať. - Neplatný kurzor je chyba, nie prázdny výsledok. Prázdna odpoveď by vyzerala ako koniec dát a export by sa ticho skrátil.
Kurzorom sa stránkujú objednávky, doklady, katalóg a zásielky. Číslovanie strán rozhranie nemá zámerne: keď medzi dvoma volaniami pribudne záznam, „strana 2“ ukazuje inam než pred chvíľou; kurzor nesie posledný videný záznam, takže sa nič nezopakuje ani nevynechá.
Výpis a hľadanie
Sekcia „Výpis a hľadanie“Pri produktoch, faktúrach a dobropisoch sú to dva režimy jednej adresy:
| Ako voláte | Čo dostanete |
|---|---|
bez query |
výpis po stranách, od najnovšieho; dá sa stránkovať a obmedziť obdobím |
s query |
hľadanie zoradené podľa zhody; vráti najviac limit záznamov |
Hľadanie sa nestránkuje a neobmedzuje obdobím — poradie podľa zhody sa medzi volaniami mení a kurzor nad ním by záznamy preskakoval. Kombinácia query s cursor, from alebo to preto skončí ako 400, nie ako ticho ignorovaný filter.
Na vyčítanie celej evidencie použite výpis bez query.
Obdobie
Sekcia „Obdobie“Objednávky, doklady, zásielky, štatistiky, analytika aj výkazy sa dajú obmedziť parametrami from a to v tvare YYYY-MM-DD.
- Obe hranice sú vrátane.
to=2026-08-05zahŕňa celý 5. august, nie polnoc na jeho začiatku. - Deň sa berie tak, ako ho eviduje aplikácia — objednávky v pásme e-shopu, zásielky a výkazy tak, ako ich vidí obsluha na obrazovke.
- Objednávky sa radia podľa dátumu vzniku objednávky, zásielky podľa dátumu vzniku zásielky.
- Faktúry a dobropisy podľa daňového dátumu; keď ho doklad nemá vyplnený, podľa dátumu vystavenia. Ktorá hodnota doklad zaradila, vidno v poli
businessDate. - Predaje po produktoch podľa dátumu dokladu; tu je obdobie povinné.
- Najdlhšie obdobie je 366 dní. Dlhšie sa odmietne; dlhšiu históriu prejdite po rokoch.
- Obrátené obdobie je chyba, nie prázdny výsledok — inak by preklep vyzeral ako obdobie bez dokladov.
- Bez obdobia vrátia zásielky a štatistiky posledných 30 dní, analytika a finančný súhrn aktuálny mesiac. Odpoveď obdobie vždy vypíše.
Pri objednávkach zostáva aj todayOnly. S from/to sa nedá spojiť: sú to dve odpovede na tú istú otázku a jedna z nich by ticho vyhrala.
Čo znamenajú finančné polia
Sekcia „Čo znamenajú finančné polia“purchasePriceWithoutVatpri položke objednávky je nákupná cena v čase objednávky, tak ako ju uložil e-shop. Nie je to cena z dnešnej karty produktu — tá je vproducts/{code}akopurchasePrice.cogsvo finančnom súhrne je nákup tovaru za obdobie zo všetkých objednávok;nullznamená, že nákupné ceny nie sú známe pre dosť riadkov (cogsCoverage). Vtedy sa neukáže ani hrubý zisk — radšej nič než nesprávne číslo.grossProfitje obrat bez DPH mínus nákup tovaru,grossMarginto isté v percentách.resultAfterCostsje hrubý zisk mínus doprava mínus náklady firmy — manažérske číslo, nie účtovný zisk.- V predajoch po produktoch je
purchaseCostWithoutVatnákupná cena v čase dokladu podľa spárovania s katalógom;unmappedLineshovorí, koľko riadkov sa nespárovalo. - Všetky sumy výkazov a analytiky sú v EUR (pole
currency), prepočítané kurzom v čase synchronizácie. Objednávky a doklady nesú vlastnú menu.
Bez rozsahu purchase-prices:read tieto polia v odpovedi nie sú — nie sú nulové, chýbajú.
Čas doručenia
Sekcia „Čas doručenia“Štatistiky doručovania (shipping/stats) merajú čas od odovzdania dopravcovi po prvú udalosť doručenia z udalostí sledovania. Z dátumu objednávky sa nepočíta nič. Zásielka, ktorá nemá oba body, sa do mediánu nezapočíta; koľko sa ich započítalo, hovorí delivery.measured. Tie isté dva časy nesie každá zásielka v poliach handedOverAt a deliveredAt.
deliveryRate je podiel doručených z tých, ktorých osud sa už skončil (doručené, vrátené, chybné). Zásielka na ceste ešte nie je ani úspech, ani neúspech; zrušená zásielka je váš úkon, nie zlyhanie dopravcu, a neráta sa vôbec.
Stav zásob
Sekcia „Stav zásob“inventory/stock vracia quantity a source — z ktorého evidenčného modelu hodnota pochádza (varianty, bilancia e-shopu, karta produktu). Keď e-shop vedie bilanciu, sú k dispozícii aj physical, available (dostupné na predaj) a reserved (rezervované v objednávkach); inak sú null. Rozhranie nevymýšľa žiadny „stav na sklade“, ktorý aplikácia neeviduje.
Stav zásob (inventory/stock a inventory/availability, rozsah inventory:read) hovorí, koľko tovaru je; číselník dostupností (/availabilities, rozsah products:read) sú pomenované stavy, ktoré e-shop ukazuje zákazníkovi pri produkte, napríklad Skladom alebo Na objednávku.
Štatistika produktov
Sekcia „Štatistika produktov“GET /inventory/product-statistics?market=sk&from=2026-01-01&to=2026-10-24 (rozsah inventory:read) vráti v data produkty jedného e-shopu: code, name, ean, active, stockQuantity a stockSource (ako inventory/stock), soldQty (predané kusy, výdaj k číslu objednávky) a s rozsahom claims:read aj claimedQty (reklamované kusy), claimCases (počet prípadov), claimRatePercent (reklamované / predané × 100, null bez predaja), claimRateReliable (false pod 20 predanými kusmi), returnedQty (vrátené bez vady), claimedRestockedQty a claimedNotRestockedQty. meta.totals sú za celý filter a nesú navyše unmatchedClaimedQty a unmatchedReturnedQty, kusy prípadov, ktoré sa nepodarilo priradiť k produktu.
Reklamovaný kus je položka prípadu typu reklamácia alebo položka s dôvodom vada či poškodenie pri preprave. Bežné odstúpenie od zmluvy, vrátenie a výmena bez vady sú vrátené kusy. Zamietnutá položka sa nepočíta, prípad patrí do obdobia podľa dátumu založenia. Bez rozsahu claims:read polia z reklamácií v odpovedi nie sú (nie sú nulové) a filter withClaimsOnly=true skončí chybou. Bez obdobia platí aktuálny rok, okno je najviac 366 dní; stránkuje sa limit a cursor.
Číselník dostupností
Sekcia „Číselník dostupností“GET /availabilities?market=sk vráti v data položky číselníka jedného e-shopu: id, name, description, onStockHours, deliveryHours, meaning (význam pre Google Nákupy: in_stock, backorder, preorder, out_of_stock), color, system, defaultRoles (predvolená úloha v e-shope) a pairingRows (v koľkých riadkoch párovania dostupností položka je). meta nesie market, manageable a reason: či sa číselník dá v MitoOps meniť, a ak nie, prečo (PLATFORMA, BEZ_ROZSIRENIA, PROSTREDIE).
Zmena číselníka cez REST nejde. Pripraviť ju vie iba asistent cez MCP, a to ako návrh s citlivým rozsahom availabilities:draft; do e-shopu ho zapíše až človek schválením v aplikácii. Stav takého návrhu si cez REST prečítate: GET /availabilities/drafts/:draftId vráti status (pending, writing, executed, partial, failed, rejected, expired), náhľad a po schválení výsledok po položkách. Podrobne v MCP rozhraní.
Adresár zákazníkov
Sekcia „Adresár zákazníkov“Zákazníci majú dve rôzne čítania a mýliť si ich znamená čítať iné číslo, než čakáte:
/customersa/customers/{customerKey}(rozsahcustomers:read) sú adresár: tá istá projekcia, akú vidí obsluha na obrazovke Zákazníci a aká ide do exportu — identita, e-shopy, krajina, jazyk, počty a dátumy./customers/performance(rozsahreports:read) je analytika nad surovými objednávkami: zákazník je iba pseudonym, meno ani kontakt v nej nie sú vôbec.
Zvonku je market povinný pri oboch. Bez neho by sa čítalo cez všetky e-shopy klienta, teda aj cez tie, ktoré prístupu nepatria.
Kto uvidí čo
Sekcia „Kto uvidí čo“customers:read sám vydá pseudonym (customerKey), e-shopy, krajinu, jazyk, počty objednávok a dátumy prvej a poslednej objednávky. Navyše:
- meno, firma, e-mail, telefón a marketingové pohlavie iba s
personal-data:read, - obrat, priemerná objednávka a LTV iba s
reports:read.
Polia, na ktoré nemáte rozsah, sa odstránia, nie vynulujú. null na mieste e-mailu by znamenalo „zákazník e-mail nemá“, čo nie je pravda — chýbajúci kľúč znamená „nemáte naň právo“.
customerKey je SHA-256 normalizovaného e-mailu. Je to ten istý pseudonym, aký nesú doklady (customerEmailHash) aj /customers/performance, takže sa tie tri pohľady dajú spojiť bez toho, aby sa niekde posielal e-mail.
Celý život verzus obdobie
Sekcia „Celý život verzus obdobie“Adresár má voliteľný filter purchaseFrom a purchaseTo (YYYY-MM-DD, obe hranice vrátane). Znamená nákupnú aktivitu v období: zákazník má v tom intervale aspoň jednu objednávku. Nie je to filter na dátum prvého alebo posledného nákupu.
S obdobím pribudnú polia periodFrom, periodTo, periodOrdersCount a periodRevenueByCurrency vedľa celoživotných (ordersCount, revenue, lifetimeRevenue, firstOrderAt, lastOrderAt) — nikdy namiesto nich. Celoživotné hodnoty sa obdobím nemenia.
Peniaze sú vždy po menách
Sekcia „Peniaze sú vždy po menách“Obrat, priemerná objednávka a LTV sú pole po menách, nikdy jedno číslo. Zákazník s objednávkami v EUR aj v CZK má dve položky; sčítať ich do jedného skalára by znamenalo pripočítať koruny k eurám. To isté platí pre /customers/performance: riadok je dvojica (zákazník, mena) a súčty filtra sú totals.revenueByCurrency.
Jazyk a marketingové pohlavie
Sekcia „Jazyk a marketingové pohlavie“languageje jazyk e-shopu, na ktorom zákazník objednal (source: "store_locale"), nie jeho vlastná voľba. Aplikácia dnes explicitnú jazykovú preferenciu zákazníka neeviduje.marketingGender(male/female/unknown) je odhad z krstného mena, nie údaj, ktorý by zákazník uviedol. Pôvod je vždy vgenderSource— dnes výhradnename_inferencealebounknown— a spoľahlivosť vgenderConfidence. Firemný zákazník pole nemá. Kto ho zobrazuje ďalej, má hovoriť „odhad podľa mena“, nikdy „zákazník uviedol“. Ide zapersonal-data:readrovnako ako meno samo.
E-shop
Sekcia „E-shop“Volania nad údajmi jedného e-shopu si vypýtajú jeho kód v parametri market. Zoznam kódov vydá GET /stores.
Keď kľúč na daný e-shop nemá rozsah, odpoveď je 403 — nie prázdny zoznam. Prázdny zoznam by sa nedal odlíšiť od e-shopu bez objednávok. Záznam iného e-shopu (napríklad zásielka) je 404.
Chyby
Sekcia „Chyby“Chybová odpoveď má vždy rovnaký tvar a nesie kód. Zoznam stavov a kódov je v Prehľade.
Príklady
Sekcia „Príklady“# Objednávky za obdobie, po stranáchcurl -H "Authorization: Bearer <váš kľúč>" \ "https://<vaša adresa>/api/v1/orders?market=sk&from=2026-08-01&to=2026-08-31&limit=50"
# Štatistiky doručovania za augustcurl -H "Authorization: Bearer <váš kľúč>" \ "https://<vaša adresa>/api/v1/shipping/stats?market=sk&from=2026-08-01&to=2026-08-31"
# Zásielky jedného dopravcu za augustcurl -H "Authorization: Bearer <váš kľúč>" \ "https://<vaša adresa>/api/v1/shipping/shipments?market=sk&from=2026-08-01&to=2026-08-31&carrier=dhl"
# Finančný súhrn augusta (s právom na nákupné ceny aj hrubý zisk)curl -H "Authorization: Bearer <váš kľúč>" \ "https://<vaša adresa>/api/v1/reports/financial-summary?market=sk&from=2026-08-01&to=2026-08-31"
# Stav zásoby troch položiekcurl -H "Authorization: Bearer <váš kľúč>" \ "https://<vaša adresa>/api/v1/inventory/availability?market=sk&codes=A100,A101,A102"
# Číselník dostupností e-shopucurl -H "Authorization: Bearer <váš kľúč>" \ "https://<vaša adresa>/api/v1/availabilities?market=sk"