Skip to main content

​
What the Partner API covers

Trailflow’s Partner API is a partner-approved, server-to-server HTTP surface for operational logistics integrations. It is designed for external systems that need predictable access to core Trailflow records without depending on internal Convex functions or staff-only workflows. Current public capabilities:
  • load creation and upsert flows
  • load lookup and incremental polling
  • status updates
  • customer and carrier lookups
  • tracking visibility reads
  • webhook subscription management

​
How the platform is organized

The published Partner API combines three layers:
  1. overview and onboarding guidance for approved partners
  2. operational guides for authentication, sync, retries, and webhooks
  3. OpenAPI-backed endpoint reference for request and response details
Use the guides for workflow decisions and the API reference for exact schema requirements.

​
Resource model

The canonical v1 resources are Trailflow-owned and partner-agnostic:
  • loads
  • tracking
  • customers
  • carriers
  • webhooks
Partner-specific field translation belongs in Trailflow-managed adapters rather than the core public contract.

​
Request and response conventions

Operational rules that apply across the Partner API:
  • all routes use HTTPS and JSON
  • authenticated routes require Authorization: Bearer <api key>
  • write routes require Idempotency-Key
  • successful and failed authenticated responses include requestId
  • the API is additive-first inside v1

​
Typical integration path

A new partner integration usually follows this flow:
  1. confirm access and receive test credentials
  2. make a first authenticated request against GET /v1/loads or GET /health/api
  3. implement load polling or upsert flows
  4. add webhook subscriptions if push delivery is needed
  5. validate retries, request tracing, and partner-side support playbooks
  6. request live access after UAT signoff