API Reference
The Orderly Hub API is a REST API built on Hono. All endpoints are under the /api/v1 prefix and require authentication.
Base URL: https://api.orderly-hub.com
Authentication
How to authenticate with the API using session tokens or API keys.
Errors
Error response format and common error codes.
Pagination
How list endpoints paginate results.
Endpoint Groups
| Group | Base Path | Scopes |
|---|---|---|
| Orders | /api/v1/orders | orders:read, orders:write |
| Shipments | /api/v1/shipments | shipments:read, shipments:write |
| Bridges | /api/v1/bridges | bridges:read, bridges:write |
| Bridge Types | /api/v1/bridge-types | bridges:read |
| Operations | /api/v1/operations | operations:read, operations:write, operations:execute |
| Dispatchers | /api/v1/dispatchers | dispatchers:read, dispatchers:write |
| Condition Sets | /api/v1/condition-sets | dispatchers:read, dispatchers:write |
| Transformations | /api/v1/transformations | transformations:read, transformations:write |
| Carrier Accounts | /api/v1/carrier-accounts | carrier-accounts:read, carrier-accounts:write |
| Rates | /api/v1/rates | rates:read |
| Pickups | /api/v1/pickups | pickups:read, pickups:write |
| Schedules | /api/v1/schedules | bridges:read, bridges:write |
| Split Rules | /api/v1/split-rules | orders:read, orders:write |
| API Keys | /api/v1/api-keys | Admin only |
| Organizations | /api/v1/organizations | Varies |
| Webhooks | /api/v1/webhooks | webhooks:manage |
| Agent | /api/v1/agent | agent:read, agent:write |
| Embed | /api/v1/embed | embed:manage |
| Insights | /api/v1/insights | insights:read |
| Tracking | /api/v1/shipment-tracking | shipments:read |
| Rate Comparisons | /api/v1/rate-comparisons | rate-compare:read, rate-compare:write |
| Locations | /api/v1/locations | locations:read, locations:write |