API v1 versioning
Stable partner routes are versioned under /v1. Breaking changes ship behind a new version; additive fields may appear without a version bump.
Integrations
API & integrations (by request)
Most shippers start with quote and dispatch coordination. High-volume programs can discuss API, webhook, and ERP integration paths with our team — documentation available for technical review.
Quick start
Three steps to your first call
Step 1
Read the partner guide
Authentication, base URLs, and API v1 core endpoints for quote → booking → track.
Step 2
Import Postman
Use the v2.1 collection with base_url, Bearer token (dev locally), and X-Api-Key for merchant-api.
Step 3
Create keys in merchant portal
Generate sandbox API keys, configure webhooks, and review rate limits per tier.
API host: porterchain.com — set NEXT_PUBLIC_PORTERCHAIN_API_URL for local (http://localhost:8001).
Documentation
Everything you need to integrate
Partner API guide
Canonical partner guide — authentication, versioning, quote-to-delivery flows, and production readiness.
Postman collection
porterchain.postman.json — quote, booking, merchant, driver, admin ops, and webhooks.
Live OpenAPI
Interactive /docs and machine-readable openapi.json — route truth for all environments.
Webhooks & HMAC
Outbound event signing, retry behavior, and merchant webhook configuration.
API keys & sandbox
Create scoped keys and toggle sandbox mode from the merchant integrations page.
API v1
Core integration paths
| Flow | Method | Path |
|---|---|---|
| Instant quote | POST | /v1/quotes |
| Create booking | POST | /v1/bookings |
| Public track | GET | /v1/orders/{tracking_number}/tracking |
| Merchant API | GET | /v1/merchant-api/orders |
API operations
Versioning, rate limits, and webhook expectations
Rate limits by tier
Default sandbox and Growth traffic is capped conservatively. Business and Enterprise programs receive higher limits after integration review.
Webhook delivery
Outbound events use signed payloads, retry windows, and merchant-level endpoints so downstream systems can reconcile delivery status.
Need a partner integration review?
Our team helps with scoping, sandbox keys, and webhook verification before you go live.