REST interfész

Ellenőrizveellenőrizve 2026-09-20

Röviden

A REST interfész a /api/v1 címen érhető el, és kizárólag GET kérésekre válaszol. Minden más kérés 405 választ kap, még mielőtt a szerver megnézné a kulcsot.

A hozzáférést fejléccel kell igazolni, lásd az Áttekintés oldalt.

Hívások

Végpont	Hatókör	Mit ad vissza
`GET /account/connection`	`stores:read`	A kapcsolat diagnosztikája: az alkalmazás, ki és mikor adott hozzáférést, megadott és hiányzó jogosultságok területenként, webáruházak és az AI-írási mód.
`GET /account/entitlements`	`account:read`	A fiók tarifája, funkciói és limitjei az aktuális kihasználtsággal.
`GET /affiliate/articles/:key`	`affiliate:read`	Egy súgócikk szövegével (HTML) minden nyelven vagy egy nyelven; a változók nincsenek behelyettesítve.
`GET /affiliate/articles`	`affiliate:read`	A partnerportál súgócikkei: kulcs, alapértelmezett/saját, bekapcsolás, sorrend, nyelvenkénti állapot (cím, URL, kitöltöttség, egyezés az alapértelmezettel).
`GET /affiliate/campaigns/:campaignId`	`affiliate:read`	A partnerprogram egy kampánya.
`GET /affiliate/campaigns`	`affiliate:read`	A webáruház partnerprogramjának kampányai jutalommal, elérhetőséggel és darabszámokkal.
`GET /affiliate/code-requests`	`affiliate:read`	A partnerek saját kedvezménykódra vonatkozó kérelmei állapottal és indoklással; a függőben lévők elöl.
`GET /affiliate/conversions/:conversionId`	`affiliate:read`	Egy konverzió részletei: összegek, jutalék, a jutalék állapota indoklással, a rendelés állapota a webáruházban, jóváíró számla, kifizetés.
`GET /affiliate/conversions`	`affiliate:read`	A webáruház partnerprogramjának konverziói: a jutalék alapja és a teljes rendelés áfával, jutalék, a jutalék állapota indoklással, a rendelés állapota a webáruházban, kapcsolat a kifizetéssel.
`GET /affiliate/discount-codes`	`affiliate:read`	A partnerek kedvezménykódjai a webáruházban a felhasználások számával és a forgalommal.
`GET /affiliate/documents/:key/content`	`affiliate:read`	A program egy jogi dokumentuma nyelvenkénti szöveggel (tárolt szöveg, nyilvános szöveg, verzió, ujjlenyomatok, forrás, PDF-metaadatok) és a nyitott piszkozatokkal.
`GET /affiliate/documents`	`affiliate:read`	A program dokumentumai (feltételek, megállapodások): megerősítési szabályzat, aláírt példány, e-mail-melléklet, nyelvenkénti verziók, készültség és a megerősítések száma.
`GET /affiliate/email-templates`	`affiliate:read`	A partnereknek szóló e-mail-sablonok nyelvenként (tárgy, bekapcsolás, eseménnyel együtt a törzs is) és a „Fiók jóváhagyva” e-mail automatikus mellékletei.
`GET /affiliate/links/generate`	`affiliate:read`	Követett partnerlink a kampány webáruházának kezdőlapjára, egy termékre vagy kategóriára; kattintás után megőrzi a partnerhez rendelést.
`GET /affiliate/partners/:partnerId`	`affiliate:read`	A program egy partnere a számára elérhető kampányokkal.
`GET /affiliate/partners`	`affiliate:read`	A program partnerei állapottal, teljesítménnyel és jutalékokkal; kapcsolattartási adatok csak a személyes adatokkal.
`GET /affiliate/payouts`	`affiliate:read`	A partnereknek járó jutalékok kifizetései állapottal; banki és számlázási adatok nélkül.
`GET /affiliate/portal`	`affiliate:read`	A partner nyilvános portálja: címek webáruházanként, a regisztráció nyitottsága indoklással, saját domainek, kapcsolattartó, megjelenés és a szövegek állapota nyelvenként.
`GET /affiliate/settings`	`affiliate:read`	A partnerprogram beállításai: jutalékok, kattintások, kifizetési minimum, ajánlás.
`GET /affiliate/signatures/:signatureId`	`affiliate:read`	Egy elektronikus aláírás az aláírt szöveggel és az értékek pillanatképével; megváltoztathatatlan rekord, a PDF az alkalmazásban áll össze.
`GET /affiliate/signatures`	`affiliate:read`	A partnerek elektronikusan aláírt dokumentumai (ki, dokumentum, verzió, nyelv, webáruház, idő, mód, ellenőrzés, ujjlenyomatok, állapot) és azok a partnerek, akiktől hiányzik az aláírás; csak olvasás, aláírás kizárólag a portálon jön létre.
`GET /affiliate/statistics`	`affiliate:read`	A partnerprogram statisztikája: napi alakulás, a hozzárendelés forrásai, partnerrangsor.
`GET /affiliate/summary`	`affiliate:read`	A webáruház partnerprogramjának áttekintése az időszakra: kattintások, konverziók, jutalékok, partnerek.
`GET /affiliate/variables`	`affiliate:read`	A partnerprogram tartalmi és e-mail-változóinak nyilvántartása: kanonikus nevek, aliasok, típus, felületek, példa; a szöveg opcionális ellenőrzése ismeretlen változókra.
`GET /analytics/advertising`	`reports:read`	Hirdetés: költés, keret, ROAS, reklámköltés aránya, CPA, átlagos rendelésérték és MER összehasonlítással; Google Ads és Meta Ads, kattintások a GA4-ből, 6 hónap.
`GET /analytics/channels`	`analytics:read`	A látogatások, rendelések és a forgalom megoszlása marketingcsatornák szerint.
`GET /analytics/comparison`	`reports:read`	Árbevétel összehasonlítással: árbevétel, rendelések, AOV, látogatások, CR és AI/LLM az előző időszakhoz vagy évhez képest.
`GET /analytics/monthly`	`reports:read`	Árbevétel, rendelések és látogatások havonta (legfeljebb 24), például év/év összevetéshez.
`GET /analytics/order-coverage`	`analytics:read`	A rendelések és a forgalom lefedettsége az analitikai méréssel.
`GET /analytics/order-heatmap`	`reports:read`	Mikor érkeznek a rendelések: a hét napja × óra, legerősebb nap és óra.
`GET /analytics/overview`	`analytics:read`	Látogatások, rendelések, forgalom, konverziós arány és az AI/LLM részaránya az időszakban.
`GET /analytics/revenue-sources`	`reports:read`	Honnan jött az árbevétel: csatornák, AI/LLM, MitoOps és Affiliate összesítők, akvizíció a GA4 szerint.
`GET /analytics/seo`	`analytics:read`	Search Console: kattintások, megjelenések, CTR és pozíció lekérdezések vagy oldalak szerint.
`GET /automations/catalog`	`automations:read`	Az automatizálások katalógusa: indítók, feltételek, operátorok, műveletek, sablonok; catalogVersion a javaslatokhoz.
`GET /automations/:workflowId`	`automations:read`	Egy automatizálás a DSL-lel és a validálás eredményével.
`GET /automations`	`automations:read`	A fiók automatizálásai állapottal és a webáruházak körével.
`GET /automations/options`	`automations:read`	Értéklista egy automatizálási mezőhöz (állapotok, szállítási módok, fizetési módok, sablonok, reklamációk…): a DSL-be kerülő value és a név.
`GET /automations/:workflowId/runs`	`automations:read`	Egy automatizálás futásainak előzményei.
`GET /automations/templates`	`automations:read`	Kész automatizálási minták DSL-lel.
`GET /chatbot/conversations/:sessionId`	`chatbot-conversations:read`	Egy webes chatbot-beszélgetés átirata a bot válaszainak forrásaival együtt.
`GET /chatbot/conversations`	`chatbot-conversations:read`	Az ügyfelek beszélgetései a webes chatbottal a legutóbb aktívtól kezdve, az első kérdéssel; kurzor.
`GET /chatbot/outcomes`	`chatbot:read`	How web chatbot conversations ended: since when the outcome is measured, measured and unmeasured conversations, known and unknown outcome, resolved, unresolved, bot error and resolution rate with its denominator; N/A with a reason when the denominator is zero. Totals only.
`GET /chatbot/stats`	`chatbot:read`	A webes chatbot statisztikája az időszakra: a buborék tölcsére, megnyitások, beszélgetések, eredmények, értékelések.
`GET /chatbot/topics`	`chatbot:read`	Miről szóltak a beszélgetések: a témák részaránya, termékek, a kezdőoldal típusa és a tudáshiány-jelöltek.
`GET /claims/config-drafts/:draftId`	`claims-settings:read`	A reklamációs beállítások módosítási javaslatának állapota (várakozik, beírva, elutasítva).
`GET /claims/configuration`	`claims-settings:read`	A reklamációk beállításai: címkék, mezők, visszaszállítás, űrlap a webáruházban, az űrlap típusai.
`GET /claims/:code`	`claims:read`	Egy eset tételekkel és kapcsolatokkal: rendelés, jóváíró számla, visszaküldemény, készletmozgás.
`GET /claims`	`claims:read`	Egy webáruház reklamációi és visszaküldései a legújabbtól.
`GET /claims/refund-options`	`claims-settings:read`	Refunds: variable symbol source, refund coupon validity, coupon in the form, when the form asks for an account number.
`GET /claims/:code/refund-readiness`	`claims:read`	Claim before a refund: what the customer requests, masked account, variable symbol, mode and whether the claim can be deleted.
`GET /claims/refund-settings`	`claims-settings:read`	Reklamációs visszatérítések: mód, bankszámlák fizetési megbízásra való alkalmassággal (maszkolva), alapértelmezett és kézi számla.
`GET /claims/routes`	`claims-settings:read`	Reklamációk visszaszállítása: útvonalak, címek, futárprofilok azonosítókkal és visszaküldési támogatással, ügytípusok.
`GET /claims/settings`	`claims:read`	A reklamációk folyamatai azonosítókkal és nevekkel (típusok, lépések, állapotok, határidők), címkék; a modul beállításai a claims-settings:read hatókörrel.
`GET /claims/statistics`	`claims:read`	A reklamációk és visszaküldések statisztikája az időszakra: darabszámok, intézési idők, típusok, értékelések, okok.
`GET /claims/templates`	`claims-settings:read`	Reklamációs e-mail-sablonok (tárgy, szöveg, mikor és hogy automatikusan mennek-e ki) és jegyzőkönyv-sablonok.
`GET /content/articles`	`products:read`	A webáruház blogcikkei a webes címmel és előnézeti képpel.
`GET /coupons/activation-link`	`coupons:read`	Hivatkozás, amely a vásárló kosarában érvényesít egy MEGLÉVŐ kupont. Kupont nem hoz létre.
`GET /coupons/activation-status`	`coupons:read`	Használható-e a kupon a webáruházban aktiváló hivatkozáson keresztül: a kupon tükre + a kód állapota a weben.
`GET /coupons/capabilities`	`coupons:read`	Mit tud a kuponokról az adott webáruház platformja. Létrehozás előtt olvassa el.
`GET /coupons/:code`	`coupons:read`	Egy kupon a MitoOps nyilvántartásából. Ha nincs benne, a válasz „nem található”.
`GET /coupons`	`coupons:read`	A webáruház kedvezménykuponjai a kedvezmény típusával és mértékével, érvényességgel és származtatott állapottal.
`GET /customers/:customerKey`	`customers:read`	Egy ügyfél az ügyféladatbázisból: identitás, webáruházak, LIFETIME és opcionálisan PERIOD pénzösszegek, bontás webáruházanként.
`GET /customers`	`customers:read`	Ügyféladatbázis: identitás (PII-maszkolással), webáruházak, nyelv, LIFETIME darabszámok és forgalom pénznemenként; opcionális szűrő a vásárlási aktivitásra az időszakban.
`GET /customers/performance`	`reports:read`	Ügyfelek pszeudonimként: rendelések száma, forgalom, első és utolsó rendelés, ismételt vásárlás, LTV.
`GET /credit-notes`	`invoices:read`	Keresés a jóváíró számlákban.
`GET /documents`	`invoices:read`	Egy fajta könyvelési bizonylatai (számlák, előlegszámlák, jóváírások) oldalanként életciklussal, forrásbeli állapottal, érvényességi szűrővel és PDF-elérhetőséggel.
`GET /documents/:documentType/:code/pdf`	`invoices:read`	Számla, előlegszámla vagy jóváíró számla PDF-je (base64 és SHA-256), ugyanazok a bájtok, mint a képernyőn.
`GET /invoices/:invoiceCode`	`invoices:read`	Egy számla tételekkel, összegekkel, a hozzá tartozó jóváíró számlákkal és előlegszámlákkal.
`GET /invoices`	`invoices:read`	Keresés a számlákban.
`GET /inventory/movements`	`inventory:read`	A készletmozgások előzményei: mikor, mi, mennyivel, miért és milyen forrásból.
`GET /inventory/availability`	`inventory:read`	Több tétel készletszintje egyszerre.
`GET /inventory/stock`	`inventory:read`	Egy tétel készletszintje az érték forrásával együtt.
`GET /orders/:orderCode`	`orders:read`	Egy tárolt rendelés a tételekkel együtt.
`GET /orders`	`orders:read`	Egy webáruház tárolt rendelései a legújabbtól.
`GET /availabilities/drafts/:draftId`	`products:read`	Az elérhetőséglista módosítási javaslatának állapota: jóváhagyásra vár, eredménnyel beírva, elutasítva, lejárt.
`GET /availabilities`	`products:read`	A webáruház elérhetőséglistája: név, leírás, készletre kerülés, kézbesítés, jelentés a Google számára, szín, alapértelmezett szerep.
`GET /catalog/category-content-drafts/:draftId`	`category-content:read`	Kategóriaszöveg-javaslat állapota: jóváhagyásra vár, beírva, elutasítva, lejárt.
`GET /categories/:guid/content`	`category-content:read`	A kategória szövegei (felső és alsó leírás, SEO-cím és -leírás) lenyomattal és írhatósággal.
`GET /categories`	`products:read`	A webáruház kategóriái a termékek számával.
`GET /catalog/product-content-drafts/:draftId`	`product-content:read`	Termékszöveg-javaslat állapota: jóváhagyásra vár, beírva a webshop figyelmeztetéseivel, elutasítva, lejárt.
`GET /products/:code/content`	`product-content:read`	A termék szövegei a webshopból (leírás, rövid leírás, SEO-cím és -leírás) lenyomattal és írhatósággal.
`GET /product-content/policy`	`product-content:read`	A webshop tartalomszabályzata a webshop hívása nélkül: mit olvashat és javasolhat ez a hozzáférés, mely mezőket írja a platform, jóváhagyási mód és önálló írás, korlátok és lenyomatok.
`GET /products/:code`	`products:read`	Egy termék kód alapján, a besorolással és a termékkártyán szereplő árral együtt.
`GET /products`	`products:read`	Termékek keresése név, kód, EAN vagy PLU alapján.
`GET /reports/financial-summary`	`reports:read`	Az időszak pénzügyi összesítője: forgalom, áfa, rendelések, AOV; jogosultságokkal a beszerzés, a bruttó nyereség, a költségek és az eredmény is.
`GET /sales/order-performance`	`reports:read`	Forgalom rendelésenként EUR-ban, összesítéssel a teljes időszakra; jogosultsággal a beszerzés, a bruttó nyereség és az árrés is rendelésenként.
`GET /sales/product-performance`	`reports:read`	Értékesítés termékenként a bizonylatokból; jogosultsággal az eladáskori beszerzési ár és az árrés is.
`GET /search-console/query`	`search-console:read`	Search Console napok, lekérdezések, oldalak, országok és eszközök szerint, lapozással és tartalomhash-sel.
`GET /search-console/status`	`search-console:read`	A webáruház Search Console-állapota: kapcsolat, tulajdon, jogosultság, szinkronizálás és az archívum terjedelme.
`GET /shipping/carriers`	`shipping:read`	Csatlakoztatott szállítók és profiljaik, hozzáférési adatok nélkül.
`GET /shipping/shipments/:shipmentId`	`shipping:read`	Egy küldemény az összes követési eseménnyel.
`GET /shipping/shipments`	`shipping:read`	Egy webáruház küldeményei a szállítóval, az országgal, valamint az átadás és a kézbesítés idejével.
`GET /shipping/stats`	`shipping:read`	Kézbesítési statisztikák szállítónként: darabszámok, sikerességi arány, a kézbesítési idő mediánja és p90 értéke, országok.
`GET /stores/integration-status`	`stores:read`	A MitoOps-kód állapota a weben webáruházanként: telepítve, verzió, modulok, a címből érvényesített kupon készenléte.
`GET /stores`	`stores:read`	A fiók webáruházainak listája a kódjukkal együtt.
`GET /suppliers/:supplierId`	`purchasing:read`	Egy beszállító a termékajánlataival és költségösszetevőivel.
`GET /suppliers`	`purchasing:read`	A fiók beszállítói az ajánlatok és a párosított termékek számával.
`GET /webhooks/endpoints/:endpointId/deliveries`	`webhooks:read`	Egy végpont kézbesítési naplója törzs nélkül.
`GET /webhooks/endpoints/:endpointId`	`webhooks:read`	Egy webhook végpont a függő kézbesítések számával.
`GET /webhooks/endpoints`	`webhooks:read`	A fiók webhook végpontjai titkok nélkül, és a sor állapota.
`GET /webhooks/events`	`webhooks:read`	A kimenő webhookok eseménykatalógusa, a boríték és az aláírás.

