Základná URL
https://{tenant}.logzi.com/api/shipping/
Každá požiadavka vracia odpoveď vo formáte JSON. Pri úspešnej odpovedi platí result.code == 1, pri chybe result.code == 0. API dopravy umožňuje evidenciu spôsobov dopravy súvisiacich s webshopom a objednávkami, výpočet poplatkov a získavanie typov dopravy.
/api/shipping/get
Získanie jedného spôsobu dopravy.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
id | int | Identifikátor spôsobu dopravy | |
shipping_default | int | Predvolená doprava (0/1) | |
shipping_webname | string | Názov zobrazovaný vo webshope | |
language_id | int | Identifikátor jazyka |
Príklad požiadavky
GET /api/shipping/get?id=1&language_id=1
X-API-KEY: {vas_api_kluc}
/api/shipping/get_all
Získanie všetkých spôsobov dopravy.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
id | int | Filtrovanie podľa identifikátora |
Príklad požiadavky
GET /api/shipping/get_all
X-API-KEY: {vas_api_kluc}
/api/shipping/get_receipt_cost
Výpočet poplatku za dopravu na základe zadaného zoznamu produktov.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
id | int | Identifikátor spôsobu dopravy | |
product_list | array | Zoznam produktov na výpočet poplatku |
Príklad požiadavky
GET /api/shipping/get_receipt_cost?id=1
X-API-KEY: {vas_api_kluc}
/api/shipping/get_type
Získanie typu dopravy partnera.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
partner_id | int | Identifikátor partnera | |
shipping_type_name | string | Názov typu dopravy | |
language_id | int | Identifikátor jazyka |
Príklad požiadavky
GET /api/shipping/get_type?partner_id=1&language_id=1
X-API-KEY: {vas_api_kluc}
/api/shipping/list
Získanie zoznamu spôsobov dopravy v danom jazyku.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
language_id | int | Identifikátor jazyka |
Príklad požiadavky
GET /api/shipping/list?language_id=1
X-API-KEY: {vas_api_kluc}
/api/shipping/save
Vytvorenie alebo úprava spôsobu dopravy.
POST polia — objekt data
V objekte data je potrebné zadať údaje spôsobu dopravy (názov, webshop názov, poplatky, typ dopravy).
Príklad požiadavky
POST /api/shipping/save
X-API-KEY: {vas_api_kluc}
Content-Type: application/json
{ "data": { "id": 1 } }
/api/shipping/delete
Vymazanie spôsobu dopravy podľa identifikátora.
POST polia
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | int | Identifikátor spôsobu dopravy, ktorý sa má vymazať |
Príklad požiadavky
POST /api/shipping/delete
X-API-KEY: {vas_api_kluc}
Content-Type: application/json
{ "id": 1 }
Zaregistruj sa teraz,
zaplať neskôr!