Schemas

OrderStatusType

string · enum

Enum values:

Received

Canceled

Sent

PaymentSuccessful

PaymentFailed

PaymentCanceled

PaymentInProcess

Unresolved

typ stavu objednávky:

Received - přijatá
Canceled - stornovaná
Sent - odeslaná
PaymentSuccessful - platba úspěšná
PaymentFailed - platba selhala
PaymentCanceled - platba zrušena
PaymentInProcess - platba probíhá
Unresolved - nedořešená
Custom - vlastní
HomecreditProcessing - Homecredit - Probíhá
HomecreditRejected - Homecredit - Zamítnuto
HomecreditApproved - Homecredit - Schváleno
HomecreditReadyToShip - Homecredit - Připraveno k odeslání
HomecreditSent - Homecredit - Odesláno
HomecreditDelivered - Homecredit - Doručeno
HomecreditPaid - Homecredit - Zaplaceno
HomecreditCanceled - Homecredit - Zrušeno

LabelType

string · enum

Enum values:

action

new

sale

custom

typ štítku:

action - systémový štítek akce
new - systémový štítek novinka
sale - systémový štítek výprodej
custom - vlastní štítek

AvailabilityType

string · enum

Enum values:

OnRequest

NotAvailable

InStock

Custom

typ dostupnosti:

OnRequest - na dotaz
NotAvailable - není skladem
InStock - skladem
Custom - vlastní

ShipmentType

string · enum

Enum values:

ceskaPosta

balikovna

slovenskaPosta

sps

zasilkovna

dpd

ppl

gls

typ dopravy:

ceskaPosta - Česká pošta
balikovna - Balíkovna
slovenskaPosta - Slovenská pošta
sps - SPS
ulozenka - Uloženka
zasilkovna - Zásilkovna
dpd - DPD
ppl - PPL
gls - GLS
wedo - WEDO
custom - Vlastní doprava
individual - Individuální

ConversionCodePosition

string · enum

Enum values:

head

body_top

body_bottom

order_head

order_body_top

order_body_bottom

pozice konverzního kódu

head - kód je umístěn mezi tagy <head> a </head> na každé stránce
body_top - kód je umístěn na začátku tagu <body> na každé stránce
body_bottom - kód je umístěn před tagem </body> na každé stránce
order_head - kód je umístěn mezi tagy <head> a </head> na stránce po dokončení objednávky
order_body_top - kód je umístěn na začátku tagu <body> na stránce po dokončení objednávky
order_body_bottom - kód je umístěn před tagem </body> na stránce po dokončení objednávky

CategoryType

string · enum

Enum values:

homepage

news

individual

url

site

siteWithProducts

parametric

linkCategory

typ kategorie:

homepage - odkaz na homepage
news - odkaz na novinky
url - odkaz na URL
site - stránka
siteWithProducts - stránka s produkty
parametric - parametrická stránka
linkCategory - odkaz na jinou kategorii
advisor - odkaz na rádce
why-us - odkaz na výhody
contact - kontakt
manufacturers - seznam výrobců
contactMenu - kontakt menu

CategoryTypeOfItems

string · enum

Enum values:

withSubcategories

withoutSubcategories

label

manufacturer

typ položek v kategorii:

withSubcategories - produkty s podkategoriemi
withoutSubcategories - produkty bez podkategorií
label - produkty s konkrétním štítkem
manufacturer - produkty s konkrétním výrobcem

PaymentType

string · enum

Enum values:

cash

cashOnDelivery

command

moneybookers

paypal

stripe

payu

homecredit

typ platby:

cash - hotově
cashOnDelivery - dobírka
command - převodem
moneybookers - skrill
paypal - PayPal
stripe - Stripe
payu - PayU
homecredit - Homecredit
computop - Computop
upgates - Upgates Pay
tatrapay - TatraPay
tatrapayplus - TatraPay+
tatracardpay - Tatra CardPay
comgate - ComGate
gopay - GoPay
fio - Fio
gpwebpay - GP webpay
cofidis - Cofidis
essox - Essox
twisto - Twisto
cashOnCashRegister - hotově na pokladně
cardOnCashRegister - kartou na pokladně
thepay - ThePay
custom - vlastní