Cím	Hatókör	Mit ad vissza
`GET /capabilities`	nincs	mit hívhat meg ez a kulcs
`GET /openapi.json`	nincs	az interfész gépileg olvasható leírása

A GET /capabilities a leggyorsabb módja annak, hogy megtudja, mit nyit meg egy kulcs: pontosan azt adja vissza, amit a hatókörei engedélyeznek, nem a teljes katalógust. Az egyes hívások pontos paraméterei és válaszmezői az openapi.json fájlban találhatók.

A válasz formája

Minden válasz két részből áll: data és meta.

{
  "data": [ { "market": "sk", "name": "Saját webáruház" } ],
  "meta": { "requestId": "…", "count": 1 }
}

A meta.requestId a hívás azonosítója. Ha valami elromlik, ebből az adatból tudja az ügyfélszolgálat, melyik hívásról van szó.

Listázásoknál a meta ezen felül a következőket tartalmazza:

Mező	Jelentés
`count`	hány rekord van ebben a válaszban
`hasMore`	`true`, ha létezik következő oldal
`nextCursor`	az az érték, amellyel a következő oldalt kérheti; `null`, ha nincs több oldal

Összesítéseknél (statisztikák, áttekintés, pénzügyi összesítő) a teljes válasz egyetlen objektumként a data mezőben található.

