Skip to main content

​
TypeScript SDK

Trailflow maintains a typed TypeScript SDK generated from the canonical OpenAPI contract. The SDK covers the same public surface documented in this portal:
  • loads
  • tracking
  • customers
  • carriers
  • webhooks
The generated client lives in this repository at packages/partner-api-sdk/ and is validated as part of the Partner API release gate.

​
When to use the SDK

Use the SDK when your integration team wants:
  • typed request and response shapes
  • consistent header handling for bearer auth and idempotency keys
  • a maintained wrapper around the canonical Trailflow contract
Use raw HTTP if your environment or language already has a stronger in-house API client pattern.

​
Tooling posture

The SDK, Mintlify reference docs, and webhook examples all derive from the same canonical OpenAPI file. Trailflow does not document multiple competing contracts.

​
Interactive API playground

The hosted Mintlify API playground proxies requests for the interactive reference experience. Treat it as a test-key-only tool. Do not use live Partner API keys in the playground unless Trailflow has explicitly approved that workflow for your org.

​
Support expectation

If your team wants SDK-based onboarding help, include the customer organization, environment, and expected workflow when you contact Trailflow. That makes it easier to align scopes, idempotency strategy, and webhook rollout before live traffic begins.