Build with ABF trade services
Integration guides, API references, and webhook documentation for the Cargo Status API and Event Subscriptions.
Getting started
What is the ABF Trade Portal?
Platform overview, the two integration methods (Event Subscriptions and Cargo Status API), and what each is best for.
How to get access
Digital Identity setup, Access Manager roles, and certificate issuance — the sequence your IT team needs before a developer can connect.
Event subscriptions
Receive cargo status changes automatically via webhooks
What are event subscriptions?
What webhooks are, business value, and use cases.
Cargo status event schemas
Complete field-level payload documentation for CSA events.
Response requirements
HTTP response expectations, timeouts, retry behaviour.
Troubleshooting webhooks
Common issues, testing, monitoring, and solutions.
Cargo status webhook reference
Formal schema for the cargo status webhook payload (OpenAPI 3.1.0).
Cargo Status API
Query cargo status on demand via REST API
What is the Cargo Status API?
On-demand cargo status queries, comparison with event subscriptions.
Planning your integration
How to scope the work: authentication and API as independent integration tracks.
Authentication onboarding
Certificate setup, client registration, and environment access.
Authorisation service integration
OAuth 2.0 mTLS token exchange and credential management.
API integration guide
Endpoints, request parameters, response handling, and search patterns.
Troubleshooting API errors
HTTP error responses, causes, and resolution steps.
Cargo Status API reference
Formal schema for the Cargo Status API endpoints (OpenAPI 3.0.2).