Lapozás

A következő oldalt úgy kérheti le, hogy a válaszban kapott nextCursor értéket visszaküldi a cursor paraméterben:

curl -H "Authorization: Bearer <az Ön kulcsa>" \
  "https://<az Ön címe>/api/v1/shipping/shipments?market=sk&from=2026-08-01&to=2026-08-31&limit=50&cursor=<nextCursor>"

Három dolog, amelyen ez alapul:

A többi paraméternek változatlannak kell maradnia. A kurzor ahhoz a lekérdezéshez tartozik, amelyből létrejött. Megváltozott webáruházzal, időszakkal vagy szűrővel az interfész elutasítja (400): egy már nem érvényes sorrend folytatása csendben összefüggéstelen részletet adna vissza.
A végét a hasMore alapján ismeri fel, nem a darabszám alapján. A válasz pontosan annyi rekordot tartalmazhat, amennyit kért, és ennek ellenére létezhet következő oldal.
Az érvénytelen kurzor hiba, nem üres eredmény. Az üres válasz az adatok végének tűnne, és az export csendben megrövidülne.

Kurzorral lapozhatók a rendelések, a bizonylatok, a katalógus és a küldemények. Oldalszámozás szándékosan nincs az interfészben: ha két hívás között új rekord kerül be, a „2. oldal” máshová mutat, mint egy pillanattal korábban; a kurzor az utoljára látott rekordot hordozza, így semmi nem ismétlődik és semmi nem marad ki.

