Référence de l'API

Tous les chemins de l'API INTEGALL v1 avec les paramètres, les réponses et des exemples avec curl.

Dernière mise à jour: Besoin d'aide ? Contactez le support

L'adresse de base est https://api.integall.com/functions/v1/api-v1. Toutes les réponses sont en JSON (application/json; charset=utf-8) et ne sont pas mises en cache. Chaque réponse comporte un en-tête x-request-id ; indiquez-le lorsque vous contactez le support.

La description technique complète (OpenAPI 3.1) s'obtient avec GET /v1/openapi.json.

Dans les exemples, $BASE représente l'adresse de base et $INTEGALL_API_KEY votre clé. Toutes les valeurs des exemples sont inventées.

Contrôle de santé#

GET /v1/ping — aucune clé nécessaire.

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

Envois#

Un envoi est un trajet dans INTEGALL.

Lister les envois#

GET /v1/shipments — autorisation shipments:read.

ParamètreTypeSignification
statustexteUniquement les envois ayant ce statut : planned, loading, transit, delivered, invoiced ou cancelled.
limitnombre 1–200Nombre par page, 50 par défaut.
cursortexteLe next_cursor de la page précédente.
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
}

Si next_cursor n'est pas null, demandez la page suivante avec ?cursor=<next_cursor>.

Un envoi avec sa chronologie#

GET /v1/shipments/{ref} — autorisation shipments:read. {ref} est le numéro de trajet (par exemple RR-26-0003) ou l'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"}
    ]
  }
}

La chronologie (events) contient les types status, arrived, loaded, departed, border et delay. Un envoi inconnu renvoie 404 avec E_NOT_FOUND.

Demander un transport#

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

La demande arrive chez l'entreprise de transport sous Clients › Demandes, avec les mêmes champs qu'une demande issue du portail client. Le bureau décide et en fait un trajet.

ChampObligatoireSignification
customer_idouiL'id du client chez l'entreprise de transport.
fromouiLieu de chargement.
toouiLieu de déchargement.
fromDateouiDate de chargement, AAAA-MM-JJ.
toDatenonDate de déchargement, AAAA-MM-JJ.
fromAddr, toAddrnonAdresse de chargement et de déchargement.
cargo, kg, pallets, ldmnonMarchandise, poids, palettes, mètres de chargement.
refnonVotre référence.
contactnonPersonne de contact et téléphone.
notesnonRemarque.
adrnontrue pour les marchandises dangereuses.

Les champs de marchandise supplémentaires suivent les mêmes règles que dans le portail client et sont vérifiés par le serveur. Chaque client peut avoir au maximum 30 demandes ouvertes. Le corps est un objet JSON de 64 Ko au maximum.

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"
  }'

Réponse avec une clé réelle (201) :

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

Réponse avec une clé de test (200, rien n'est enregistré) :

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

Factures#

GET /v1/invoices — autorisation invoices:read. Uniquement les factures et notes de crédit définitives ; pas les brouillons.

ParamètreTypeSignification
limitnombre 1–200Nombre par page, 50 par défaut.
cursortexteLe next_cursor de la page précédente.
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 est le montant hors TVA. type vaut invoice pour une facture et credit pour une note de crédit.