Základná URL
https://{tenant}.logzi.com/api/transport_address/
Každá požiadavka vracia JSON odpoveď. Pri úspešnej odpovedi je result.code == 1, pri chybe result.code == 0. API Adresa prepravy slúži na správu dokladov prepravy a súvisiacich balíkov (parcels), na stiahnutie štítkov balíkov a na generovanie dodacích listov.
/api/transport_address/get
Získanie jedného záznamu adresy prepravy na základe identifikátora.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
id | int | Identifikátor adresy prepravy |
Príklad požiadavky
GET /api/transport_address/get?id=1
X-API-KEY: {vas_api_kluc}/api/transport_address/list
Stránkovateľný zoznam záznamov adries prepravy.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
receipt_id | int | Identifikátor dokladu na filtrovanie | |
list_offset | int | Posun stránkovania (predvolené: 0) | |
list_condition | object | Objekt s filtrovacími podmienkami |
Príklad požiadavky
GET /api/transport_address/list?receipt_id=1&list_offset=0
X-API-KEY: {vas_api_kluc}/api/transport_address/parcel_list
Získanie zoznamu balíkov (parcels) prepravy.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
list_condition | object | Objekt s filtrovacími podmienkami |
Príklad požiadavky
GET /api/transport_address/parcel_list
X-API-KEY: {vas_api_kluc}/api/transport_address/parcel_list_light
Získanie zjednodušeného zoznamu balíkov (s menším počtom polí).
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
list_condition | object | Objekt s filtrovacími podmienkami |
Príklad požiadavky
GET /api/transport_address/parcel_list_light
X-API-KEY: {vas_api_kluc}/api/transport_address/parcel_receipt_list
Získanie zoznamu balíkov patriacich k dokladu.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
list_condition | object | Objekt s filtrovacími podmienkami |
Príklad požiadavky
GET /api/transport_address/parcel_receipt_list
X-API-KEY: {vas_api_kluc}/api/transport_address/download
Stiahnutie dodacieho listu vo formáte PDF.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
file_type | string | Typ súboru (napr. pdf) | |
receipt_id | int | Identifikátor dokladu | |
receipt_type_id | int | Identifikátor typu dokladu | |
language | string | Jazyk dokumentu (napr. hu) | |
language_id | int | Identifikátor jazyka | |
template_id | int | Identifikátor tlačovej šablóny |
Príklad požiadavky
GET /api/transport_address/download?file_type=pdf&receipt_id=1&language=hu
X-API-KEY: {vas_api_kluc}/api/transport_address/download_parcel_label
Stiahnutie štítku balíka vo formáte PDF.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
file_type | string | Typ súboru (napr. pdf) | |
parcel_id | int | Identifikátor balíka | |
parcel_number | string | Sledovacie číslo balíka | |
language | string | Jazyk dokumentu (napr. hu) |
Príklad požiadavky
GET /api/transport_address/download_parcel_label?file_type=pdf&parcel_id=1
X-API-KEY: {vas_api_kluc}/api/transport_address/save_parcel
Zaznamenanie údajov balíka k dokladu prepravy.
POST polia — objekt data
V objekte data je potrebné zadať údaje balíka (identifikátor adresy prepravy, hmotnosť, rozmery, sledovacie číslo).
Príklad požiadavky
POST /api/transport_address/save_parcel
X-API-KEY: {vas_api_kluc}
Content-Type: application/json
{ "data": { "transport_address_id": 1, "weight": 2.5 } }Zaregistruj sa teraz,
zaplať neskôr!
