AUSTRALIA POST

User Guide

Overview

This extension can only be used for shipping from Australia.

Australia Post provides reliable and affordable postal services to individuals and businesses in Australia. It provides a wide range of powerful domestic and international delivery tools, services and solutions that grow with your business. Australia Post will help you sell online, target the right customers and delight them with every delivery.

Our Australia Post shipping extension for Magento 2 has been built by our Magento experts to be as flexible as possible. Our extension allows our store to calculate an accurate shipping cost for delivery your customer's orders through Australia Post. The extension uses the Australia Post Postage Assessment Calculator (PAC) API to get live shipping rates in real-time.

Australia Post PAC API

Australia Post provide an API called the Postage Assessment Calculator (PAC) to calculate postage of domestic and international deliveries. Access to the PAC API is available for free and does not require any additional charge.

Points to Note

• An API Key for accessing Australia Post's PAC API is required. Register for a free API key here: https://developers.auspost.com.au/apis/pacpcs-registration

• Please be aware of Australia Post's shipping guidelines regarding size and weight: http://auspost.com.au/parcels-mail/size-and-weight-guidelines.html

• Australia Post has a weight limit of 22kg and 20kg for domestic and international shipping respectively. If the order exceeds the maximum weight, the extension will divide the order in multiple packages of equal weight and size.

• It is recommended to set the weight and dimensions for all products in the backend.

Installation

Please refer to the Installation Guide on how to install this shipping extension on your website.

Configuration

Required Information Before Configuration

Before configuring this shipping extension, you will need a valid Licence Key for using the extension and the Australia Post API key for accessing the Postage Assessment Calculator.

You will also need to configure the Shipping Settings (Stores > Configuration > Sales > Shipping Settings) to set the postcode from where your orders will be despatched. See image below for an example.

Licence Key

See the Reference Manual on how to obtain your Licence Key.

Accessing the Configuration

After installing the module, you can configure the extension by following these steps:

• Go to Stores > Configuration > Sales > Shipping Methods • Click on the ‘Australia Post’ shipping methods to expand the view

Configuration Fields

The following explains the purpose of each field with the configuration section.

• Enabled – set to ‘Yes’ to activate the extension. To disable the extension set to ‘No’.

• Licence Key – please the Reference Manual on how to obtain your Licence Key. A valid

Licence Key is required when the ‘Enabled’ field set to ‘Yes’.

• Title – this is the Title of the shipping method which will appear in the checkout

process.

• Australia Post API Key – this will be provided to you when you register for Australia

Post PAC.

• Domestic Letter Services – select the domestic letter services you use to ship your

products to your customers. You can select multiple services by holding down the Ctrl/Cmd key and clicking on the required service.

• Domestic Parcel Services – select the domestic parcel services you use to ship your

products to your customers. You can select multiple services by holding down the Ctrl/Cmd key and clicking on the required service.

• Domestic Options Allowed – select the domestic options you use to ship your

products to your customers. You can select multiple services by holding down the Ctrl/Cmd key and clicking on the required service.

• Domestic Sub-Options Allowed – select the domestic sub-options you use to ship your

products to your customers. You can select multiple services by holding down the Ctrl/Cmd key and clicking on the required service.

• International Letter Services – select the international letter services you use to ship

your products to your customers. You can select multiple services by holding down the Ctrl/Cmd key and clicking on the required service.

• International Parcel Services – select the international parcel services you use to ship

your products to your customers. You can select multiple services by holding down the Ctrl/Cmd key and clicking on the required service.

• International Options Allowed – select the international options you use to ship your

products to your customers. You can select multiple services by holding down the Ctrl/Cmd key and clicking on the required service.

• Default Package Length – set the length of your smallest shipping package (in cm).

• Default Package Width – set the width of your smallest shipping package (in cm).

• Default Package Height – set the height of your smallest shipping package (in cm).

• Handling Fee – if you want to charge a handling fee on top of the shipping rate

charged by TNT, set it here. Leave blank for not adding a handling fee. Please enter numbers only (without currency symbol).

• Handling Type – Choose if the handling fee is a Fixed amount or a Percentage of the

shipping rate.

• Show Method if Not Applicable – set to ‘Yes’ if you want to display error messages to

the customer is the shipping rate cannot be calculated (recommended).

• Error Message – set the error message to display if TNT ExpressConnect cannot be

reached.

Product Weight

The final step is to set the weight of all your products so that the extension can calculate the shipping rates. If the weight of the products is not entered, then Australia Post will calculate the cubic weight from the dimensions of the product (if set, otherwise the default dimensions will be used).

Enter the package weight of each item as the product weight (not the weight of the item

without packaging).

To enter the weight for a product, go to Products > Catalog from the admin interface and edit the desired product. Set the weight of the shipping package for the product in the Weight field and ensure that the dropdown option ‘This item has weight’ is selected.

Product Dimensions

If you have dimensions set for your products, the extension will use the product’s dimensions. Otherwise, the extension will use the default dimensions set in the configuration (default

height, default width, and default length). The attribute code for the product’s dimensions

should be ‘width’, ‘length’, and ‘height’.

For Magento 2.2.6 and above, the extension can also use the attributes with codes

ts_dimensions_width , ts_dimensions_length , and ts_dimensions_height , if they are

available.

Support

If you have any issue with the extension, please contact us at:

support@magextensions.com.au

Please provide the following information so that we can check the issue:

• Site’s URL • Admin URL • Admin username and password • FTP host, port, username and password

We endeavour to fix all issues within 48 hours.