Images

object[]

pole objektů s obrázky

file_id

integer

ID souboru
Při GET, nebo PUT se hledá soubor s konkrétním ID, musí být typu image nebo video

url

string · uri

URL obrázku
Při GET, nebo PUT se obrázky nestahují hned, ale jsou staženy na pozadí

main_yn

boolean

příznak pro hlavní obrázek. Pokud není definováno nebo je u všech obrázků FALSE, vezme se jako hlavní obrázek první

list_yn

boolean

příznak pro seznamový obrázek. Pokud není definováno nebo je u všech obrázků FALSE, vezme se jako seznamový obrázek první

position

integer

pozice

object[]

titulky

object[]

jazykové mutace na kterých se obrázek zobrazí, hlavní a seznamový obrázek se zobrazí ve všech jazykových mutacích

Files

object[]

pole objektů se soubory

file_id

integer

ID souboru, Při GET, nebo PUT se hledá soubor s konkrétním ID

url

string · uri

URL souboru
Soubory se nestahují hned, ale jsou staženy na pozadí

position

integer

pozice

object[]

titulky

object[]

jazykové mutace na kterých se soubor zobrazí

ProductLabels

object[]

label_id

integer

object

objekt s názvy štítků v jednotlivých jazycích (klíč každé položky v objektu je jazyk)

active_currently_yn

boolean

štítek aktuálně aktivní, zohledňuje i data od a do

active_yn

boolean

štítek aktivní

active_from

Date · date

štítek aktivní od data

active_to

Date · date

štítek aktivní do data

ProductParametersGet

object[]

object

objekt s názvy parametrů v jednotlivých jazycích (klíč každé položky v objektu je jazyk)

object[]

ProductParametersNewGet

object[]

id

integer

object[]

ProductParameters

object[]

parametry

id

integer

ID parametru

object[]

název parametru

object[]

hodnoty

ProductPrices

object[]

pole objektů s cenami

language

Language · required

kód jazyka dle ISO 639-1

object[]

pole objektů s ceníky

price_purchase

number · float

nákupní cena, interní údaj pro orientaci administrátora

price_common

number · float

běžná cena, pro orientaci při nákupu. Může to být např. cena v kamenných obchodech

ProductPricesGet

object[]

pole objektů s cenami

language

Language · required

kód jazyka dle ISO 639-1

object[]

pole objektů s ceníky

price_purchase

number · float

nákupní cena, interní údaj pro orientaci administrátora

price_common

number · float

běžná cena, pro orientaci při nákupu. Může to být např. cena v kamenných obchodech

vat

number

DPH použité k výpočtu cen v aktuálním objektu price

recycling_fee

number | null

recyklační poplatek

ProductStocks

object[]

pokud má eshop zapnutý doplněk Více skladů a nějaké sklady vytvořené.

stock_id

integer · required

ID skladu, párovací prvek. Pokud jej neznáte můžete použít code

code

string

kód skladu. Může sloužit jako párovací prvek, pokud neznáte stock_id

position

string

pozice na skladě

quantity

number · float

počet jednotek na skladě

Pagination

current_page

integer · min: 1

aktuální strana

current_page_items

integer

počet položek na aktuální straně

number_of_items

integer

celkový počet položek

number_of_pages

integer

celkový počet stran

MetaCategory

string · enum

Enum values:

advices

articles

MetaType

string · enum

Enum values:

checkbox

radiolist

input

date

number

textarea

formatted

typ vlastního pole:

checkbox - Zatržítko
radiolist - Přepínač
input - Textové pole
date - Textové pole - datum
email - Textové pole - emailová adresa
number - Textové pole - číslo
textarea - Víceřádkové textové pole
formatted - Víceřádkové textové pole, formátované
select - Rolovací nabídka
multiselect - Multi rolovací nabídka

MetaKey

string · pattern: ^[a-z_][a-z0-9_]*$

klíč vlastního pole

Metas

array

vlastní pole

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: key, value
	type = object · requires: key, values

Properties for Variant 1:

vlastní pole s hodnotami společnými pro všechny jazyky

key

