API reference

All paths of the INTEGALL API v1 with parameters, responses and examples with curl.

Last updated: Need help? Contact support

The base address is https://api.integall.com/functions/v1/api-v1. All responses are JSON (application/json; charset=utf-8) and are not cached. Every response has an x-request-id header; state it when you contact support.

You get the full technical description (OpenAPI 3.1) with GET /v1/openapi.json.

In the examples $BASE stands for the base address and $INTEGALL_API_KEY for your key. All values in the examples are made up.

Health check#

GET /v1/ping — no key needed.

curl "$BASE/v1/ping"
{"ok": true, "version": "api-v1 1.0.0 (M26)", "docs": "/v1/openapi.json"}

Shipments#

A shipment is a trip in INTEGALL.

List shipments#

GET /v1/shipments — permission shipments:read.

ParameterTypeMeaning
statustextOnly shipments with this status: planned, loading, transit, delivered, invoiced or cancelled.
limitnumber 1–200Number per page, default 50.
cursortextThe next_cursor of the previous page.
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": "Sample Customer Ltd"},
      "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
}

If next_cursor is not null, request the next page with ?cursor=<next_cursor>.

One shipment with timeline#

GET /v1/shipments/{ref} — permission shipments:read. {ref} is the trip number (for example RR-26-0003) or the 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": "Sample Customer Ltd"},
    "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"}
    ]
  }
}

The timeline (events) contains the kinds status, arrived, loaded, departed, border and delay. An unknown shipment gives 404 with E_NOT_FOUND.

Request a transport#

POST /v1/shipment-requests — permission shipments:write.

The request arrives at the transport company under Customers › Requests, with the same fields as a request from the customer portal. The office decides and turns it into a trip.

FieldRequiredMeaning
customer_idyesThe id of the customer at the transport company.
fromyesLoading place.
toyesUnloading place.
fromDateyesLoading date, YYYY-MM-DD.
toDatenoUnloading date, YYYY-MM-DD.
fromAddr, toAddrnoLoading and unloading address.
cargo, kg, pallets, ldmnoCargo, weight, pallets, loading metres.
refnoYour reference.
contactnoContact person and phone.
notesnoComment.
adrnotrue for dangerous goods.

Extra cargo fields follow the same rules as in the customer portal and are validated by the server. There are at most 30 open requests per customer. The body is a JSON object of at most 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": "Machine parts",
    "pallets": "18",
    "ref": "PO-4711"
  }'

Response with a live key (201):

{"data": {"id": "req-0001", "status": "new"}}

Response with a test key (200, nothing stored):

{"data": {"id": null, "sandbox": true, "valid": true}, "sandbox": true}

Invoices#

GET /v1/invoices — permission invoices:read. Only final invoices and credit notes; no drafts.

ParameterTypeMeaning
limitnumber 1–200Number per page, default 50.
cursortextThe next_cursor of the previous page.
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 the amount excl. VAT. type is invoice for an invoice and credit for a credit note.