Developer Platform
Build on Transportial
A full REST API, App Store SDK, webhook framework, and OTM5-native data model. Everything you need to build logistics software on a platform already running in production.
OpenAPI 3.0API standard
RESTHTTP interface
OTM5Open standard
WebhooksEvent system
# Authenticate with your API key
Authorization: Bearer <api-key>
GET /api/v1/transport-orders # list & filter orders
POST /api/v1/trips/optimise # VRP trip optimisation
GET /api/v1/vehicles/tracking # live GPS positions
POST /api/v1/webhooks/register # subscribe to events
GET /api/v1/invoices # billing & financials
# App Store SDK
import { TransportialSDK } from '@transportial/sdk'
Quick Start
Up and running in minutes
No complex onboarding. Get your API key, read the docs, and make your first API call.
Create a free account
Register at portal.otms.transportial.com, no credit card required. Your API key is generated instantly.
Read the documentation
Browse the full OpenAPI 3.0 spec, guides, and code examples at docs.transportial.com.
Make your first API call
Use your API key to list transport orders, create trips, or stream vehicle positions, all over standard REST.
Build and publish
Build your integration, white-label deployment, or App Store app, then submit it to the Transportial marketplace.
Your first API call:
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://api.transportial.com/v1/transport-orders
API Reference
What you can build with the API
Every major resource in Transportial is exposed via REST. Full CRUD, filtering, pagination, and webhook events.
Transport Orders
Create & manage transport orders
Full lifecycle management: create, update, assign, and track transport orders. Filter by status, date, customer, and more.
View docsTrip Management
Optimise and execute trips
Trigger VRP trip optimisation, assign drivers and vehicles, manage multi-leg trips, and track execution in real time.
View docsTracking & Telemetry
Live GPS & IoT telemetry
Stream live vehicle positions, driver status, and sensor telemetry. Integrates with Trimble, ZF Transics, and custom IoT.
View docsWebhooks
Subscribe to real-time events
Register webhooks for 60+ event types: order created, trip started, driver late, invoice paid, and more. HMAC-signed payloads.
View docsPricing Engine
Query and configure pricing rules
Create rate cards, apply fuel surcharges, trigger automated invoicing. Full TQL query language for dynamic pricing logic.
View docsDocuments
Generate transport documents
Auto-generate CMR waybills, delivery notes, and customs documents from transport order data. PDF export included.
View docsUsers & Permissions
Manage users and access control
200+ named permissions, role-based access control, SAML 2.0 SSO, and JWT auth with TOTP 2FA. Enterprise-ready.
View docsApp Store
Build and publish marketplace apps
Use the App Store SDK to embed custom panels in any view. Publish to the Transportial marketplace or deploy privately.
View docsApp Store SDK
Extend the platform with your own apps
The Transportial App Store lets you embed custom React panels directly inside the TMS: trip views, dashboards, shipment details. Build once, deploy to any Transportial tenant.
- Register panels in any view slot (trip, order, dashboard)
- Access live platform context via the SDK hook
- Call the REST API from within your app panel
- Submit to the marketplace or install privately
- Version management and automatic updates
- Sandbox environment for development & testing
import { TransportialSDK } from '@transportial/sdk'
const app = new TransportialSDK({
appId: 'your-app-id',
version: '1.0.0',
})
// Register a panel in the trip view
app.registerPanel({
slot: 'trip.sidebar',
component: MyPanel,
})
Integration Framework
Connect any external system
The built-in integration pipeline handles queue management, retry logic, status tracking, and error handling, so you focus on mapping, not infrastructure.
REST API
Full OpenAPI 3.0 specification. API key authentication with per-key rate limiting, IP allowlisting, and detailed request logs.
FTP Server & EDI
Built-in FTP server with EDI file parsing for legacy shipper systems. Supports EDIFACT, X12, and custom flat-file formats.
Webhooks & Events
Subscribe to 60+ platform events with HMAC-verified webhook payloads. Configurable retry with exponential backoff.
SAML 2.0 SSO
Enterprise identity federation with any SAML 2.0 IdP: Azure AD, Okta, Google Workspace, and more.
OTM5 Standard
Native OTM5 data model for interoperability with the broader European freight transport ecosystem.
Custom Connectors
Build custom integration connectors using the integration framework SDK and deploy them to any Transportial tenant.
Open Source
Built in the open
We believe the best infrastructure is shared. Transportial publishes open-source libraries that power our own platform, free for any developer to use.
GSJson
KotlinJavaScriptFast JSON getter/setter for JVM & JavaScript
A powerful JSON path library inspired by GJSON. Query and mutate JSON with dot-notation paths, wildcards, array filters, modifiers, and back-references, in both Kotlin/Java and JavaScript/TypeScript.
# Query nested JSON with a clean path syntax
GSJson.get(json, 'name.first') // → "Tom"
GSJson.get(json, 'friends.[age > "40"].[#.first]') // → ["Dale","Roger","Jane"]
GSJson.get(json, 'children|@reverse|@join') // → "Jack,Alex,Sara"
Developer resources
Everything you need to go from idea to production.
API Reference
Full OpenAPI 3.0 spec with interactive Swagger UI. Explore every endpoint, schema, and response code.
Browse API referenceOpenAPI Spec
Download the raw OpenAPI JSON/YAML spec for code generation, client SDKs, or integration testing.
Download specApp Store SDK
NPM package, TypeScript types, and React hooks for building Transportial marketplace apps.
View SDK docsWebhook Guide
Payload schemas, event catalogue, HMAC signature verification, and a testing sandbox.
Read webhook guideApp Store Guide
Step-by-step guide to building, submitting, and maintaining a Transportial marketplace app.
Read app store guideDeveloper Support
Email our developer relations team for technical questions, integration help, or partnership enquiries.
Email the teamReady to build?
Get your API key for free, read the docs, and make your first call in minutes.