MetaKey · pattern: ^[a-z_][a-z0-9_]*$ · required

klíč vlastního pole

value

string · required

hodnota společná pro všechny jazyky

MetasGet

array

vlastní pole

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: key, type, value
	type = object · requires: key, type, values

Properties for Variant 1:

vlastní pole s hodnotami společnými pro všechny jazyky

key

MetaKey · pattern: ^[a-z_][a-z0-9_]*$ · required

klíč vlastního pole

type

MetaType · enum · required

typ vlastního pole:

checkbox - Zatržítko
radiolist - Přepínač
input - Textové pole
date - Textové pole - datum
email - Textové pole - emailová adresa
number - Textové pole - číslo
textarea - Víceřádkové textové pole
formatted - Víceřádkové textové pole, formátované
select - Rolovací nabídka
multiselect - Multi rolovací nabídka

Enum values:

checkbox

radiolist

input

date

number

textarea

formatted

value

string · required

hodnota společná pro všechny jazyky

Currency

string

kód měny dle ISO 4217

Country

string

kód země dle ISO 3166-1 alpha-2

Language

string

kód jazyka dle ISO 639-1

Date

string · date

datum zapsané jako řeťezec znaků dle ISO 8601

DateTime

string · date-time

datum a čas zapsaný jako řeťezec znaků dle ISO 8601

QueryParameterArrayInt

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = string
	type = array

Properties for Variant 1:

string

hodnoty oddělené středníkem ;
například 1;2;3

QueryParameterArrayString

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = string
	type = array

Properties for Variant 1:

string

hodnoty oddělené středníkem ;
například A;B;C

QueryParameterPage

ErrorMessages

object[]

chybové zprávy

object

string

název objektu (část JSONu), kterého se zpráva týká

property

string

hodnota, které se zpráva týká

message

string

text zprávy

level

string · enum

úroveň chyby:

info - informační sdělení
warning - varování
error - chyba, pravděpodobně nedošlo ke zpracování
fatal_error - chyba API, kontaktujte technickou podporu

Enum values:

info

warning

error

fatal_error

API

Schemas

OrderStatusType

string · enum

Enum values:

Received

Canceled

Sent

PaymentSuccessful

PaymentFailed

PaymentCanceled

PaymentInProcess

Unresolved

typ stavu objednávky:

Received - přijatá
Canceled - stornovaná
Sent - odeslaná
PaymentSuccessful - platba úspěšná
PaymentFailed - platba selhala
PaymentCanceled - platba zrušena
PaymentInProcess - platba probíhá
Unresolved - nedořešená
Custom - vlastní
HomecreditProcessing - Homecredit - Probíhá
HomecreditRejected - Homecredit - Zamítnuto
HomecreditApproved - Homecredit - Schváleno
HomecreditReadyToShip - Homecredit - Připraveno k odeslání
HomecreditSent - Homecredit - Odesláno
HomecreditDelivered - Homecredit - Doručeno
HomecreditPaid - Homecredit - Zaplaceno
HomecreditCanceled - Homecredit - Zrušeno

LabelType

string · enum

Enum values:

action

new

sale

custom

typ štítku:

action - systémový štítek akce
new - systémový štítek novinka
sale - systémový štítek výprodej
custom - vlastní štítek

AvailabilityType

string · enum

Enum values:

OnRequest

NotAvailable

InStock

Custom

typ dostupnosti:

OnRequest - na dotaz
NotAvailable - není skladem
InStock - skladem
Custom - vlastní

ShipmentType

string · enum

Enum values:

ceskaPosta

balikovna

slovenskaPosta

sps

zasilkovna

dpd

ppl

gls

typ dopravy:

ceskaPosta - Česká pošta
balikovna - Balíkovna
slovenskaPosta - Slovenská pošta
sps - SPS
ulozenka - Uloženka
zasilkovna - Zásilkovna
dpd - DPD
ppl - PPL
gls - GLS
wedo - WEDO
custom - Vlastní doprava
individual - Individuální

ConversionCodePosition

string · enum

Enum values:

head

body_top

body_bottom

order_head

order_body_top

order_body_bottom

pozice konverzního kódu

