URL de bază
https://{tenant}.logzi.com/api/transport_address/
Fiecare cerere returnează un răspuns JSON. În caz de succes result.code == 1, în caz de eroare result.code == 0. API-ul Adrese de transport este destinat gestionării documentelor de transport și a coletelor (parcels) asociate acestora, descărcării etichetelor de colet și generării avizelor de expediție.
/api/transport_address/get
Preluarea unei singure înregistrări de adresă de transport pe baza identificatorului.
Parametri query
| Parametru | Tip | Obligatoriu | Descriere |
|---|---|---|---|
id | int | Identificatorul adresei de transport |
Exemplu de cerere
GET /api/transport_address/get?id=1
X-API-KEY: {cheia_dvs_api}
/api/transport_address/list
Listă paginabilă a înregistrărilor de adresă de transport.
Parametri query
| Parametru | Tip | Obligatoriu | Descriere |
|---|---|---|---|
receipt_id | int | Identificatorul documentului pentru filtrare | |
list_offset | int | Decalajul pentru paginare (implicit: 0) | |
list_condition | object | Obiect cu condiții de filtrare |
Exemplu de cerere
GET /api/transport_address/list?receipt_id=1&list_offset=0
X-API-KEY: {cheia_dvs_api}
/api/transport_address/parcel_list
Preluarea listei coletelor (parcels) de transport.
Parametri query
| Parametru | Tip | Obligatoriu | Descriere |
|---|---|---|---|
list_condition | object | Obiect cu condiții de filtrare |
Exemplu de cerere
GET /api/transport_address/parcel_list
X-API-KEY: {cheia_dvs_api}
/api/transport_address/parcel_list_light
Preluarea listei simplificate de colete (cu mai puține câmpuri de date).
Parametri query
| Parametru | Tip | Obligatoriu | Descriere |
|---|---|---|---|
list_condition | object | Obiect cu condiții de filtrare |
Exemplu de cerere
GET /api/transport_address/parcel_list_light
X-API-KEY: {cheia_dvs_api}
/api/transport_address/parcel_receipt_list
Preluarea listei coletelor asociate unui document.
Parametri query
| Parametru | Tip | Obligatoriu | Descriere |
|---|---|---|---|
list_condition | object | Obiect cu condiții de filtrare |
Exemplu de cerere
GET /api/transport_address/parcel_receipt_list
X-API-KEY: {cheia_dvs_api}
/api/transport_address/download
Descărcarea avizului de expediție în format PDF.
Parametri query
| Parametru | Tip | Obligatoriu | Descriere |
|---|---|---|---|
file_type | string | Tipul fișierului (de ex. pdf) | |
receipt_id | int | Identificatorul documentului | |
receipt_type_id | int | Identificatorul tipului de document | |
language | string | Limba documentului (de ex. hu) | |
language_id | int | Identificatorul limbii | |
template_id | int | Identificatorul șablonului de tipărire |
Exemplu de cerere
GET /api/transport_address/download?file_type=pdf&receipt_id=1&language=hu
X-API-KEY: {cheia_dvs_api}
/api/transport_address/download_parcel_label
Descărcarea etichetei de colet în format PDF.
Parametri query
| Parametru | Tip | Obligatoriu | Descriere |
|---|---|---|---|
file_type | string | Tipul fișierului (de ex. pdf) | |
parcel_id | int | Identificatorul coletului | |
parcel_number | string | Numărul de urmărire al coletului | |
language | string | Limba documentului (de ex. hu) |
Exemplu de cerere
GET /api/transport_address/download_parcel_label?file_type=pdf&parcel_id=1
X-API-KEY: {cheia_dvs_api}
/api/transport_address/save_parcel
Înregistrarea datelor coletului pentru un document de transport.
Câmpuri POST — obiectul data
În obiectul data trebuie specificate datele coletului (identificatorul adresei de transport, greutate, dimensiuni, număr de urmărire).
Exemplu de cerere
POST /api/transport_address/save_parcel
X-API-KEY: {cheia_dvs_api}
Content-Type: application/json
{ "data": { "transport_address_id": 1, "weight": 2.5 } }
Ești interesat de software-ul nostru? Scrie-ne cu încredere!
Dacă nu găsești răspunsul și ai nevoie de asistență
Creează-ți contul acum,
plătește mai târziu!