Arkiway Connect API
REST API and webhooks for logistics portal integration — connect third-party TMS systems, freight platforms and operational tools with Arkiway Connect's customer portal infrastructure.
Connect your systems to the logistics portal
The Arkiway Connect API enables third-party TMS systems, freight platforms and logistics applications to integrate with the Arkiway Connect customer portal. Push and pull cargo requests, synchronise shipment status, exchange documents and receive real-time event notifications.
Designed for carriers and operators who use external TMS systems alongside Arkiway Connect — or for software vendors who want to offer their customers seamless portal integration.
- OAuth 2.0 Client Credentials flow
- JWT bearer tokens with tenant-level scope control
- Webhook signature verification (HMAC-SHA256)
- Versioned endpoints with deprecation notices
API capability groups
The Connect API is organised into capability groups for portal integration and data exchange.
Bidirectional integration between third-party Transport Management Systems and the Arkiway Connect portal.
- Shipment and voyage data synchronisation
- Schedule and ETA updates from external TMS
- Rate and pricing data exchange
- Customer and partner account mapping
Cargo request management, booking workflows and shipment lifecycle tracking.
- Create and manage cargo requests programmatically
- Booking confirmation and status updates
- Shipment tracking and milestone events
- Cargo specification and requirement handling
Upload, retrieve and manage transport documents linked to shipments and voyages.
- Bill of lading and freight document upload
- Document status tracking and versioning
- Customs and compliance document linking
- Bulk document retrieval and export
Real-time event notifications for cargo status changes, booking updates and document events.
- Cargo request and booking lifecycle events
- Shipment status change notifications
- Document upload and approval events
- Configurable event filtering and retry logic
Connect your logistics systems
The Arkiway Connect API is in early access. Contact our team to discuss integration scenarios, TMS compatibility and pilot access.