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.

[Read the Docs](https://docs.transportial.com)[Get API Access Free](https://portal.otms.transportial.com/auth/register)

OpenAPI 3.0API standard

RESTHTTP interface

OTM5Open standard

WebhooksEvent system

Transportial REST API

\# 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'

Full API reference, guides, and SDK docs at[docs.transportial.com](https://docs.transportial.com)

[Open Documentation](https://docs.transportial.com)

Quick Start

## Up and running in minutes

No complex onboarding. Get your API key, read the docs, and make your first API call.

01

### Create a free account

Register at portal.otms.transportial.com, no credit card required. Your API key is generated instantly.

02

### Read the documentation

Browse the full OpenAPI 3.0 spec, guides, and code examples at docs.transportial.com.

03

### Make your first API call

Use your API key to list transport orders, create trips, or stream vehicle positions, all over standard REST.

04

### 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 docs](https://docs.transportial.com/api/transport-orders)

Trip Management

### Optimise and execute trips

Trigger VRP trip optimisation, assign drivers and vehicles, manage multi-leg trips, and track execution in real time.

[View docs](https://docs.transportial.com/api/trips)

Tracking & Telemetry

### Live GPS & IoT telemetry

Stream live vehicle positions, driver status, and sensor telemetry. Integrates with Trimble, ZF Transics, and custom IoT.

[View docs](https://docs.transportial.com/api/tracking)

Webhooks

### 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 docs](https://docs.transportial.com/api/webhooks)

Pricing Engine

### Query and configure pricing rules

Create rate cards, apply fuel surcharges, trigger automated invoicing. Full TQL query language for dynamic pricing logic.

[View docs](https://docs.transportial.com/api/pricing)

Documents

### Generate transport documents

Auto-generate CMR waybills, delivery notes, and customs documents from transport order data. PDF export included.

[View docs](https://docs.transportial.com/api/documents)

Users & 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 docs](https://docs.transportial.com/api/users)

App 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 docs](https://docs.transportial.com/app-store)

App 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

[SDK Documentation](https://docs.transportial.com/app-store)[Become an App Partner](/en/contact)

app-store-sdk.ts

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

KotlinJavaScript

Fast 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"

npm install`gsjson`

[View on GitHub](https://github.com/Transportial/GSJson)

[github.com/Transportial](https://github.com/Transportial)

## Developer resources

Everything you need to go from idea to production.

[API ReferenceFull OpenAPI 3.0 spec with interactive Swagger UI. Explore every endpoint, schema, and response code.Browse API reference](https://docs.transportial.com/api)[OpenAPI SpecDownload the raw OpenAPI JSON/YAML spec for code generation, client SDKs, or integration testing.Download spec](https://docs.transportial.com/openapi)[App Store SDKNPM package, TypeScript types, and React hooks for building Transportial marketplace apps.View SDK docs](https://docs.transportial.com/sdk)[Webhook GuidePayload schemas, event catalogue, HMAC signature verification, and a testing sandbox.Read webhook guide](https://docs.transportial.com/webhooks)[App Store GuideStep-by-step guide to building, submitting, and maintaining a Transportial marketplace app.Read app store guide](https://docs.transportial.com/app-store)[Developer SupportEmail our developer relations team for technical questions, integration help, or partnership enquiries.Email the team](mailto:developers@transportial.com)

## Ready to build?

Get your API key for free, read the docs, and make your first call in minutes.

[Read the Docs](https://docs.transportial.com)[Get API Access Free](https://portal.otms.transportial.com/auth/register)

---
Canonical page: https://transportial.com/en/developers