Loading
​ 

Trade Data API Services

Cargo Status API​​​​​​​

The Cargo Status API is a request-response interface, meaning your software asks for data and Home Affairs replies. It is for querying air and sea cargo status data from the Integrated Cargo System.

Use the Cargo Status API when an organisation’s software needs to look up cargo status on demand. To react to status changes automatically, see Event Subscriptions.

Use cases​​​

  • User-initiated lookups, such as when a client enters a consignment reference.
  • Scheduled reconciliation against your operational records.

Software requir​​ements

To integrate, your software needs to authenticate to Home Affairs using OAuth 2.0 with mutual TLS (mTLS). Home Affairs issues your software a Client ID backed by a machine certificate (a RAM Machine Credential or DigiCert Gatekeeper certificate) registered in Access Manager.

Compatibility with Elect​​ronic Data Interchange (EDI)

The Cargo Status API is complementary to your existing Electronic Data Interchange (EDI) feeds. Adding the API channel will not affect your existing EDI feed. Both can be run in parallel.

Start u​​​sing Cargo Status API

  1. View ​Cargo Status API (OpenAPI 3.0). This has information on every operation, parameter, and response in an interactive viewer.
  2. View the Cargo Status API developer guide. This has step-by-step setup, authentication, and request pattern information.
  3. Contact tradeapi@abf.gov.au to request the mock server and Postman collections. Include your:
    • organisation name
    • ABN
    • primary contact details
    • brief description of the integration plan.

Supp​​ort

Email tradeapi@abf.gov.au for help with:

  • developing
  • testing
  • integrating new channels.

​