head - kód je umístěn mezi tagy <head> a </head> na každé stránce
body_top - kód je umístěn na začátku tagu <body> na každé stránce
body_bottom - kód je umístěn před tagem </body> na každé stránce
order_head - kód je umístěn mezi tagy <head> a </head> na stránce po dokončení objednávky
order_body_top - kód je umístěn na začátku tagu <body> na stránce po dokončení objednávky
order_body_bottom - kód je umístěn před tagem </body> na stránce po dokončení objednávky

CategoryType

string · enum

Enum values:

homepage

news

individual

url

site

siteWithProducts

parametric

linkCategory

typ kategorie:

homepage - odkaz na homepage
news - odkaz na novinky
url - odkaz na URL
site - stránka
siteWithProducts - stránka s produkty
parametric - parametrická stránka
linkCategory - odkaz na jinou kategorii
advisor - odkaz na rádce
why-us - odkaz na výhody
contact - kontakt
manufacturers - seznam výrobců
contactMenu - kontakt menu

CategoryTypeOfItems

string · enum

Enum values:

withSubcategories

withoutSubcategories

label

manufacturer

typ položek v kategorii:

withSubcategories - produkty s podkategoriemi
withoutSubcategories - produkty bez podkategorií
label - produkty s konkrétním štítkem
manufacturer - produkty s konkrétním výrobcem

PaymentType

string · enum

Enum values:

cash

cashOnDelivery

command

moneybookers

paypal

stripe

payu

homecredit

typ platby:

cash - hotově
cashOnDelivery - dobírka
command - převodem
moneybookers - skrill
paypal - PayPal
stripe - Stripe
payu - PayU
homecredit - Homecredit
computop - Computop
upgates - Upgates Pay
tatrapay - TatraPay
tatrapayplus - TatraPay+
tatracardpay - Tatra CardPay
comgate - ComGate
gopay - GoPay
fio - Fio
gpwebpay - GP webpay
cofidis - Cofidis
essox - Essox
twisto - Twisto
cashOnCashRegister - hotově na pokladně
cardOnCashRegister - kartou na pokladně
thepay - ThePay
custom - vlastní

Images

object[]

pole objektů s obrázky

file_id

integer

ID souboru
Při GET, nebo PUT se hledá soubor s konkrétním ID, musí být typu image nebo video

url

string · uri

URL obrázku
Při GET, nebo PUT se obrázky nestahují hned, ale jsou staženy na pozadí

main_yn

boolean

příznak pro hlavní obrázek. Pokud není definováno nebo je u všech obrázků FALSE, vezme se jako hlavní obrázek první

list_yn

boolean

příznak pro seznamový obrázek. Pokud není definováno nebo je u všech obrázků FALSE, vezme se jako seznamový obrázek první

position

integer

pozice

object[]

titulky

object[]

jazykové mutace na kterých se obrázek zobrazí, hlavní a seznamový obrázek se zobrazí ve všech jazykových mutacích

Files

object[]

pole objektů se soubory

file_id

integer

ID souboru, Při GET, nebo PUT se hledá soubor s konkrétním ID

url

string · uri

URL souboru
Soubory se nestahují hned, ale jsou staženy na pozadí

position

integer

pozice

object[]

titulky

object[]

jazykové mutace na kterých se soubor zobrazí

ProductLabels

object[]

label_id

integer

object

objekt s názvy štítků v jednotlivých jazycích (klíč každé položky v objektu je jazyk)

active_currently_yn

boolean

štítek aktuálně aktivní, zohledňuje i data od a do

active_yn

boolean

štítek aktivní

active_from

Date · date

štítek aktivní od data

active_to

Date · date

štítek aktivní do data

ProductParametersGet

object[]

object

objekt s názvy parametrů v jednotlivých jazycích (klíč každé položky v objektu je jazyk)

object[]

ProductParametersNewGet

object[]

id

integer

object[]

ProductParameters

object[]

parametry

id

integer

ID parametru

object[]

název parametru

object[]

hodnoty

ProductPrices

object[]

pole objektů s cenami

language

Language · required

kód jazyka dle ISO 639-1

object[]

pole objektů s ceníky

