Overview

This developer guide shows how to access Australia Post / Star Track shipping API. See also the list of required API credentials / keys for Australia Post integration.

Australia Post supports two types of Integrations.

MyPost Business
eParcel

AfterShip Shipping currently supports eParcel integration, which is for more than 2,000 parcels a year contract.

Get Australia Post Developer Credentials

Setup a Developer Centre account by visiting this link.
Note: If you are already registered or have a MyPost account, please log in using your existing credentials.
Register for the Shipping and Tracking APIs by visiting this link.

Click on the Register your interest today link.
Ensure you specify your account number(s), separated by commas (you can specify a large list in the comments field in the last step).
If you are adding account(s) to an existing key, please specify this including the key you wish the account(s) to be added to, in the comments field in the last step.
Specify your platform partner in the second step of the registration process. Select Postmen (AfterShip) from the list.

3. Wait for confirmation email and then follow the steps as provided

If you encounter any issues, please contact Australia Post Lodgement Support team .

Required Australia Post API credentials

Credentials	Environment	Description
`account_number`	Sandbox / Production	Your Australia Post Shipper account number.
`password` (User Name)	Sandbox / Production	API credentials to access Australia Post XML service and Postmen API.
`api_key`	Sandbox / Production	API credentials to access Australia Post XML service and Postmen API.

Settings

Field	Description
Shipment Movement Type	Select B2B or B2C based on your account type. If you're shipping bulk B2C shipments with your own tracking number/label/SSCC/barcode, please select B2B .

B2B Shipment Notes

Ensure to include the required info for B2B or bulk B2C shipments with your own tracking number/SSCC/barcode

Use order_number field to present your own tracking number.
Use parcels.description field to present SSCC and barcode with this format: "SSCC:${SSCC} Barcode:${barcode}". The barcode value should be exactly the same as your own draft shipping label.

Example request payload:

"order_number": "${your_own_tracking_number}",
...
"parcels": [
    {
        "box_type": "custom",
        "dimension": {
            "width": 63,
            "height": 31,
            "depth": 124,
            "unit": "cm"
        },
        "description": "SSCC:${SSCC} Barcode:${barcode}",
        "items": [
            {
                "description": "product",
                "quantity": 1,
                "price": {
                    "currency": "USD",
                    "amount": 100
                },
                "weight": {
                    "unit": "g",
                    "value": 500
                }
            }
        ],
        "weight": {
            "unit": "g",
            "value": 500
        }
    }
]

2. No shipping label is generated for B2B shipments.

Registering for an API Key

Log in to the Australia Post Developer Centre using your existing login details and submit your request on the registration page .
If you don’t have a Developer Centre account, you can easily sign up using your current email address. After accepting the terms and conditions, log in and submit your request on the registration page.

We recommend reading the Getting Started guide before requesting your API Key.

FAQ

1. Why am I getting the "Unauthenticated request: The request failed authentication" error?

The credentials provided from the Australia Post system appear to be incorrect. We recommend contacting the carrier directly to verify the correct credential details. The required credentials are: Account Number , Password , and API Key .

Please also review the instructions from Australia Post below:

Australia Post Developer Resources

Read Australia Post docs
Supported Australia Post service types and service options
AfterShip Shipping Australia Post technical support: [email protected]

Australia Post Developer Guide and API Credentials