Introduction
Welcome to the MendriX Developer Portal — the central place to build integrations with the MendriX Transport Management System (TMS). MendriX is built to integrate: whatever your stack, there is a clean, well-documented way in.
A platform of integration surfaces
Section titled “A platform of integration surfaces”Each surface plays to a different strength — pick the one that fits the job:
| Surface | Great for | Format | Auth |
|---|---|---|---|
| Core API (REST) | General-purpose integration — clients, contacts, address books, invoices & payments, order and task updates | JSON | Bearer JWT via login-api-token |
| Driver API (REST) | Driver-, device- and FMS-facing operations — tasks, rides, tracking, chat, questionnaires | JSON | Bearer JWT via login-api-token |
| Track & Trace API (REST) | Customer-facing shipment status and delivery-appointment self-service | JSON | Query-param entry point |
| Custom Link (SOAP) | The deepest reach into the TMS — order intake, planning, traces, packaging, and much more | XML/SOAP | Token in the SOAP request |
As an external integrator you authenticate the Driver API exactly like the
Core API — exchange an API token for a JWT at login-api-token. (The MendriX
mobile app itself signs in through a separate login-driver endpoint that is
not part of the public integration surface.)
The REST APIs are clean and JSON-native, and they are where day-to-day integration happens. Custom Link is our most extensive, battle-tested surface — when an integration is truly demanding, it reaches every corner of the TMS. And whichever surface you build on, every guide is documented for developers (REST) and low-code teams (n8n) alike.
What you can build
Section titled “What you can build”The Core API is organised into a few services:
- Client — list, create, get, update and soft-delete clients; manage contacts, per-client address books and the global address book.
- Invoice — list, get and patch invoices; finalize, cancel or delete preliminary invoices; list and record payments.
- Order — patch orders and tasks, copy orders (including credit copies), and rank purchase options.
Custom Link goes deepest of all — order intake and update, order retrieval, rides and planning, traces, employees and hours, packaging transactions, measurements, memos, questionnaires and jobs.
Typical integrations built on top of these:
- Client & CRM sync — keep your CRM and the TMS aligned in both directions.
- Order intake — push orders from your own system into MendriX.
- Order status & track-and-trace — receive status changes by webhook and fall back to polling.
- Invoices → accounting — pull finalized invoices and post payments back.
Two documentation paths
Section titled “Two documentation paths”Every integration guide documents each step twice, in a synced tab pair:
- Manual (REST) — full
curland JavaScript examples. - n8n — a node-by-node walkthrough plus an importable workflow JSON.
Your tab choice is remembered site-wide, so if you pick n8n once you will see n8n instructions everywhere.
Next steps
Section titled “Next steps”- Review your environments & URLs.
- Create a token and make your first call in Authentication.
- Follow Your first integration end to end.