price_purchase

number · float

nákupní cena, interní údaj pro orientaci administrátora

price_common

number · float

běžná cena, pro orientaci při nákupu. Může to být např. cena v kamenných obchodech

ProductPricesGet

object[]

pole objektů s cenami

language

Language · required

kód jazyka dle ISO 639-1

object[]

pole objektů s ceníky

price_purchase

number · float

nákupní cena, interní údaj pro orientaci administrátora

price_common

number · float

běžná cena, pro orientaci při nákupu. Může to být např. cena v kamenných obchodech

vat

number

DPH použité k výpočtu cen v aktuálním objektu price

recycling_fee

number | null

recyklační poplatek

ProductStocks

object[]

pokud má eshop zapnutý doplněk Více skladů a nějaké sklady vytvořené.

stock_id

integer · required

ID skladu, párovací prvek. Pokud jej neznáte můžete použít code

code

string

kód skladu. Může sloužit jako párovací prvek, pokud neznáte stock_id

position

string

pozice na skladě

quantity

number · float

počet jednotek na skladě

Pagination

current_page

integer · min: 1

aktuální strana

current_page_items

integer

počet položek na aktuální straně

number_of_items

integer

celkový počet položek

number_of_pages

integer

celkový počet stran

MetaCategory

string · enum

Enum values:

advices

articles

MetaType

string · enum

Enum values:

checkbox

radiolist

input

date

number

textarea

formatted

typ vlastního pole:

checkbox - Zatržítko
radiolist - Přepínač
input - Textové pole
date - Textové pole - datum
email - Textové pole - emailová adresa
number - Textové pole - číslo
textarea - Víceřádkové textové pole
formatted - Víceřádkové textové pole, formátované
select - Rolovací nabídka
multiselect - Multi rolovací nabídka

MetaKey

string · pattern: ^[a-z_][a-z0-9_]*$

klíč vlastního pole

Metas

array

vlastní pole

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: key, value
	type = object · requires: key, values

Properties for Variant 1:

vlastní pole s hodnotami společnými pro všechny jazyky

key

MetaKey · pattern: ^[a-z_][a-z0-9_]*$ · required

klíč vlastního pole

value

string · required

hodnota společná pro všechny jazyky

MetasGet

array

vlastní pole

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: key, type, value
	type = object · requires: key, type, values

Properties for Variant 1:

vlastní pole s hodnotami společnými pro všechny jazyky

key

MetaKey · pattern: ^[a-z_][a-z0-9_]*$ · required

klíč vlastního pole

type

MetaType · enum · required

typ vlastního pole:

checkbox - Zatržítko
radiolist - Přepínač
input - Textové pole
date - Textové pole - datum
email - Textové pole - emailová adresa
number - Textové pole - číslo
textarea - Víceřádkové textové pole
formatted - Víceřádkové textové pole, formátované
select - Rolovací nabídka
multiselect - Multi rolovací nabídka

Enum values:

checkbox

radiolist

input

date

number

textarea

formatted

value

string · required

hodnota společná pro všechny jazyky

Currency

string

kód měny dle ISO 4217

Country

string

kód země dle ISO 3166-1 alpha-2

Language

string

kód jazyka dle ISO 639-1

Date

string · date

datum zapsané jako řeťezec znaků dle ISO 8601

DateTime

string · date-time

datum a čas zapsaný jako řeťezec znaků dle ISO 8601

QueryParameterArrayInt

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = string
	type = array

Properties for Variant 1:

string

hodnoty oddělené středníkem ;
například 1;2;3

QueryParameterArrayString

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = string
	type = array

Properties for Variant 1:

string

hodnoty oddělené středníkem ;
například A;B;C

QueryParameterPage

ErrorMessages

object[]

chybové zprávy

object

string

název objektu (část JSONu), kterého se zpráva týká

property

string

hodnota, které se zpráva týká

message

string

text zprávy

level

string · enum

úroveň chyby:

info - informační sdělení
warning - varování
error - chyba, pravděpodobně nedošlo ke zpracování
fatal_error - chyba API, kontaktujte technickou podporu

Enum values:

info

warning

error

fatal_error