Listázás és keresés

A termékeknél, számláknál és jóváíró számláknál ez egyetlen cím két üzemmódja:

Hogyan hívja	Mit kap
`query` nélkül	oldalankénti listázás a legújabbtól kezdve; lapozható és időszakra szűkíthető
`query` paraméterrel	egyezés szerint rendezett keresés; legfeljebb `limit` rekordot ad vissza

A keresés nem lapozható és nem szűkíthető időszakra: az egyezés szerinti sorrend hívásról hívásra változik, és a fölötte használt kurzor rekordokat ugrana át. A query kombinálása a cursor, from vagy to paraméterrel ezért 400 hibát eredményez, nem csendben figyelmen kívül hagyott szűrőt.

A teljes nyilvántartás kiolvasásához használja a query nélküli listázást.

Időszak

A rendelések, a bizonylatok, a küldemények, a statisztikák, az analitika és a kimutatások a from és a to paraméterrel szűkíthetők, YYYY-MM-DD formátumban.

Mindkét határ beleszámít. A to=2026-08-05 augusztus 5. teljes napját magában foglalja, nem csak a nap kezdetén lévő éjfélt.
A napot úgy vesszük, ahogyan az alkalmazás nyilvántartja: a rendeléseket a webáruház időzónájában, a küldeményeket és a kimutatásokat úgy, ahogyan a munkatársak a képernyőn látják őket.
A rendelések a rendelés létrehozásának dátuma, a küldemények a küldemény létrehozásának dátuma szerint sorolódnak be.
A számlák és jóváíró számlák a teljesítés dátuma szerint; ha ez a bizonylaton nincs kitöltve, a kiállítás dátuma szerint. Hogy melyik érték sorolta be a bizonylatot, az a businessDate mezőben látható.
Az értékesítés termékenként a bizonylat dátuma szerint; itt az időszak kötelező.
A leghosszabb időszak 366 nap. A hosszabbat a rendszer elutasítja; a hosszabb előzményeket évenként kérje le.
A fordított időszak hiba, nem üres eredmény: különben egy elírás olyan időszaknak tűnne, amelyben nincsenek bizonylatok.
Időszak nélkül a küldemények és a statisztikák az utolsó 30 napot, az analitika és a pénzügyi összesítő az aktuális hónapot adja vissza. A válasz mindig kiírja az időszakot.

