Dodatečná data o nákupu

Tučně uvedené parametry jsou pro volání povinné.

Upozornění: u všech parametrů typu String je prováděna následující validace: hodnota nesmí začínat nebo končit whitespace znakem (mezerou, tabulátorem, koncem řádku). Pokud jej obsahuje, vrací se v odpovědi

HTTP/1.1 400 Bad request
Content-Type: application/json

{
  "resultCode": 100,
  "resultMessage": "Invalid format of email, begins/ends with whitespace"
}

---

customer data  

Dodatečná data o nákupu týkající se zákazníka.

Položka	Typ	Popis
name	String	Jméno zákazníka, max. délka 45 znaků.
email	String	e-mail zákazníka, max. délka 100 znaků.
homePhone	String	Telefonní číslo zákazníka (pevná linka). Zadávejte telefonní číslo ve tvaru "prefix.subscriber", oddělené znakem "." (tečka), např. "+420.800300300". Prefix obsahuje předčíslí (mezinárodní předvolbu, může začínat znakem "+" nebo znaky "00", povolené hodnoty jsou např. jak "420", tak "+420" i "00420"), subscriber obsahuje tel. číslo bez předčíslí, může obsahovat mezery.
workPhone	String	Telefonní číslo zákazníka ("pracovní" telefon). Formát je shodný jako u položky homePhone.
mobilePhone	String	Telefonní číslo zákazníka (mobilní telefon). Formát je shodný jako u položky homePhone.
account	Object	Údaje o zákaznickém účtu v e-shopu obchodníka. Viz níže struktura customer.account.
login	Object	Údaje o přihlášení do zákaznického účtu v e-shopu obchodníka. Viz níže struktura customer.login.

---

customer.account data  

Údaje o zákaznickém účtu v e-shopu obchodníka.

Položka	Typ	Popis
createdAt	String	Datum otevření zákaznického účtu uživatele v e-shopu. Je akceptován formát ISO8061.
changedAt	String	Datum poslední změny zákaznického účtu v e-shopu, včetně typu změna fakturační nebo doručovací adresy. Je akceptován formát ISO8061.
changedPwdAt	String	Datum poslední změny (nebo resetu) hesla uživatele k zákaznickému účtu v e-shopu. Je akceptován formát ISO8061.
orderHistory	Number	Počet použití OneClick šablony při nákupech na tomto zákaznickém účtu za posledních 180 dní. Minimální povolená hodnota: 0, maximální: 9999.
paymentsDay	Number	Počet nákupů (jak úspěšných, tak neúspěšných) na zákaznickém účtu za posledních 24 hodin bez ohledu na platební metodu. Minimální povolená hodnota: 0, maximální: 999.
paymentsYear	Number	Počet nákupů (jak úspěšných, tak neúspěšných) na zákaznickém účtu za posledních 365 dní bez ohledu na platební metodu. Minimální povolená hodnota: 0, maximální: 999.
oneclickAdds	Number	Počet pokusů o založení OneClick šablony na zákaznickém účtu za posledních 24 hodin. Minimální povolená hodnota: 0, maximální: 999.
suspicious	Boolean	Indikace podezřelé aktivity uživatele nebo zákaznického účtu v e-shopu za celou historii zákaznického účtu, včetně předchozích (úspěšných, či zastavených) pokusů o fraud. false = žádná podezřelá aktivita true = podezřelá aktivita v e-shopu

---

customer.login data  

Údaje o přihlášení do zákaznického účtu v e-shopu obchodníka.

Položka	Typ	Popis
auth	String	Způsob přihlášení k zákaznickému účtu e-shopu při tomto nákupu: guest - bez přihlášení ("nákup jako host") account - přihlášení jménem a heslem do e-shopu federated - přihlášení pomocí federalizovaného ID (tj. údaji ne přímo od e-shopu, ale od identity providera) issuer - přihlášení pomocí údajů vydavatele karty thirdparty - přihlášení pomocí autentizačních nástrojů třetí strany fido - přihlášení pomocí FIDO autentikátoru fido_signed - přihlášení pomocí FIDO autentikátoru (včetně podepsaných dat) api - SRC (Secure Remote Commerce) Assurance Data.
authAt	String	Datum a čas přihlášení zákazníka. Je akceptován formát ISO8061.
authData	String	Doplňkové údaje o přihlášení. Obchodník může vydavateli poskytnout doplňková data (definovaná přihlašovací metodou) v případě, že k přihlášení (viz parametr auth výše) byl použit jeden ze způsobů federated, fido, fido_signed anebo api.

---

Příklad vyplněných customer dat:

{
  "name":"Jan Novák",
  "email":"jan.novak@example.com",
  "mobilePhone":"+420.800300300",
  "account": {
    "createdAt":"2022-01-12T12:10:37+01:00",
    "changedAt":"2022-01-15T15:10:12+01:00"
  },
  "login": {
    "auth":"account",
    "authAt":"2022-01-25T13:10:03+01:00"
  }
}

---

