Základná URL
https://{tenant}.logzi.com/api/shipping_type/
Každá požiadavka vracia odpoveď vo formáte JSON. Pri úspešnej odpovedi je result.code == 1, pri chybe result.code == 0.
/api/shipping_type/get
Získanie jedného spôsobu dopravy na základe identifikátora.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
id | int | Jedinečný identifikátor spôsobu dopravy |
Príklad požiadavky
GET /api/shipping_type/get?id=1
X-API-KEY: {vas_api_kluc}
/api/shipping_type/list
Stránkovateľné získanie zoznamu spôsobov dopravy s možnosťami filtrovania.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
list_offset | int | Posun stránkovania (predvolené: 0) | |
list_condition | array | Pole filtrovacích podmienok |
Príklad požiadavky
GET /api/shipping_type/list?list_offset=0
X-API-KEY: {vas_api_kluc}
/api/shipping_type/save
Vytvorenie alebo úprava spôsobu dopravy. Pre nový záznam data[id] = 0.
POST polia — objekt data
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | int | 0 = nový spôsob dopravy, >0 = úprava | |
name | string | Názov spôsobu dopravy (napr. "Kuriérska služba") | |
shipping_type_code | string | Krátky identifikačný kód pre spôsob dopravy |
Príklad požiadavky
POST /api/shipping_type/save
X-API-KEY: {vas_api_kluc}
Content-Type: application/json
{
"data": {
"id": 0,
"name": "Futárszolgálat"
}
}
/api/shipping_type/delete
Odstránenie spôsobu dopravy na základe identifikátora.
POST polia — objekt data
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | int | Identifikátor spôsobu dopravy, ktorý sa má odstrániť |
Príklad požiadavky
POST /api/shipping_type/delete
X-API-KEY: {vas_api_kluc}
Content-Type: application/json
{ "data": { "id": 1 } }
Zaregistruj sa teraz,
zaplať neskôr!