A rendeléseknél megmarad a todayOnly is. A from/to paraméterrel nem kombinálható: ugyanarra a kérdésre adott két válaszról van szó, és az egyik csendben győzne.

Mit jelentenek a pénzügyi mezők

purchasePriceWithoutVat a rendelési tételnél a beszerzési ár a rendelés időpontjában, ahogyan a webáruház tárolta. Ez nem a mai termékkártyán szereplő ár: az a products/{code} alatt purchasePrice néven található.
cogs a pénzügyi összesítőben az időszak összes rendelésének áruköltsége; a null azt jelenti, hogy a beszerzési árak nem ismertek elég sorhoz (cogsCoverage). Ilyenkor a bruttó nyereség sem jelenik meg: inkább semmi, mint hibás szám.
grossProfit az áfa nélküli forgalom mínusz az áruk beszerzési költsége, grossMargin ugyanez százalékban. resultAfterCosts a bruttó nyereség mínusz a szállítás mínusz a vállalat költségei: vezetői mutató, nem számviteli nyereség.
A termékenkénti értékesítésben a purchaseCostWithoutVat a bizonylat időpontjában érvényes beszerzési ár a katalógussal való párosítás alapján; az unmappedLines megmondja, hány sort nem sikerült párosítani.
A kimutatások és az analitika minden összege EUR-ban van (currency mező), a szinkronizálás időpontjában érvényes árfolyamon átszámítva. A rendelések és a bizonylatok saját pénznemet hordoznak.

