Integration philosophy
Orbex Data sits alongside your systems of record—not as a replacement. Bookings originate in your TMS; finance posts in your ERP; Orbex Data unifies visibility, documents, exceptions, and analytics. Integrations keep data synchronized without duplicate manual entry.
Bidirectional where it matters
Inbound sync brings bookings and milestones into Orbex Data. Outbound sync pushes approved documents, status updates, and accruals to downstream systems.
Integration types
| Method | Best for | Latency |
|---|---|---|
| Native connector | Supported TMS/ERP apps | Near real-time |
| REST API | Custom apps and middleware | On demand |
| Webhooks | Event-driven automation | Seconds |
| SFTP / EDI | Legacy carrier and partner feeds | Batch |
| Email ingestion | Ad hoc document receipt | Minutes |
- OAuth 2.0 for user-delegated connector authorization
- API keys for server-to-server automation
- IP allowlisting available on Enterprise plans
Data domains
Integrations typically exchange one or more domains: shipments and legs, milestones, documents and metadata, parties, exceptions, and financial accruals. Map fields during connector setup or via transformation middleware.
Idempotency
Use stable external IDs when pushing shipments via API. Orbex Data upserts on external_id to prevent duplicates when retries occur.
Environments
Production API base URL is https://api.orbexdata.com/v1. Sandbox tenants are available for development and UAT—request access from your account team. API keys are environment-scoped and must not be shared across production and sandbox.
Separate credentials
Never point production TMS jobs at sandbox keys or vice versa. Webhook endpoints should likewise be environment-specific.
Implementation support
Standard plans include self-serve connector setup and API documentation. Enterprise customers receive integration workshops, custom field mapping, and dedicated technical account management during go-live.
