Vmesnik REST
Preverjeno
Na kratko
Razdelek »Na kratko«Vmesnik REST je na /api/v1 in odgovarja samo na GET. Karkoli drugega prejme 405, še preden strežnik pogleda ključ.
Dostop se izkaže z glavo, glejte Pregled.
Klici
Razdelek »Klici«| Končna točka | Obseg | Kaj vrne |
|---|---|---|
GET /account/connection |
stores:read |
Diagnostika te povezave: aplikacija, kdo in kdaj je dovolil dostop, dodeljena in manjkajoča dovoljenja po področjih, trgovine in način zapisa prek AI. |
GET /account/entitlements |
account:read |
Paket naročnika, funkcije in omejitve s trenutno porabo. |
GET /affiliate/articles/:key |
affiliate:read |
En članek pomoči z besedilom (HTML) v vseh ali v enem jeziku; spremenljivke niso vstavljene. |
GET /affiliate/articles |
affiliate:read |
Članki pomoči partnerskega portala: ključ, privzeti/lastni, vklop, vrstni red, stanje po jezikih. |
GET /affiliate/campaigns/:campaignId |
affiliate:read |
Ena kampanja partnerskega programa. |
GET /affiliate/campaigns |
affiliate:read |
Kampanje partnerskega programa trgovine z nagrado, razpoložljivostjo in števili. |
GET /affiliate/code-requests |
affiliate:read |
Zahteve partnerjev za lastno kodo za popust s stanjem in razlogom; čakajoče najprej. |
GET /affiliate/conversions/:conversionId |
affiliate:read |
Podrobnosti ene konverzije: zneski, provizija, stanje provizije z razlogom, stanje naročila v trgovini, dobropis, izplačilo. |
GET /affiliate/conversions |
affiliate:read |
Konverzije partnerskega programa trgovine: osnova provizije in skupni znesek naročila z DDV, provizija, stanje provizije z razlogom, stanje naročila v trgovini, povezava na izplačilo. |
GET /affiliate/discount-codes |
affiliate:read |
Kode za popust partnerjev v trgovini s številom uporab in prometom. |
GET /affiliate/documents/:key/content |
affiliate:read |
En pravni dokument programa z besedilom po jezikih (shranjeno besedilo, javno besedilo, različica, zgoščene vrednosti, vir, metapodatki PDF) in odprtimi osnutki. |
GET /affiliate/documents |
affiliate:read |
Dokumenti programa (pogoji, sporazumi): pravila potrjevanja, podpisana kopija, priloga e-pošte, različice po jezikih, pripravljenost in števila potrditev. |
GET /affiliate/email-templates |
affiliate:read |
Predloge e-poštnih sporočil partnerjem po jezikih (zadeva, vklop, z dogodkom tudi besedilo) in samodejne priloge e-poštnega sporočila „Račun potrjen“. |
GET /affiliate/links/generate |
affiliate:read |
Sledena partnerska povezava na domačo stran, izdelek ali kategorijo trgovine kampanje; po kliku ohrani pripis partnerju. |
GET /affiliate/partners/:partnerId |
affiliate:read |
En partner programa s kampanjami, ki so mu na voljo. |
GET /affiliate/partners |
affiliate:read |
Partnerji programa s stanjem, uspešnostjo in provizijami; kontakti le z osebnimi podatki. |
GET /affiliate/payouts |
affiliate:read |
Izplačila provizij partnerjem s stanjem; brez bančnih in obračunskih podatkov. |
GET /affiliate/portal |
affiliate:read |
Javni partnerski portal: naslovi po trgovinah, odprtost registracije z razlogom, lastne domene, kontaktna oseba, videz in stanje besedil po jezikih. |
GET /affiliate/settings |
affiliate:read |
Nastavitve partnerskega programa: provizije, kliki, najnižje izplačilo, napotitve. |
GET /affiliate/signatures/:signatureId |
affiliate:read |
En elektronski podpis s podpisanim besedilom in posnetkom vrednosti; nespremenljiv zapis, PDF se ustvari v aplikaciji. |
GET /affiliate/signatures |
affiliate:read |
Elektronsko podpisani dokumenti partnerjev (kdo, dokument, različica, jezik, trgovina, čas, način, preverjanje, zgoščene vrednosti, stanje) in partnerji, ki jim podpis manjka; samo branje, podpis nastane izključno na portalu. |
GET /affiliate/statistics |
affiliate:read |
Statistika partnerskega programa: potek po dnevih, viri pripisa, lestvica partnerjev. |
GET /affiliate/summary |
affiliate:read |
Pregled partnerskega programa trgovine za obdobje: kliki, konverzije, provizije, partnerji. |
GET /affiliate/variables |
affiliate:read |
Register spremenljivk vsebine in e-pošte partnerskega programa: kanonična imena, vzdevki, tip, površine, primer; neobvezno preverjanje besedila glede neznanih spremenljivk. |
GET /analytics/advertising |
reports:read |
Oglaševanje: stroški, proračun, ROAS, PNO, CPA, povprečno naročilo in MER s primerjavo; Google Ads in Meta Ads, kliki iz GA4, 6 mesecev. |
GET /analytics/channels |
analytics:read |
Kanali obiska, vključno s ChatGPT in drugimi viri AI. |
GET /analytics/comparison |
reports:read |
Promet s primerjavo: promet, naročila, AOV, obiski, CR in AI/LLM glede na prejšnje obdobje ali leto. |
GET /analytics/monthly |
reports:read |
Promet, naročila in obiski po mesecih (največ 24), na primer leto na leto. |
GET /analytics/order-coverage |
analytics:read |
Pokritost naročil z merjenjem. |
GET /analytics/order-heatmap |
reports:read |
Kdaj prihajajo naročila: dan v tednu × ura, najmočnejši dan in ura. |
GET /analytics/overview |
analytics:read |
Obiski, naročila, promet, stopnja konverzije, AOV, delež virov AI. |
GET /analytics/revenue-sources |
reports:read |
Od kod je prišel promet: kanali, seštevki AI/LLM, MitoOps in Affiliate, pridobivanje po GA4. |
GET /analytics/seo |
analytics:read |
Search Console po poizvedbah ali straneh. |
GET /automations/catalog |
automations:read |
Katalog avtomatizacij: sprožilci, polja pogojev, operatorji, dejanja, predloge in catalogVersion. |
GET /automations/:workflowId |
automations:read |
Ena avtomatizacija z DSL in rezultatom preverjanja. |
GET /automations |
automations:read |
Avtomatizacije naročnika s stanjem in obsegom trgovin. |
GET /automations/options |
automations:read |
Šifrant za polje avtomatizacije (stanja, načini dostave, plačila, predloge, reklamacije…): vrednost za DSL in ime. |
GET /automations/:workflowId/runs |
automations:read |
Zgodovina zagonov ene avtomatizacije. |
GET /automations/templates |
automations:read |
Pripravljeni vzorci avtomatizacij z DSL. |
GET /chatbot/conversations/:sessionId |
chatbot-conversations:read |
Prepis enega pogovora s spletnim klepetalnikom, vključno z viri odgovorov bota. |
GET /chatbot/conversations |
chatbot-conversations:read |
Pogovori kupcev s spletnim klepetalnikom od nazadnje aktivnega, s prvim vprašanjem; kazalec. |
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 |
Statistika spletnega klepetalnika za obdobje: lijak oblačka iz enega samega merjenja (starejša števila so priložena kot zgodovinska), stopnja odpiranja klepeta, pogovori, izid na ravni pogovora, ocene. |
GET /chatbot/topics |
chatbot:read |
O čem so bili pogovori: deleži tem iz zaprte taksonomije, stopnja rešenosti in kandidati za vrzel v znanju po temi, najpogostejši izdelki, vrsta začetne strani in potek po dnevih. Deleži se izračunajo iz analiziranih pogovorov, vrne se tudi njihovo število. Le seštevki. |
GET /claims/config-drafts/:draftId |
claims-settings:read |
Stanje predloga spremembe nastavitev reklamacij (čaka, zapisan, zavrnjen). |
GET /claims/configuration |
claims-settings:read |
Nastavitve reklamacij: oznake, polja, vračilna dostava, obrazec v trgovini in vrste obrazca. |
GET /claims/:code |
claims:read |
Ena reklamacija s postavkami, vračili kupnine, povratnimi pošiljkami, oznakami, časovnico in poslanimi e-poštnimi sporočili. |
GET /claims |
claims:read |
Reklamacije in vračila ene trgovine s povezavami na naročilo. |
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 |
Vračila pri reklamacijah: način, bančni računi z ustreznostjo za plačilni nalog (zakriti), privzeti in ročni račun. |
GET /claims/routes |
claims-settings:read |
Povratni prevoz reklamacij: poti, naslovi, profili prevoznikov z ID-ji in podporo vračila, vrste primerov. |
GET /claims/settings |
claims:read |
Procesi reklamacij z ID-ji in imeni (vrste, koraki, stanja, roki), oznake; nastavitve modula z obsegom claims-settings:read. |
GET /claims/statistics |
claims:read |
Statistika reklamacij in vračil za obdobje: števila, časi rešitve, vrste, ocene, razlogi. |
GET /claims/templates |
claims-settings:read |
Predloge e-poštnih sporočil reklamacij (zadeva, besedilo, kdaj in ali se pošiljajo samodejno) in predloge zapisnikov. |
GET /content/articles |
products:read |
Članki bloga in vsebina trgovine iz kanoničnega zrcala po naslovu ali besedilu. |
GET /coupons/activation-link |
coupons:read |
Povezava, ki kupcu uveljavi OBSTOJEČI kupon v košarici. Kuponov ne ustvarja. |
GET /coupons/activation-status |
coupons:read |
Ali je kupon v trgovini mogoče uporabiti prek aktivacijske povezave: zrcalo kupona + stanje kode na spletu. |
GET /coupons/capabilities |
coupons:read |
Kaj platforma trgovine zmore s kuponi. Preberite pred ustvarjanjem. |
GET /coupons/:code |
coupons:read |
En kupon po kodi. |
GET /coupons |
coupons:read |
Kuponi za popust trgovine z vrsto in višino popusta, veljavnostjo in izpeljanim stanjem. |
GET /customers/:customerKey |
customers:read |
En kupec iz imenika: identiteta, trgovine, zneski za celotno obdobje sodelovanja in neobvezno za izbrano obdobje, razčlenjeno po trgovinah. |
GET /customers |
customers:read |
Imenik kupcev: identiteta (z maskiranjem osebnih podatkov), trgovine, jezik, števila in promet za celotno obdobje sodelovanja po valutah; neobvezen filter nakupne aktivnosti v obdobju. |
GET /customers/performance |
reports:read |
Kupci kot psevdonimi: naročila, promet, LTV, novi in ponovni. |
GET /credit-notes |
invoices:read |
Iskanje v dobropisih. |
GET /documents |
invoices:read |
Računovodske listine ene vrste (računi, predračuni, dobropisi) po straneh z življenjskim ciklom, stanjem v viru, filtrom veljavnosti in razpoložljivostjo PDF. |
GET /documents/:documentType/:code/pdf |
invoices:read |
PDF računa, avansnega računa ali dobropisa (base64 in SHA-256), isti bajti kot na zaslonu. |
GET /invoices/:invoiceCode |
invoices:read |
En račun s postavkami dokumenta, dobropisi, avansnimi računi in številko naročila. |
GET /invoices |
invoices:read |
Iskanje v računih. |
GET /inventory/movements |
inventory:read |
Zgodovina premikov zaloge: kdaj, kaj, koliko, vrsta, izvor, naročilo. |
GET /inventory/availability |
inventory:read |
Stanje zaloge več postavk hkrati. |
GET /inventory/stock |
inventory:read |
Stanje zaloge ene postavke, vključno z virom vrednosti. |
GET /orders/:orderCode |
orders:read |
Eno shranjeno naročilo, vključno s postavkami. |
GET /orders |
orders:read |
Shranjena naročila ene trgovine, od najnovejšega. |
GET /availabilities/drafts/:draftId |
products:read |
Stanje predloga spremembe šifranta razpoložljivosti: čaka na odobritev, zapisan z rezultatom, zavrnjen, potekel. |
GET /availabilities |
products:read |
Šifrant razpoložljivosti trgovine: ime, opis, čas do zaloge in čas dostave, pomen za Google, barva, privzeta vloga. |
GET /catalog/category-content-drafts/:draftId |
category-content:read |
Stanje predloga besedil kategorij: čaka na odobritev, zapisan, zavrnjen, potekel. |
GET /categories/:guid/content |
category-content:read |
Besedila kategorije (zgornji in spodnji opis, SEO naslov in opis) s prstnim odtisom in zapisljivostjo. |
GET /categories |
products:read |
Kategorije trgovine s številom izdelkov. |
GET /catalog/product-content-drafts/:draftId |
product-content:read |
Stanje predloga besedil izdelkov: čaka na odobritev, zapisan z opozorili spletne trgovine, zavrnjen, potekel. |
GET /products/:code/content |
product-content:read |
Besedila izdelka iz spletne trgovine (opis, kratek opis, SEO naslov in opis) s prstnim odtisom in zapisljivostjo. |
GET /product-content/policy |
product-content:read |
Pravila vsebine spletne trgovine brez klica spletne trgovine: kaj sme ta dostop brati in predlagati, katera polja platforma zapiše, način odobritve in samodejni zapis, omejitve in prstni odtisi. |
GET /products/:code |
products:read |
En izdelek po kodi, vključno z uvrstitvijo v kategorijo in ceno s kartice izdelka. |
GET /products |
products:read |
Iskanje izdelkov po imenu, kodi, EAN ali PLU. |
GET /reports/financial-summary |
reports:read |
Finančni povzetek obdobja; s purchase-prices:read tudi nabavna vrednost blaga, bruto dobiček in marža. |
GET /sales/order-performance |
reports:read |
Promet po naročilih s seštevki za celotno obdobje; s purchase-prices:read tudi nabavna vrednost, dobiček in marža. |
GET /sales/product-performance |
reports:read |
Prodaja po izdelkih s seštevki za celotno obdobje. |
GET /search-console/query |
search-console:read |
Search Console po dnevih, poizvedbah, straneh, državah in napravah, z ostranjevanjem in zgoščeno vrednostjo vsebine. |
GET /search-console/status |
search-console:read |
Stanje Search Console trgovine: povezava, lastnost, dovoljenje, sinhronizacija in obseg arhiva. |
GET /shipping/carriers |
shipping:read |
Povezani prevozniki in profili, brez dostopnih podatkov. |
GET /shipping/shipments/:shipmentId |
shipping:read |
Ena pošiljka z vsemi dogodki sledenja. |
GET /shipping/shipments |
shipping:read |
Pošiljke s prevoznikom, državo, časom predaje in dostave, po straneh. |
GET /shipping/stats |
shipping:read |
Statistika dostave po prevoznikih: števila, uspešnost, mediana in p90 časa dostave, države. |
GET /stores/integration-status |
stores:read |
Stanje kode MitoOps na spletu po trgovinah: nameščena, različica, moduli, pripravljenost kupona iz povezave. |
GET /stores |
stores:read |
Trgovine naročnika z njihovo kodo. |
GET /suppliers/:supplierId |
purchasing:read |
En dobavitelj s ponudbami in stroškovnimi komponentami. |
GET /suppliers |
purchasing:read |
Dobavitelji s ponudbami in stroškovnimi komponentami. |
GET /webhooks/endpoints/:endpointId/deliveries |
webhooks:read |
Dnevnik dostav enega endpointa brez teles sporočil. |
GET /webhooks/endpoints/:endpointId |
webhooks:read |
En webhook endpoint s številom čakajočih dostav. |
GET /webhooks/endpoints |
webhooks:read |
Webhook endpointi naročnika brez skrivnosti in stanje čakalne vrste. |
GET /webhooks/events |
webhooks:read |
Katalog dogodkov odhodnih webhookov, ovojnica in podpis. |
| Naslov | Obseg | Kaj vrne |
|---|---|---|
GET /capabilities |
- | kaj sme ta ključ klicati |
GET /openapi.json |
- | strojno berljiv opis vmesnika |
GET /capabilities je najhitrejši način, da ugotovite, kaj ključ odpira: vrne natanko to, kar so mu dovolili obsegi, ne celotnega kataloga. Natančni parametri in polja odgovora vsakega klica so v openapi.json.
Oblika odgovora
Razdelek »Oblika odgovora«Vsak odgovor ima dva dela: data in meta.
{ "data": [ { "market": "sk", "name": "Moja trgovina" } ], "meta": { "requestId": "…", "count": 1, "hasMore": false, "nextCursor": null }}meta.requestId je identifikator klica. Če gre kaj narobe, je to podatek, ki podpori pove, za kateri klic je šlo.
Straničenje
Razdelek »Straničenje«Naslednjo stran zahtevate tako, da nextCursor iz odgovora pošljete nazaj v parametru cursor. Vsi ostali parametri morajo ostati enaki: kazalec pripada poizvedbi, s katero je nastal, in s spremenjeno spletno trgovino ali obdobjem ga vmesnik zavrne (400). Konec prepoznate po hasMore, ne po številu vrnjenih zapisov. Neveljaven kazalec je napaka, ne prazen rezultat: prazen odgovor bi bil videti kot konec podatkov in izvoz bi se tiho skrajšal.
Oštevilčenja strani vmesnik namerno nima: ko med dvema klicema pribude zapis, „stran 2“ kaže drugam kot pred trenutkom.
Izpis in iskanje
Razdelek »Izpis in iskanje«Pri izdelkih, računih in dobropisih gre za dva načina enega naslova: brez query dobite izpis po straneh, od najnovejšega (s straničenjem in z možnostjo omejitve na obdobje); z query dobite iskanje, razvrščeno po ujemanju (največ limit zapisov). Iskanje se ne straniči in ne omejuje z obdobjem: kombinacija query s cursor, from ali to zato vrne 400, namesto da bi filter tiho prezrla. Za branje celotne evidence uporabite izpis brez query.
Obdobje
Razdelek »Obdobje«Naročila, dokumente, pošiljke, statistike, analitiko in poročila je mogoče omejiti s parametroma from in to v obliki YYYY-MM-DD.
- Obe meji sta vključeni.
to=2026-08-05zajema celoten 5. avgust, ne polnoči na njegovem začetku. - Dan se upošteva tako, kot ga vodi aplikacija: naročila v časovnem pasu spletne trgovine, pošiljke in poročila tako, kot jih osebje vidi na zaslonu.
- Naročila se razvrščajo po datumu nastanka naročila, pošiljke po datumu nastanka pošiljke.
- Računi in dobropisi po davčnem datumu; kadar ga dokument nima izpolnjenega, po datumu izdaje. To je enaka semantika, po kateri aplikacija dokumente razvršča v obdobja. Katera vrednost je dokument uvrstila, je vidno v polju
businessDate. - Prodaja po izdelkih po datumu dokumenta; tu je obdobje obvezno.
- Najdaljše obdobje je 366 dni. Daljše se zavrne; daljšo zgodovino preglejte po letih.
- Brez obdobja pošiljke in statistike vrnejo zadnjih 30 dni, analitika in finančni povzetek pa tekoči mesec. Odgovor obdobje vedno izpiše.
- Obrnjeno obdobje je napaka, ne prazen rezultat, sicer bi bila tipkarska napaka videti kot obdobje brez dokumentov.
Pri naročilih ostaja tudi todayOnly. S from/to ga ni mogoče združiti: gre za dva odgovora na isto vprašanje in eden od njiju bi tiho prevladal.
Kaj pomenijo finančna polja
Razdelek »Kaj pomenijo finančna polja«purchasePriceWithoutVatpri postavki naročila je nabavna cena v času naročila, kot jo je shranila spletna trgovina. To ni cena z današnje kartice izdelka; ta je vproducts/{code}kotpurchasePrice.cogsv finančnem povzetku je nabavna vrednost blaga za obdobje iz vseh naročil;nullpomeni, da nabavne cene niso znane za dovolj vrstic (cogsCoverage). Takrat se ne prikaže niti bruto dobiček: raje nič kot napačna številka.grossProfitje promet brez DDV minus nabavna vrednost blaga,grossMarginisto v odstotkih.resultAfterCostsje bruto dobiček minus dostava minus stroški podjetja: poslovodna številka, ne računovodski dobiček.- Pri prodaji po izdelkih je
purchaseCostWithoutVatnabavna cena v času dokumenta glede na povezavo s katalogom;unmappedLinespove, koliko vrstic se ni povezalo. - Vsi zneski poročil in analitike so v EUR (polje
currency), preračunani po tečaju v času sinhronizacije. Naročila in dokumenti nosijo lastno valuto.
Brez obsega purchase-prices:read teh polj v odgovoru ni: niso ničelna, manjkajo.
Čas dostave
Razdelek »Čas dostave«Statistika dostave (shipping/stats) meri čas od predaje prevozniku do prvega dogodka dostave med dogodki sledenja. Iz datuma naročila se ne računa nič. Pošiljka, ki nima obeh točk, se v mediano ne šteje; koliko se jih je štelo, pove delivery.measured. Isti dve točki nosi vsaka pošiljka v poljih handedOverAt in deliveredAt.
deliveryRate je delež dostavljenih pošiljk med tistimi, katerih usoda je že zaključena (dostavljene, vrnjene, neuspešne). Pošiljka na poti še ni niti uspeh niti neuspeh; preklicana pošiljka je vaše dejanje, ne napaka prevoznika, in se sploh ne šteje.
Stanje zalog
Razdelek »Stanje zalog«inventory/stock vrne quantity in source, torej iz katerega modela evidence vrednost izhaja (različice, bilanca spletne trgovine, kartica izdelka). Kadar spletna trgovina vodi bilanco, so na voljo tudi physical, available (na voljo za prodajo) in reserved (rezervirano v naročilih); sicer so null. Vmesnik si ne izmišljuje nobenega „stanja v skladišču“, ki ga aplikacija ne vodi.
Stanje zalog (inventory/stock in inventory/availability, obseg inventory:read) pove, koliko blaga je; šifrant razpoložljivosti (/availabilities, obseg products:read) pa vsebuje poimenovana stanja, ki jih spletna trgovina prikazuje kupcu pri izdelku, na primer Na zalogi ali Na naročilo.
Šifrant razpoložljivosti
Razdelek »Šifrant razpoložljivosti«GET /availabilities?market=sk v data vrne postavke šifranta ene spletne trgovine: id, name, description, onStockHours, deliveryHours, meaning (pomen za Google Nakupovanje: in_stock, backorder, preorder, out_of_stock), color, system, defaultRoles (privzeta vloga v spletni trgovini) in pairingRows (v koliko vrsticah povezovanja razpoložljivosti je postavka). meta nosi market, manageable in reason: ali je šifrant mogoče spreminjati v MitoOps in, če ne, zakaj (PLATFORMA, BEZ_ROZSIRENIA, PROSTREDIE).
Sprememba šifranta prek REST ni mogoča. Pripravi jo lahko samo pomočnik prek MCP, in sicer kot predlog z občutljivim obsegom availabilities:draft; v spletno trgovino ga zapiše šele oseba z odobritvijo v aplikaciji. Stanje takega predloga preberete prek REST: GET /availabilities/drafts/:draftId vrne status (pending, writing, executed, partial, failed, rejected, expired), predogled in po odobritvi rezultat po postavkah. Podrobnosti so v vmesniku MCP.
Imenik kupcev
Razdelek »Imenik kupcev«Kupci imajo dve različni branji in če ju zamenjate, preberete drugo številko, kot jo pričakujete:
/customersin/customers/{customerKey}(obsegcustomers:read) sta imenik: ista projekcija, kot jo osebje vidi na zaslonu Kupci in kot gre v izvoz (identiteta, spletne trgovine, država, jezik, števila in datumi)./customers/performance(obsegreports:read) je analitika nad surovimi naročili: kupec je samo psevdonim, imena ali kontakta v njej sploh ni.
Od zunaj je market pri obeh obvezen. Brez njega bi se bralo prek vseh spletnih trgovin naročnika, torej tudi prek tistih, ki jih ta dostop ne pokriva.
Kdo vidi kaj
Razdelek »Kdo vidi kaj«customers:read sam izda psevdonim (customerKey), spletne trgovine, državo, jezik, število naročil ter datuma prvega in zadnjega naročila. Poleg tega:
- ime, podjetje, e-pošta, telefon in marketinški spol samo s
personal-data:read, - promet, povprečno naročilo in LTV samo z
reports:read.
Polja, za katera nimate obsega, se odstranijo, ne nastavijo na nič. null na mestu e-pošte bi pomenil „kupec nima e-pošte“, kar ni res; manjkajoč ključ pomeni „nimate pravice do njega“.
customerKey je SHA-256 normaliziranega e-poštnega naslova. To je isti psevdonim, kot ga nosijo dokumenti (customerEmailHash) in /customers/performance, zato je te tri poglede mogoče povezati, ne da bi kamorkoli pošiljali e-poštni naslov.
Celotna življenjska doba ali obdobje
Razdelek »Celotna življenjska doba ali obdobje«Imenik ima neobvezni filter purchaseFrom in purchaseTo (YYYY-MM-DD, obe meji vključeni). Pomeni nakupno aktivnost v obdobju: kupec ima v tem intervalu vsaj eno naročilo. To ni filter po datumu prvega ali zadnjega nakupa.
Z obdobjem se pojavijo polja periodFrom, periodTo, periodOrdersCount in periodRevenueByCurrency poleg vrednosti za celotno življenjsko dobo (ordersCount, revenue, lifetimeRevenue, firstOrderAt, lastOrderAt), nikoli namesto njih. Vrednosti za celotno življenjsko dobo se z obdobjem ne spreminjajo.
Denar je vedno po valutah
Razdelek »Denar je vedno po valutah«Promet, povprečno naročilo in LTV so polje po valutah, nikoli ena številka. Kupec z naročili v EUR in v CZK ima dve postavki; seštevanje v en skalar bi pomenilo prištevanje kron k evrom. Enako velja za /customers/performance: vrstica je par (kupec, valuta), seštevki filtra pa so totals.revenueByCurrency.
Jezik in marketinški spol
Razdelek »Jezik in marketinški spol«languageje jezik spletne trgovine, v kateri je kupec naročil (source: "store_locale"), ne njegova lastna izbira. Aplikacija danes izrecne jezikovne nastavitve kupca ne vodi.marketingGender(male/female/unknown) je ocena iz osebnega imena, ne podatek, ki bi ga navedel kupec. Izvor je vedno vgenderSource(danes izključnoname_inferencealiunknown), zanesljivost pa vgenderConfidence. Kupec podjetje tega polja nima. Kdor ga prikazuje naprej, naj piše „ocena po imenu“, nikoli „kupec je navedel“. Je zapersonal-data:readenako kot samo ime.
Spletna trgovina
Razdelek »Spletna trgovina«Klici nad podatki ene spletne trgovine zahtevajo njeno kodo v parametru market. Seznam kod izda GET /stores.
Kadar ključ za dano spletno trgovino nima obsega, je odgovor 403, ne prazen seznam. Praznega seznama ne bi bilo mogoče ločiti od spletne trgovine brez naročil. Zapis druge spletne trgovine (na primer pošiljka) vrne 404.
Napake
Razdelek »Napake«Odgovor ob napaki ima vedno enako obliko in nosi kodo. Seznam stanj in kod je v Pregledu.
Primeri
Razdelek »Primeri«# Naročila za obdobje, po stranehcurl -H "Authorization: Bearer <vaš ključ>" \ "https://<vaš naslov>/api/v1/orders?market=sk&from=2026-08-01&to=2026-08-31&limit=50"
# Statistika dostave za avgustcurl -H "Authorization: Bearer <vaš ključ>" \ "https://<vaš naslov>/api/v1/shipping/stats?market=sk&from=2026-08-01&to=2026-08-31"
# Finančni povzetek za avgust (s pravico do nabavnih cen tudi bruto dobiček)curl -H "Authorization: Bearer <vaš ključ>" \ "https://<vaš naslov>/api/v1/reports/financial-summary?market=sk&from=2026-08-01&to=2026-08-31"
# Stanje zaloge treh postavkcurl -H "Authorization: Bearer <vaš ključ>" \ "https://<vaš naslov>/api/v1/inventory/availability?market=sk&codes=A100,A101,A102"
# Šifrant razpoložljivosti spletne trgovinecurl -H "Authorization: Bearer <vaš ključ>" \ "https://<vaš naslov>/api/v1/availabilities?market=sk"