Skip to content
Log in

Australia Post shipping provider

On this page

Australia Post is a supported shipping provider in StoreConnect. At checkout, StoreConnect can retrieve live shipping rates from Australia Post based on the cart contents, the Stock Location address, and the delivery address. Once an order is ready to ship, StoreConnect can register the shipment with Australia Post and retrieve a tracking number. The registration carries the recipient’s details, delivery instructions, and dangerous goods flags, and can also carry a short description of the parcel contents for the label.

Configure Australia Post as a shipping provider

To use Australia Post, you need API credentials from an Australia Post Developer Account. Follow the instructions for setting up a production key to obtain your Key, Secret, and Account Number.

You apply for these credentials yourself, as the business that holds the Australia Post account. The application is for an integration between your business and Australia Post, not between StoreConnect and Australia Post, so complete it with your own business and account details.

Create a Shipping Provider record on your Store with the following values:

StoreConnect field Value
Provider Australia Post
Channel Web or POS or both
API URL digitalapi.auspost.com.au
API Environment test or production (see below)
API Key Key (username) from Australia Post
API Secret Secret (password) from Australia Post
Account Your 10-digit Australia Post charge account number

API URL and environment

Set the API URL to digitalapi.auspost.com.au. Do not include a protocol (e.g. https://) or a path (e.g. /test) in this field.

:::warning StoreConnect automatically appends /test to the URL when the API Environment is not set to production. If you manually include /test in the API URL, the system will send requests to an invalid double path (/test/test) and no rates will be returned. :::

The API Environment field controls which Australia Post environment is used:

  • Set to test (or leave blank) when using test credentials
  • Set to production when you are ready to go live with real shipments

Confirm with your Australia Post account provider whether the credentials they gave you are for the test or production environment, and set this field accordingly.

Set product shipping dimensions

For Australia Post to return shipping rates at checkout, every product in the cart must have all of the following fields populated:

Field Example value
Shipping Weight 2
Shipping Weight Unit kilogram
Shipping Length 30
Shipping Width 20
Shipping Height 15
Shipping Dimensions Unit centimeter

:::warning If any single dimension or unit field is missing on any product in the cart, no shipping rates will be returned. There is no error message displayed to the customer — the shipping options will simply be blank. :::

Set Australia Post as a product shipping method

Each product that you want to ship via Australia Post must have Australia Post selected in the product’s Shipping Methods field.

If Australia Post does not appear in the field, a new picklist value needs to be added for it, with the API Name australia_post.

Without this, StoreConnect will not query Australia Post for rates on that product.

Get Product IDs for shipment registration

Your Australia Post account has Product IDs associated with it (e.g. eParcel services). You need these to register a shipment as ready for collection. To get the applicable product codes for your account, query the Australia Post API.

Details sent with each shipment

When StoreConnect registers a shipment, it sends Australia Post the recipient, the items, and the details in the table below. A detail with no value is left out, and the shipment registers without it. A value longer than the limit is cut to fit.

Detail Where StoreConnect gets it Limit Sent on
Recipient address The address fields on the Shipment record 3 street lines of 40 characters All shipments
Recipient name Shipping Recipient Name on the Shipment record   All shipments
Business name The name of the shipment’s Ship To Account, when that account has Is Company checked 40 characters Domestic only
Delivery instructions Shipping Notes on the Shipment record, or on the Order 128 characters Domestic only
Dangerous goods Shipping Dangerous Goods? on each Product   Domestic only
Goods description The product names and quantities, once you turn it on 3 lines of 40 characters Domestic only

A shipment is domestic when the country on the Shipment is Australia, recorded as either AU or Australia. On an international shipment, StoreConnect sends the address, recipient name, and items only.

Recipient address and name

The label goes to the address recorded on the Shipment, so when an order splits into several shipments, each one goes to the address recorded on that shipment.

  • POS shipments use the address fields on the Shipment record.
  • Web shipments record the delivery address the customer entered at checkout on the Shipment record. A web shipment with every address field blank uses the shipping address on the Order instead.

If you edit an address on a Shipment record, be sure to fill in every address field. Partial addresses will be rejected by Australia Post.

When Shipping Recipient Name is blank, StoreConnect names the order’s ship-to contact (or the order’s contact) on a web shipment, and the shipment’s Ship To Contact on a POS shipment.

Business name

To print a company name on the label for business customers, check Is Company (s_c__Is_Business__c) on their Account record. When a shipment’s Ship To Account has Is Company checked, StoreConnect sends the account name as the business name, alongside the recipient name. For a personal account, no business name is included.

Web shipments get their Ship To Account from checkout. POS shipments get it when staff arrange the delivery.

Delivery instructions

StoreConnect sends the Shipping Notes on the Shipment record as delivery instructions, which print on the label. Staff enter these when they arrange a delivery at POS.

When the shipment has no notes, StoreConnect uses any shipping notes entered by customers on the Order at checkout. This requires shipping notes to be enabled. StoreConnect uses the order’s notes only when the order has a single shipment. On an order that splits into several shipments, StoreConnect does not send them.

Dangerous goods

If a shipment contains dangerous goods, the Shipping Dangerous Goods? (s_c__Shipping_Dangerous_Goods__c) must be indicated on the Product record. If a shipment is domestic, StoreConnect flags it as containing dangerous goods.

:::warning Special declaration for dangerous goods shipping internationally. Australia Post requires a separate air transport declaration if dangerous goods are being sent internationally. StoreConnect can’t manage the declaration process, this must be handled with Australia Post directly. :::

Australia Post can print up to three lines describing the parcel contents on an auxiliary label. The description can be automated from the StoreConnect products named on the shipment, but you first need to turn this function on in the Australia Post Shipping Provider record. Descriptions are added to domestic shipments only.

  1. Open the Australia Post Shipping Provider record.
  2. In the API Options field, add the goods_descriptions setting:

    ```yaml

    goods_descriptions: enabled: true ```

    If API Options already holds other settings, add goods_descriptions on a new line and keep the existing settings.

  3. (Optional) Under goods_descriptions, add max_items or include_quantity to change how the lines are built:

    Setting Default Effect
    enabled false true turns the goods description on
    max_items 3 The number of items to list, from 1 to 3
    include_quantity true true starts each line with the quantity, such as 2 x Ceramic Mug. false lists the product name only
  4. Click Save.

The next domestic shipment that StoreConnect registers carries the description. Whether the lines print depends on the label layout you use with Australia Post.

Each line is one item, built from the product name rather than the product code, because Australia Post recommends plain-language descriptions. When the shipment has more items than lines, the last line summarizes the rest. Lines longer than 40 characters are cut.

Example

A shipment holds four products: 2 Ceramic Mugs, 1 Tea Towel, 1 Teapot, and 4 Coaster Sets. With the default settings, the label shows:

```text

2 x Ceramic Mug 1 x Tea Towel +2 more items ```

Fields written to the Shipment record

At checkout (when the order is placed)

When the customer completes checkout, StoreConnect creates the s_c__Shipment__c record with the following fields already populated:

Salesforce Field API Name What it contains
Charge s_c__Charge__c The shipping amount charged to the customer, taken from the Australia Post rate selected at checkout
Provider s_c__Provider__c "Australia Post"
Provider Service s_c__Provider_Service__c The Australia Post product code name selected at checkout (e.g. the eParcel service name)
Status s_c__State__c waiting_for_packing
Shipping Street, Shipping City, Shipping State, Shipping State Code, Shipping Postal Code, Shipping Country, Shipping Country Code s_c__Shipping_Street__c and the other s_c__Shipping_ address fields The delivery address the customer entered at checkout. The state and country codes are filled when they match the store’s State and Country records
Ship To Contact s_c__Ship_To_Contact_Id__c The contact the order ships to, from checkout
Ship To Account s_c__Ship_To_Account_Id__c The account the order ships to, from checkout. Used for the business name
Shipping Recipient Name s_c__Shipping_Recipient_Name__c The ship-to contact’s name, or the customer’s name when the ship-to contact has none

After shipment registration with Australia Post

When StoreConnect lodges the shipment with Australia Post, the following fields are written back:

Salesforce Field API Name What it contains
Provider Shipment ID s_c__Provider_Shipment_Id__c The Australia Post shipment_id returned by the Create Shipments API
Tracking Code s_c__Tracking_Code__c The consignment ID — the customer-facing tracking number
Status s_c__State__c Updated to waiting_for_pick_up

:::note StoreConnect does not request shipping labels. If you need to generate labels, you can do this using the Australia Post API with the Provider Shipment ID (s_c__Provider_Shipment_Id__c) as the identifier. The Tracking Code (consignment ID) is the customer-facing tracking number and is not used for label requests. :::

Go live (test to production)

To switch from test mode to production, you need to submit the Technical Validation Form to Australia Post. You submit the form as your business: it validates the integration between your business and Australia Post. If you have Adobe Acrobat you can download and edit the form below:

You will need these JSON files for section 8 of the form:

Once approved, update the API Environment field on your Shipping Provider record to production.

Troubleshooting

If shipping rates are not appearing at checkout, check the following:

  1. API URL — Ensure the URL is digitalapi.auspost.com.au with no /test suffix and no https:// prefix
  2. API Environment — Confirm this matches the type of credentials you have (test or production)
  3. Product dimensions — Verify that every product in the cart has all six shipping fields populated (weight, weight unit, length, width, height, dimensions unit)
  4. Product shipping method — Confirm each product has Australia Post selected in the Shipping Methods field
  5. Stock Location — Ensure the Stock Location has a complete address including country and state ISO code

Use the Web Console on your storefront to inspect shipping API calls in real time. Open the Web Console, then attempt a checkout. You should see the outbound request to Australia Post and any error response. If no API call appears at all, the request was blocked before reaching Australia Post (typically due to missing product dimensions or shipping method configuration).

If a shipment registers but a detail is missing from the label, check the following:

  1. Business name — Confirm Is Company is checked on the Account in the shipment’s Ship To Account field
  2. Delivery instructions — Check Shipping Notes on the Shipment record. For web orders, confirm shipping notes are enabled and that the order has a single shipment
  3. Goods description — Confirm API Options on the Shipping Provider record has enabled: true under goods_descriptions
  4. Any of the above on an international shipment — StoreConnect sends these details on domestic shipments only

If Australia Post rejects a shipment for an incomplete address, open the Shipment record and fill in every address field.

Was this article helpful?

Was this article helpful?