A purchase-prices:read hatókör nélkül ezek a mezők a válaszban nem szerepelnek: nem nullák, hanem hiányoznak.

Kézbesítési idő

A kézbesítési statisztikák (shipping/stats) az időt a szállítónak való átadástól a kézbesítés első eseményéig mérik a nyomkövetési események alapján. A rendelés dátumából semmit nem számolnak. Az a küldemény, amelynél nincs meg mindkét pont, nem számít bele a mediánba; hogy hány számított bele, azt a delivery.measured mondja meg. Ugyanezt a két időpontot minden küldemény a handedOverAt és a deliveredAt mezőben hordozza.

A deliveryRate a kézbesítettek aránya azok közül, amelyek sorsa már lezárult (kézbesítve, visszaküldve, hibás). Az úton lévő küldemény még sem nem siker, sem nem kudarc; a törölt küldemény az Ön művelete, nem a szállító hibája, és egyáltalán nem számít bele.

Készletszint

Az inventory/stock a quantity és a source értéket adja vissza, vagyis hogy melyik nyilvántartási modellből származik az érték (változatok, a webáruház egyenlege, termékkártya). Ha a webáruház egyenleget vezet, a physical, az available (eladható) és a reserved (rendelésekben lefoglalt) is elérhető; egyébként ezek értéke null. Az interfész nem talál ki olyan „raktári készletet”, amelyet az alkalmazás nem tart nyilván.

