Welcome to the Transportial developer guides. Whether you're getting started or building advanced integrations, you'll find everything you need here.
- Quickstart — Authenticate and create your first transport order in minutes
- Onboarding — Full platform setup from registration to first planned transport
- Core Concepts — The OTM5 entity hierarchy: platforms, businesses, orders, consignments, trips, actions
- Authentication & Permissions — Login, 2FA, sessions, roles, SAML, and user management
- Search & Filtering — Pagination, search endpoints, TQL queries, and reference data
- Consignments & Goods — Manage cargo, split and combine consignments, track goods
- Trips & Planning — Create trips, assign vehicles, calculate routes, manage actions
- Webhooks & Events — React to transport events, set up notifications
- Vehicles & Fleet — Manage vehicles, transport equipment, sensors, board computers
- Chauffeurs & Drivers — Driver management, activities, certificates, service cards
- Businesses & Contacts — Companies, customers, carriers, contact details, tax identifiers
- Teams & Organizations — Teams, administrations, platform settings, tenders
- Invoicing & Finance — Invoices, quotes, public quote links, payment tracking
- Pricing & Charges — Pricing rules, charges, transactions, ledger entries, financial insights
- Integrations — Connect external systems via data pipelines and API access
- App Store — Browse, install, and manage platform extensions
- Documents & Files — Document management, file uploads, email processing
Step-by-step practical examples:
- Managing Transport Orders — CRUD operations and email import
- Managing Locations — Addresses, coordinates, duplicate checking
- Planning a Multi-Stop Trip — Multi-drop route with action tracking
- Fleet Tracking & Monitoring — GPS, sensors, events, and fleet analytics
- End-to-End Invoice Workflow — Quote to invoice to payment
- Building a Custom Integration — Event-driven data sync with monitoring
- Splitting & Combining Consignments — Split for multiple trucks, combine for efficiency
- Message Automations — Automated notifications and chat messaging