Způsoby dopravy
Požadavky
Všechny API požadavky musí dodržovat následující formát:
GET /CESTA
Authorization: Váš API token
Accept: application/json
Dostupné požadavky
/deliveries
Vrátí všechny aktivní způsoby dopravy.
Dostupné GET parametry
| Parametr | Povinný | Popis |
|---|---|---|
shopId |
Ano | ID e-shopu |
supplierId |
Ano | ID dodavatele |
Ukázková odpověď
{
"code": 200,
"message": "",
"data": [
{
"id": 1,
"name": "Česká pošta (balík do ruky)",
"price": 99,
"price_vat": 120,
"delivery_type": 1,
"country_from": 1,
"country_to": 1,
"hasPlaces": false,
"payments": [
{
"id": 1,
"name": "Dobírka",
"price": 25,
"price_vat": 30,
"payment_type": 1
},
{
"id": 2,
"name": "Bankovní převod",
"price": 0,
"price_vat": 0,
"payment_type": 2
}
]
}
]
}
Popis parametrů odpovědi
| Parametr | Typ | Popis |
|---|---|---|
id |
int | ID způsobu dopravy |
name |
string | Název |
price_default_no_vat |
float | VOC bez DPH |
price |
float | Cena bez DPH |
price_vat |
float | Cena včetně DPH |
delivery_type |
int | Typ dopravy |
country_from |
int | ID země z |
country_to |
int | ID země do |
hasPlaces |
bool | Zda má tento způsob dopravy odběrná místa |
payments |
DeliveryPayment[] | Dostupné platební metody |
Popis parametrů typu DeliveryPayment
| Parametr | Typ | Popis |
|---|---|---|
id |
int | ID platební metody |
name |
string | Název platební metody |
price_default_no_vat |
float | VOC bez DPH |
price |
float | Cena bez DPH |
price_vat |
float | Cena včetně DPH |
payment_type |
int | Typ |
/deliveries/places
Vrátí všechna dostupná odběrná místa pro daný způsob dopravy.
Dostupné GET parametry
| Parametr | Povinný | Popis |
|---|---|---|
deliveryId |
Ano | ID způsobu dopravy |
Ukázková odpověď
{
"code": 200,
"message": "",
"data": [
{
"id": 1,
"place": "Zásilkovna s.r.o.",
"street": "Andělská Hora",
"city": "Andělská Hora",
"region_name": "Karlovarský kraj"
},
{
"id": 2,
"place": "BikeSport 007",
"street": "Červené Vršky 1594",
"city": "Benešov u Prahy",
"region_name": "Středočeský kraj"
}
]
}
Popis parametrů odpovědi
| Parametr | Typ | Popis |
|---|---|---|
id |
int | ID odběrného místa |
place |
string | Název |
street |
string | Ulice |
city |
string | Město |
region_name |
string | Kraj |
Odpovědi
Všechny odpovědi API jsou ve formátu JSON a mají následjící formát:
{
"code": 200,
"message": "",
"data": []
}
Popis parametrů odpovědi
| Parametr | Typ | Popis |
|---|---|---|
code |
int | Odpovídá kódům HTTP protokolu (tedy kód 200 znamená OK apod.) |
message |
string | Chybová hláška, neprázdná pouze v případě chyby (kód odlišný od 200) |
data |
array | Konkrétní data |