Basis-URL
https://{tenant}.logzi.com/api/transport_address/
Jede Anfrage liefert eine JSON-Antwort zurück. Bei Erfolg gilt result.code == 1, bei Fehler result.code == 0. Die Spedition-Adresse API dient der Verwaltung von Speditionsbelegen und der zugehörigen Pakete (parcels), dem Download von Paketetiketten und der Erstellung von Lieferscheinen.
/api/transport_address/get
Abrufen eines einzelnen Speditionsadress-Datensatzes anhand der Kennung.
Query-Parameter
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | int | Kennung der Speditionsadresse |
Beispielanfrage
GET /api/transport_address/get?id=1
X-API-KEY: {ihr_api_schluessel}/api/transport_address/list
Paginierbare Liste der Speditionsadress-Datensätze.
Query-Parameter
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
receipt_id | int | Kennung des Belegs zur Filterung | |
list_offset | int | Versatz der Paginierung (Standard: 0) | |
list_condition | object | Objekt mit Filterbedingungen |
Beispielanfrage
GET /api/transport_address/list?receipt_id=1&list_offset=0
X-API-KEY: {ihr_api_schluessel}/api/transport_address/parcel_list
Abrufen der Liste der Speditionspakete (parcels).
Query-Parameter
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
list_condition | object | Objekt mit Filterbedingungen |
Beispielanfrage
GET /api/transport_address/parcel_list
X-API-KEY: {ihr_api_schluessel}/api/transport_address/parcel_list_light
Abrufen der vereinfachten Paketliste (mit weniger Datenfeldern).
Query-Parameter
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
list_condition | object | Objekt mit Filterbedingungen |
Beispielanfrage
GET /api/transport_address/parcel_list_light
X-API-KEY: {ihr_api_schluessel}/api/transport_address/parcel_receipt_list
Abrufen der Liste der zu einem Beleg gehörenden Pakete.
Query-Parameter
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
list_condition | object | Objekt mit Filterbedingungen |
Beispielanfrage
GET /api/transport_address/parcel_receipt_list
X-API-KEY: {ihr_api_schluessel}/api/transport_address/download
Download des Lieferscheins im PDF-Format.
Query-Parameter
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
file_type | string | Dateityp (z. B. pdf) | |
receipt_id | int | Kennung des Belegs | |
receipt_type_id | int | Kennung des Belegtyps | |
language | string | Sprache des Dokuments (z. B. hu) | |
language_id | int | Kennung der Sprache | |
template_id | int | Kennung der Druckvorlage |
Beispielanfrage
GET /api/transport_address/download?file_type=pdf&receipt_id=1&language=hu
X-API-KEY: {ihr_api_schluessel}/api/transport_address/download_parcel_label
Download des Paketetiketts im PDF-Format.
Query-Parameter
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
file_type | string | Dateityp (z. B. pdf) | |
parcel_id | int | Kennung des Pakets | |
parcel_number | string | Sendungsverfolgungsnummer des Pakets | |
language | string | Sprache des Dokuments (z. B. hu) |
Beispielanfrage
GET /api/transport_address/download_parcel_label?file_type=pdf&parcel_id=1
X-API-KEY: {ihr_api_schluessel}/api/transport_address/save_parcel
Erfassen der Paketdaten zu einem Speditionsbeleg.
POST-Felder — data-Objekt
Im data-Objekt müssen die Paketdaten angegeben werden (Kennung der Speditionsadresse, Gewicht, Maße, Sendungsverfolgungsnummer).
Beispielanfrage
POST /api/transport_address/save_parcel
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{ "data": { "transport_address_id": 1, "weight": 2.5 } }Interessierst du dich für unsere Software? Schreib uns einfach!
Jetzt registrieren,
später bezahlen!