A készletszint (inventory/stock és inventory/availability, hatókör: inventory:read) azt mondja meg, mennyi áru van; az elérhetőségi lista (/availabilities, hatókör: products:read) azokat az elnevezett állapotokat tartalmazza, amelyeket a webáruház a termék mellett a vásárlónak mutat, például Készleten vagy Rendelésre.

Elérhetőségi lista

A GET /availabilities?market=sk a data mezőben egyetlen webáruház listájának tételeit adja vissza: id, name, description, onStockHours, deliveryHours, meaning (jelentés a Google Shopping számára: in_stock, backorder, preorder, out_of_stock), color, system, defaultRoles (alapértelmezett szerep a webáruházban) és pairingRows (hány elérhetőség-párosítási sorban szerepel a tétel). A meta a market, a manageable és a reason értéket hordozza: hogy a lista módosítható-e a MitoOps-ból, és ha nem, miért (PLATFORMA, BEZ_ROZSIRENIA, PROSTREDIE).

A lista REST-en keresztül nem módosítható. A módosítást csak az asszisztens tudja előkészíteni MCP-n keresztül, javaslatként, az érzékeny availabilities:draft hatókörrel; a webáruházba csak egy ember írja be az alkalmazásban történő jóváhagyással. Egy ilyen javaslat állapotát REST-en keresztül olvashatja: a GET /availabilities/drafts/:draftId visszaadja a status értéket (pending, writing, executed, partial, failed, rejected, expired), az előnézetet és jóváhagyás után a tételenkénti eredményt. Részletek az MCP interfész oldalon.

Ügyféladatbázis

Az ügyfelek adatai két különböző módon olvashatók, és ha összekeveri őket, más számot olvas, mint amire számít:

A /customers és a /customers/{customerKey} (hatókör: customers:read) az ügyféladatbázis: ugyanaz a nézet, amelyet a munkatársak az Ügyfelek képernyőn látnak, és amely az exportba kerül (identitás, webáruházak, ország, nyelv, darabszámok és dátumok).
A /customers/performance (hatókör: reports:read) analitika a nyers rendelések fölött: az ügyfél csak álnév, név és elérhetőség egyáltalán nem szerepel benne.

Kívülről a market mindkettőnél kötelező. Enélkül az olvasás a fiók összes webáruházára kiterjedne, azokra is, amelyekhez a hozzáférés nem tartozik.

Ki mit lát

A customers:read önmagában az álnevet (customerKey), a webáruházakat, az országot, a nyelvet, a rendelések számát, valamint az első és az utolsó rendelés dátumát adja ki. Ezen felül:

név, cég, e-mail-cím, telefonszám és marketing célú nem csak personal-data:read mellett,
forgalom, átlagos rendelésérték és LTV csak reports:read mellett.

Azok a mezők, amelyekhez nincs hatóköre, eltávolításra kerülnek, nem nullázódnak. Az e-mail helyén álló null azt jelentené, hogy „az ügyfélnek nincs e-mail-címe”, ami nem igaz; a hiányzó kulcs azt jelenti, hogy „Önnek nincs rá jogosultsága”.

A customerKey a normalizált e-mail-cím SHA-256 lenyomata. Ugyanaz az álnév, amelyet a bizonylatok (customerEmailHash) és a /customers/performance is hordoz, így ez a három nézet összekapcsolható anélkül, hogy bárhová e-mail-címet kellene küldeni.