order data  

Dodatečná data o nákupu týkající se objednávky.

Položka	Typ	Popis
type	String	Typ platby, kterou zákazník v e-shopu provádí: purchase - nákup zboží a služeb balance - nabití předplaceného účtu prepaid - aktivace předplacené karty; úvěr cash - tzv. quasi-cash transakce, například směnárenské operace, transakce s cestovními šeky check - proplácení šeků.
availability	String	Indikátor dostupnosti zboží: now - zboží dostupné k okamžitému zaslání preorder - zboží s budoucí dostupností nebo je možné vyplnit předpokládané datum dostupnosti předobjednaného zboží ve formátu ISO8061, např. "YYYY-MM-DD".
delivery	String	Indikátor způsobu doručení. Pokud objednávka obsahuje jak fyzické, tak elektronické zboží, použijte hodnotu nejlépe popisující způsob doručení fyzického zboží. Pokud objednávka obsahuje pouze elektronické zboží, použijte hodnotu nejlépe popisující způsob doručení nejdražší položky. Povolené hodnoty: shipping - pokud je addressMatch nastaveno na true, bude zboží doručeno na fakturační adresu zákazníka, pokud je false, bude expedováno na doručovací adresu (která je v tomto případě odlišná od fakturační adresy) shipping_verified - pokud je addressMatch nastaveno na true, bude zboží doručeno na fakturační adresu zákazníka, pokud je false, bude expedováno na jinou ověřenou adresu evidovanou obchodníkem instore - vyzvednutí na obchodním místě (adresa obchodního místa musí být vyplněna v doručovací adrese) digital - elektronické zboží (obsahuje online služby, elektronické dárkové karty) ticket - jízdenky, letenky a vstupenky dodané elektronicky other - ostatní (např. hry, nedoručované digitální služby, elektronické předplatné novin a časopisů atd.)
deliveryMode	String	Rychlost doručení: 0 - elektronické doručení 1 - doručení v ten samý den 2 - doručení následující den 3 - doručení za dva dny nebo později
deliveryEmail	String	e-mailová adresa, na kterou obchodník doručí elektronické zboží (kódy dárkových karet apod.), max. délka 100 znaků.
nameMatch	Boolean	Je jméno zákazníka (viz parametr customer.name) stejné i pro doručovací adresu? true = ano, jméno je stejné false = jméno je různé.
addressMatch	Boolean	Je doručovací a fakturační adresa zákazníka stejná? true = ano, adresy jsou stejné false = adresy nejsou stejné. Pokud budou obě adresy naprosto shodné, platební brána nastaví tento indikátor na true i v případě, že nebude přes API obchodníkem poslán.
billing	Object	Fakturační adresa zákazníka. Viz níže struktura order.address.
shipping	Object	Doručovací adresa zákazníka. Viz níže struktura order.address.
shippingAddedAt	String	Datum přidání doručovací adresy. Je akceptován formát ISO8061.
reorder	Boolean	Indikátor zda tento zákazník opakuje nákup zboží / služby: false - ne, první nákup, true - ano, opakovaný nákup stejného zboží.
giftcards	Object	Podrobnější údaje o dárkových nebo předplacených kartách obsažených v nákupu. Viz dále popisovaná struktura order.giftcards.

---

order.address data  

Adresa objednávky.

Položka	Typ	Popis
address1	String	První řádek adresy, typicky ulice a číslo popisné + orientační, max. délka 50 znaků.
address2	String	Druhý řádek adresy, max. délka 50 znaků.
address3	String	Třetí řádek adresy, max. délka 50 znaků.
city	String	Město, max. délka 50 znaků.
zip	String	Poštovní směrovací číslo, max. délka 16 znaků.
state	String	Stát (územní celek) dané země dle ISO 3166-2.
country	String	Země. Hodnota kódu země dle ISO 3166-1 alpha-3, např. CZE.

---

order.giftcards data  

Údaje o dárkových nebo předplacených kartách, které jsou obsaženy v nákupu.

Položka	Typ	Popis
totalAmount	Number	Celková suma hodnot dárkových, nebo předplacených karet v setinách základní měny, které jsou obsaženy v nákupu v dané měně.
currency	String	Měna vztahující se k order.giftcards.totalAmount. Povolené hodnoty: CZK, EUR, USD, GBP, HUF, PLN, RON, NOK, SEK.
quantity	Number	Celkový počet dárkových karet v nákupu. Nastavte hodnotu v rozmezí 1 až 99.

---

Příklad vyplněných order dat:

{
  "type":"purchase",
  "availability":"now",
  "delivery":"shipping",
  "deliveryMode": "1",
  "addressMatch":true,
  "billing": {
    "address1":"Karlova 1",
    "city":"Praha",
    "zip":"11000",
    "country":"CZE",
  }
}

Příklad vyplněných order dat:

{
  "type":"purchase",
  "availability":"now",
  "delivery":"digital",
  "deliveryMode": "0",
  "deliveryEmail": "delivery@example.com"
}