API CATALOGUE
There are two interfaces available in Trade Data API Services which deliver Cargo Status Advice data from the Integrated Cargo System:
Compare the interfaces
| Cargo Status API | Event Subscriptions |
|---|
| How it works | Your software asks for data and Home Affairs replies | Home Affairs sends data and your software receives it
|
|---|
| Pattern | Request-response (pull) | Webhook (receive push) |
|---|
| Best for | - user-initiated lookups
- scheduled reconciliations
- operational status checks.
| - operations dashboards
- near real-time event processing
- customer notifications.
|
|---|
Terms of Use
The Terms of Use outline legal requirements, security obligations, and usage conditions for accessing the Trade Data API Services. These Terms of Use are governed by, and are to be construed in accordance with, the laws in the Australian Capital Territory.
The Terms of Use may change. It is the responsibility of the organisation to ensure they are compliant with the Terms of Use.
View the Department of Home Affairs – Trade Data API Services Terms of Use.
More information
View What are event subscriptions? for developer documentation on the webhook interface, including:
- endpoint requirements
- event types
- details about how it works alongside existing Electronic Data Interface feeds.
View
What is the Cargo Status API? for developer documentation on the query interface, including:
- authentication
- how to make API calls.
Support
You can email
tradeapi@abf.gov.au for help with:
- onboarding
- integration
- production issues.
Related services
For information on Department of Agriculture, Fisheries and Forestry (DAFF) APIs, refer to the
DAFF Developer Portal.