Teljes élettartam vagy időszak

Az ügyféladatbázisnak van egy opcionális purchaseFrom és purchaseTo szűrője (YYYY-MM-DD, mindkét határ beleszámít). Ez vásárlási aktivitást jelent az időszakban: az ügyfélnek abban az intervallumban legalább egy rendelése van. Ez nem az első vagy az utolsó vásárlás dátumára vonatkozó szűrő.

Időszak megadásakor a periodFrom, periodTo, periodOrdersCount és periodRevenueByCurrency mezők a teljes élettartamra vonatkozó mezők (ordersCount, revenue, lifetimeRevenue, firstOrderAt, lastOrderAt) mellé kerülnek, soha nem helyettük. A teljes élettartamra vonatkozó értékek az időszaktól nem változnak.

A pénzösszegek mindig pénznemenként szerepelnek

A forgalom, az átlagos rendelésérték és az LTV pénznemenkénti tömb, soha nem egyetlen szám. Az EUR-ban és CZK-ban is rendelő ügyfélnek két tétele van; ezek egyetlen skalárrá összeadása koronát adna össze euróval. Ugyanez érvényes a /customers/performance végpontra: egy sor egy (ügyfél, pénznem) pár, a szűrő összesítései pedig a totals.revenueByCurrency mezőben vannak.

Nyelv és marketing célú nem

A language annak a webáruháznak a nyelve, amelyben az ügyfél rendelt (source: "store_locale"), nem az ügyfél saját választása. Az alkalmazás jelenleg nem tartja nyilván az ügyfél kifejezett nyelvi preferenciáját.
A marketingGender (male / female / unknown) a keresztnévből származó becslés, nem az ügyfél által megadott adat. Az eredet mindig a genderSource mezőben van (jelenleg kizárólag name_inference vagy unknown), a megbízhatóság pedig a genderConfidence mezőben. A céges ügyfélnek nincs ilyen mezője. Aki továbbadja vagy megjeleníti, annak azt kell mondania, hogy „név alapján becsült”, soha nem azt, hogy „az ügyfél megadta”. Ugyanúgy a personal-data:read mögött áll, mint maga a név.

Webáruház

Az egyetlen webáruház adataira vonatkozó hívások a webáruház kódját kérik a market paraméterben. A kódok listáját a GET /stores adja vissza.

Ha a kulcsnak nincs hatóköre az adott webáruházra, a válasz 403, nem üres lista. Az üres lista nem lenne megkülönböztethető egy rendelések nélküli webáruháztól. Másik webáruház rekordja (például egy küldemény) 404 választ ad.

Hibák

A hibaválasz mindig ugyanolyan formájú, és kódot tartalmaz. Az állapotok és kódok listája az Áttekintés oldalon található.

Példák

# Rendelések egy időszakra, oldalanként
curl -H "Authorization: Bearer <az Ön kulcsa>" \
  "https://<az Ön címe>/api/v1/orders?market=sk&from=2026-08-01&to=2026-08-31&limit=50"

# Kézbesítési statisztikák augusztusra
curl -H "Authorization: Bearer <az Ön kulcsa>" \
  "https://<az Ön címe>/api/v1/shipping/stats?market=sk&from=2026-08-01&to=2026-08-31"

# Egy szállító küldeményei augusztusban
curl -H "Authorization: Bearer <az Ön kulcsa>" \
  "https://<az Ön címe>/api/v1/shipping/shipments?market=sk&from=2026-08-01&to=2026-08-31&carrier=dhl"

# Augusztus pénzügyi összesítője (a beszerzési árakra vonatkozó jogosultsággal a bruttó nyereség is)
curl -H "Authorization: Bearer <az Ön kulcsa>" \
  "https://<az Ön címe>/api/v1/reports/financial-summary?market=sk&from=2026-08-01&to=2026-08-31"

# Három tétel készletszintje
curl -H "Authorization: Bearer <az Ön kulcsa>" \
  "https://<az Ön címe>/api/v1/inventory/availability?market=sk&codes=A100,A101,A102"

# A webáruház elérhetőségi listája
curl -H "Authorization: Bearer <az Ön kulcsa>" \
  "https://<az Ön címe>/api/v1/availabilities?market=sk"