Documentation
Setup guide
Set up and test Australia Post rates before using them with customers. The same steps apply to Lite and Pro; Pro settings are marked.
New here? Check your fit and use the first-quote checklist.
1. Install the plugin
- Download the ZIP: Lite from this site, or Pro from the link in your purchase email.
- In WordPress go to Plugins › Add New › Upload Plugin, choose the ZIP and click Install Now, then Activate.
- Pro only: go to WooCommerce › Settings › Shipping › Ratehaul and paste the licence key from your purchase email. The plugin checks the key with our licence service (it sends the key only, not your site URL). One key covers one site, or five for the 5-site licence, under the licence terms.
WooCommerce must be active. If you run Lite and later buy Pro, install Pro and deactivate Lite; your settings carry over.
2. Get a free PAC API key
Australia Post's Postage Assessment Calculator (PAC) API is free and does not need a business account.
- Go to developers.auspost.com.au/apis/pacpcs-registration.
- Fill in the registration form. Australia Post emails you an API key.
- In WooCommerce go to Settings › Shipping › Ratehaul and paste the key into PAC API key. Save.
Keep the key private. It is stored in your WordPress database and is only ever sent from your server to Australia Post. See the PAC key guide for more detail.
3. Enter your origin postcode
Enter the postcode you post from. Australia Post prices by distance between zones, so a wrong origin postcode gives wrong prices everywhere. If you post from more than one place, use the one you use most.
4. Set a default box
Enter the inside dimensions in centimetres and the maximum weight in kilograms of the box you use most. Lite packs every order into this one box by weight. Pro lets you add more presets under Box presets and will pick the smallest one the order fits in.
Also set a fallback flat rate above $0. This is what customers see if Australia Post's API is down or returns nothing. Pick a figure you can actually post for. The default of zero turns the fallback off, so customers see no shipping option at all; it does not mean free shipping.
5. Add product weights
Every product needs a weight. Edit each product, open Shipping in the Product data box and enter the weight in the unit set under WooCommerce › Settings › Products. Dimensions are optional in Lite and used by Pro's box packer when present.
Variable products: set the weight on each variation, or on the parent so variations inherit it. A product with no weight is packed at zero, which gives a cheaper rate than you will pay.
6. Test at the cart
- Add a product with a weight to the cart.
- Use the shipping calculator at the cart (or go to checkout) and enter a postcode well away from yours, for example a different state.
- You should see Parcel Post and Express Post with prices. Check one against Australia Post's postage calculator using the same weight and box.
- Pro: try a cart that fits a satchel and confirm the satchel price appears.
Troubleshooting
No rates showing
Work through these in order. Each one accounts for most cases we see.
- API key. Copy the key again from Australia Post's email with no spaces at either end and save. A wrong key returns no rates and the fallback flat rate appears, if you set one.
- Postcode. The origin postcode must be a real Australian postcode. The customer's postcode must match the state and suburb they entered; WooCommerce passes exactly what they typed.
- Weights. A cart with a total weight of zero returns nothing from Australia Post. Check every product in the test cart has a weight. Also check the parcel is under 22 kg and the longest side is under 105 cm, which are Australia Post's parcel limits.
- Cache. Pro caches quotes. After changing settings, clear the cache from the Ratehaul settings page (and any page or object cache on your host) before testing again.
- Shipping zone. Ratehaul must be added as a method inside the WooCommerce shipping zone that covers the destination. Check WooCommerce › Settings › Shipping › Zones.
Rates look too cheap or too dear
Compare against Australia Post's calculator using the same origin, destination, weight and box. Lite quotes retail prices; if you pay less through MyPost Business, use Pro's markup (a negative percentage is allowed) or the satchel table to reflect what you pay.
Only the fallback rate shows
The API did not answer or returned no services. Usually the key or a zero weight. The plugin logs the last API response under WooCommerce › Status › Logs, source ratehaul.
Still stuck
Email support with your WooCommerce version, a screenshot of the Ratehaul settings page (hide the API key) and the postcode you tested with.
Settings reference
| Setting | Tier | What it does |
|---|---|---|
| PAC API key | Lite, Pro | Your Australia Post PAC key. Required for any live rate. |
| Origin postcode | Lite, Pro | Where you post from. Must be a valid Australian postcode. |
| Enabled services | Lite, Pro | Parcel Post and Express Post. Pro adds international services. |
| Default box | Lite, Pro | Length, width, height (cm) and maximum weight (kg) of the box used when nothing better matches. |
| Fallback flat rate | Lite, Pro | Amount shown if the API does not respond or returns no rates. Zero (the default) turns the fallback off. Set to a figure you are willing to post for. |
| Box presets | Pro | Additional boxes. The packer picks the smallest preset the order fits in, or splits into several. |
| Prepaid satchel table | Pro | Your satchel sizes (for example 500 g, 1 kg, 3 kg, 5 kg) and the price you charge for each. Shown instead of a calculated rate when the order fits a satchel. |
| Signature on Delivery | Pro | Offer the add-on as a checkout option or include it in every rate. |
| Extra Cover | Pro | Offer the add-on as a checkout option or include it, based on cart value. |
| Handling fee | Pro | Fixed amount added to each rate. |
| Markup % | Pro | Percentage added to each rate. Can be combined with the handling fee. |
| Delivery estimate text | Pro | Text shown under each service, for example "2โ4 business days". |
| Service names and visibility | Pro | Rename any service as the customer sees it, or hide it. |
| Rate cache | Pro | How long a quote for the same parcel and destination is reused before asking the API again. |
Labels in the plugin may differ slightly between versions.