EasyStore integrates with Australia Post, one of the most popular shipping carriers in Australia. This integration enables merchants to offer it as a reliable shipping option at checkout. After setup, they can manage shipping rates and generate shipping labels directly from EasyStore.

Before You Begin

To integrate Australia Post, ensure you have the following:

• An active Australia Post merchant account
• API credentials (API Key for both Live and Test modes)
• Shipping regions configured in EasyStore

Adding Australia Post As Your Shipping Carrier

1. Log in to your Joomla Dashboard and navigate to Components > EasyStore > Settings > Shipping.
   
   

   

2. If your region is already set up, click the three-dot icon next to it and select Edit. If you haven't set up your regions yet, you'll need to configure them first before you can add any shipping carriers.
   
   

   

3. Scroll down to the Add Shipping Carrier section and click on the Add Carrier button to open the list of available shipping providers.
   
   

   

4. Locate Australia Post in the list and click the Add button.
   
   

   

5. After completing the setup, click the "Back to the list" button. Australia Post will now be added to your store’s available shipping options.
   
   

   

Enable the toggle switch to make Australia Post visible as a shipping option on the checkout page. 

Note: For the shipping carrier to appear at checkout, make sure your Store Address in General Settings is complete and includes the correct Country and ZIP Code.

Configuring Australia Post Shipping Carrier

After adding Australia Post as your preferred shipping carrier, locate it in the list and click the "Setup" button next to it.

This will open a pop-up window where you can configure the Australia Post settings for smooth integration with your store’s shipping process.

Title

Give your integration a title (e.g., "Australia Post"). This is a user-defined title that helps you identify this integration within your Joomla Dashboard.

Environment

Choose either "Live" or "Test" mode based on your needs. Select "Live" to process actual shipments in a production environment, or "Test" to simulate shipping for setup and testing purposes.

Test/Live API Key

Insert your Live or Test API Key that you received while creating your Australia Post account.

Origin Country

By default, the origin country is set to Australia. However, you can choose to change it depending on where you are shipping from.

Origin Postcode

Choose the default origin postcode. This is the postcode of the region from which you are operating or shipping.

Enable Domestic 

Enable or disable domestic shipping within Australia.

Enable International

Enable or disable international shipping from Australia to other nations.

Default Package Weight (kg)

Set the default package weight.

Default Package Length (cm)

Set the default package length.

Default Package Width (cm)

Set the default package width.

Default Package Height (cm)

Set the default package height.

After configuring the Australia Post shipping carrier, click "Save and Close" to apply and save your changes.

Displaying Australia Post as the Shipping Method on the Checkout

Once Australia Post is selected as the shipping carrier, customers will be able to choose the shipping method based on the available services.

For the Australia Post shipping option to appear on the checkout page, customers must select a destination country that is within Australia Post's service area. If a country not supported by Australia Post is chosen, the shipping method will not be displayed. This ensures that only valid and applicable shipping options are shown based on the customer's selected location.

For example, if a customer selects Melbourne as their city and enters the zip code 3000, the available pickup points corresponding to that location will be displayed in the pickup point list. 

Please note that for Australia Post to appear as a shipping method during checkout, customers must select a city and provide a valid zip code.

How To Get API Key, Secret Key, and Account Number

To get your Client API Key, Secret Key, and Account Number, you will need to head over to the official Australia Post Developers website and sign up for a DHL account or log in to an existing account. Then, you will have to follow the given steps:

• Go to the Australia Post Developer Centre and navigate to APIs. 
• Under Shipping and Tracking, click on Register for a key. 
• Click Complete Registration and fill up the required details. Enter your account numbers, such as your Australia Post eParcel account or StarTrack account. Click Next.
• Fill up the next steps as instructed, such as entering your state/territory. Once you are done, you will need to wait for approval for your API keys, and you will be notified via email.

To learn more about how to acquire your API credentials, please refer to the official Australia Post documentation.