README

Australia Post for glitchr/omnibus: prices, shipments with their labels, tracking and cancellations - the Shipping and Tracking API (basic auth with the API key, the charge account in a header).

$gateway = (new AuspostGatewayFactory($http))->create($options);   // $http: the application's HTTP client - none given, the factory makes its own; the options below

No framework needed: the package requires glitchr/omnibus and symfony/http-client. In a Symfony application, the same through the bundle's configuration:

omnibus:
    gateways:
        auspost:
            factory: auspost
            options:
                api_key: '%env(AUSPOST_API_KEY)%'
                password: '%env(AUSPOST_PASSWORD)%'
                account_number: '%env(AUSPOST_ACCOUNT)%'   # the 10-digit charge account
                sandbox: true
                rates: [...]                               # optional: configured prices instead of /prices/items

The service is the product id (PP Parcel Post, EXP Express Post, PTI8 International Standard, ECM8 International Express...). Shipment options: sender_state and recipient_state (VIC, NSW...), authority_to_leave, layout (A4-1pp, A4-4pp, THERMAL-LABEL-A6-1PP), description and classification (customs). No pickup points: parcel lockers and post offices are addressed as recipient addresses.

Credentials: a business account with a charge account, then the Shipping and Tracking API at developers.auspost.com.au gives the key and password (test credentials first).

Built from Australia Post's published API documentation and tested on recorded answers; not yet run against the test environment: that needs the credentials above.

Responsibility

This package is an independent, unofficial client: it is not affiliated with, endorsed by or sponsored by Australia Post (the Australian Postal Corporation). It reaches their service on behalf of whoever runs it, and it does not redistribute their data beyond the short excerpts recorded as test fixtures. Its MIT licence covers this package's code only and grants no right to the service or to its data.

Whoever installs and runs this package is responsible for complying with Australia Post's terms (API Licence Terms of Use), for obtaining whatever they require (an account, a key, a licence or subscription, an attribution or a citation, a rate limit to respect), and for any use made of what it returns. The authors publish it free of charge, make no commercial use of it, and accept no liability for how it is used (see LICENSE).

License: MIT since 2026-10-09; earlier versions remain published under LGPL-3.0-or-later.

omnibus / auspost

Package info

Security

Statistics

README

Responsibility