API-Referenz
Alle Pfade der INTEGALL-API v1 mit Parametern, Antworten und Beispielen mit curl.
Die Basisadresse ist https://api.integall.com/functions/v1/api-v1. Alle Antworten sind JSON (application/json; charset=utf-8) und werden nicht zwischengespeichert. Jede Antwort hat einen Header x-request-id; geben Sie ihn an, wenn Sie den Support kontaktieren.
Die vollständige technische Beschreibung (OpenAPI 3.1) rufen Sie mit GET /v1/openapi.json ab.
In den Beispielen steht $BASE für die Basisadresse und $INTEGALL_API_KEY für Ihren Schlüssel. Alle Werte in den Beispielen sind erfunden.
Health-Check#
GET /v1/ping — kein Schlüssel nötig.
curl "$BASE/v1/ping"{"ok": true, "version": "api-v1 1.0.0 (M26)", "docs": "/v1/openapi.json"}Sendungen#
Eine Sendung ist eine Fahrt in INTEGALL.
Sendungen auflisten#
GET /v1/shipments — Berechtigung shipments:read.
| Parameter | Typ | Bedeutung |
|---|---|---|
status | Text | Nur Sendungen mit diesem Status: planned, loading, transit, delivered, invoiced oder cancelled. |
limit | Zahl 1–200 | Anzahl pro Seite, standardmäßig 50. |
cursor | Text | Der next_cursor der vorigen Seite. |
curl -H "Authorization: Bearer $INTEGALL_API_KEY" \
"$BASE/v1/shipments?status=transit&limit=50"{
"data": [
{
"id": "ex-0001",
"ref": "RR-26-0003",
"status": "transit",
"customer": {"id": "c-0001", "name": "Beispielkunde NV"},
"pickup": {"place": "Liège", "date": "2026-11-18"},
"delivery": {"place": "Duisburg", "date": "2026-11-18"},
"cmr": "CMR-000102",
"customer_ref": "PO-4711"
}
],
"next_cursor": null
}Ist next_cursor nicht null, fragen Sie die nächste Seite mit ?cursor=<next_cursor> ab.
Eine Sendung mit Zeitleiste#
GET /v1/shipments/{ref} — Berechtigung shipments:read. {ref} ist die Fahrtnummer (zum Beispiel RR-26-0003) oder die id.
curl -H "Authorization: Bearer $INTEGALL_API_KEY" \
"$BASE/v1/shipments/RR-26-0003"{
"data": {
"id": "ex-0001",
"ref": "RR-26-0003",
"status": "transit",
"customer": {"id": "c-0001", "name": "Beispielkunde NV"},
"pickup": {"place": "Liège", "date": "2026-11-18"},
"delivery": {"place": "Duisburg", "date": "2026-11-18"},
"cmr": null,
"customer_ref": null,
"events": [
{"kind": "status", "status": "loading", "at": "2026-11-18T07:40:00Z"},
{"kind": "departed", "status": null, "at": "2026-11-18T09:05:00Z"}
]
}
}Die Zeitleiste (events) enthält die Arten status, arrived, loaded, departed, border und delay. Eine unbekannte Sendung liefert 404 mit E_NOT_FOUND.
Transport anfragen#
POST /v1/shipment-requests — Berechtigung shipments:write.
Die Anfrage geht beim Transportunternehmen unter Kunden › Anfragen ein, mit denselben Feldern wie eine Anfrage aus dem Kundenportal. Das Büro entscheidet und macht daraus eine Fahrt.
| Feld | Pflicht | Bedeutung |
|---|---|---|
customer_id | ja | Die ID des Kunden beim Transportunternehmen. |
from | ja | Ladeort. |
to | ja | Entladeort. |
fromDate | ja | Ladedatum, JJJJ-MM-TT. |
toDate | nein | Entladedatum, JJJJ-MM-TT. |
fromAddr, toAddr | nein | Lade- und Entladeadresse. |
cargo, kg, pallets, ldm | nein | Ladung, Gewicht, Paletten, Lademeter. |
ref | nein | Ihre Referenz. |
contact | nein | Ansprechpartner und Telefon. |
notes | nein | Bemerkung. |
adr | nein | true bei Gefahrgut. |
Zusätzliche Ladungsfelder folgen denselben Regeln wie im Kundenportal und werden vom Server geprüft. Pro Kunde gibt es höchstens 30 offene Anfragen. Der Body ist ein JSON-Objekt von höchstens 64 KB.
curl -X POST "$BASE/v1/shipment-requests" \
-H "Authorization: Bearer $INTEGALL_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"customer_id": "c-0001",
"from": "Antwerpen",
"to": "Lyon",
"fromDate": "2026-11-20",
"cargo": "Maschinenteile",
"pallets": "18",
"ref": "PO-4711"
}'Antwort mit einem Live-Schlüssel (201):
{"data": {"id": "req-0001", "status": "new"}}Antwort mit einem Testschlüssel (200, nichts gespeichert):
{"data": {"id": null, "sandbox": true, "valid": true}, "sandbox": true}Rechnungen#
GET /v1/invoices — Berechtigung invoices:read. Nur endgültige Rechnungen und Gutschriften; keine Entwürfe.
| Parameter | Typ | Bedeutung |
|---|---|---|
limit | Zahl 1–200 | Anzahl pro Seite, standardmäßig 50. |
cursor | Text | Der next_cursor der vorigen Seite. |
curl -H "Authorization: Bearer $INTEGALL_API_KEY" \
"$BASE/v1/invoices?limit=100"{
"data": [
{
"id": "inv-0001",
"number": "2026/0004",
"type": "invoice",
"customer_id": "c-0001",
"issue_date": "2026-10-16",
"due_date": "2026-11-30",
"net": 760.0,
"vat_rate": 0,
"currency": "EUR",
"payment_reference": null,
"paid": true,
"paid_date": "2026-10-29"
}
],
"next_cursor": null
}net ist der Betrag ohne MwSt. type ist invoice für eine Rechnung und credit für eine Gutschrift.