API-referentie
Alle paden van de INTEGALL-API v1 met parameters, antwoorden en voorbeelden met curl.
Het basisadres is https://api.integall.com/functions/v1/api-v1. Alle antwoorden zijn JSON (application/json; charset=utf-8) en worden niet gecachet. Elk antwoord heeft een header x-request-id; vermeld die als u support contacteert.
De volledige technische beschrijving (OpenAPI 3.1) haalt u op met GET /v1/openapi.json.
In de voorbeelden staat $BASE voor het basisadres en $INTEGALL_API_KEY voor uw sleutel. Alle waarden in de voorbeelden zijn verzonnen.
Gezondheidscontrole#
GET /v1/ping — geen sleutel nodig.
curl "$BASE/v1/ping"{"ok": true, "version": "api-v1 1.0.0 (M26)", "docs": "/v1/openapi.json"}Zendingen#
Een zending is een rit in INTEGALL.
Zendingen oplijsten#
GET /v1/shipments — bevoegdheid shipments:read.
| Parameter | Type | Betekenis |
|---|---|---|
status | tekst | Enkel zendingen met deze status: planned, loading, transit, delivered, invoiced of cancelled. |
limit | getal 1–200 | Aantal per pagina, standaard 50. |
cursor | tekst | De next_cursor van de vorige pagina. |
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": "Voorbeeldklant 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
}Is next_cursor niet null, vraag dan de volgende pagina op met ?cursor=<next_cursor>.
Eén zending met tijdlijn#
GET /v1/shipments/{ref} — bevoegdheid shipments:read. {ref} is het ritnummer (bijvoorbeeld RR-26-0003) of het 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": "Voorbeeldklant 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"}
]
}
}De tijdlijn (events) bevat de soorten status, arrived, loaded, departed, border en delay. Een onbekende zending geeft 404 met E_NOT_FOUND.
Transport aanvragen#
POST /v1/shipment-requests — bevoegdheid shipments:write.
De aanvraag komt binnen bij het transportbedrijf onder Klanten › Aanvragen, met dezelfde velden als een aanvraag uit het klantenportaal. Het kantoor beslist en maakt er een rit van.
| Veld | Verplicht | Betekenis |
|---|---|---|
customer_id | ja | Het id van de klant bij het transportbedrijf. |
from | ja | Laadplaats. |
to | ja | Losplaats. |
fromDate | ja | Laaddatum, JJJJ-MM-DD. |
toDate | nee | Losdatum, JJJJ-MM-DD. |
fromAddr, toAddr | nee | Laad- en losadres. |
cargo, kg, pallets, ldm | nee | Lading, gewicht, pallets, laadmeter. |
ref | nee | Uw referentie. |
contact | nee | Contactpersoon en telefoon. |
notes | nee | Opmerking. |
adr | nee | true bij gevaarlijke goederen. |
Extra ladingvelden volgen dezelfde regels als in het klantenportaal en worden door de server gecontroleerd. Per klant zijn er hoogstens 30 open aanvragen. De body is een JSON-object van hoogstens 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": "Machineonderdelen",
"pallets": "18",
"ref": "PO-4711"
}'Antwoord met een live-sleutel (201):
{"data": {"id": "req-0001", "status": "new"}}Antwoord met een proefsleutel (200, niets opgeslagen):
{"data": {"id": null, "sandbox": true, "valid": true}, "sandbox": true}Facturen#
GET /v1/invoices — bevoegdheid invoices:read. Enkel definitieve facturen en creditnota's; concepten niet.
| Parameter | Type | Betekenis |
|---|---|---|
limit | getal 1–200 | Aantal per pagina, standaard 50. |
cursor | tekst | De next_cursor van de vorige pagina. |
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 is het bedrag excl. btw. type is invoice voor een factuur en credit voor een creditnota.