Alex Kebbell

For further information on the CouriersPlease plugin for WooCommerce click here.

Installation

  1. Upload the plugin folder to the “/wp-content/plugins/” directory.
  2. Activate the plugin through the “Plugins” menu in WordPress.
  3. That’s it – you can now assign the CouriersPlease method to a shipping zone.

 

Configuration

Registration with CouriersPlease is required. If you are an existing account customer please register here – mention the WooCommerce plugin and that you require an API key in the comments. The plugin will automatically obtain your rates.

1. Once the plugin has been activated, assign the Couriers Please shipping method to a shipping zone.
2. The method will be listed at the top of the screen, underneath the tabs. Click on “CouriersPlease”.
3. You can now configure the method. Enable/Disable – Choose whether to enable the shipping method of not.

  • Couriers Please Account Number – Account / customer code. Must be a valid CouriersPlease customer code.
  • Couriers Please API Key – Must be a valid CouriersPlease API Key.
  • Couriers Please Test API Key – Must be a valid CouriersPlease Test API Key. Test mode must be enabled below to use.
  • Origin Suburb / Suburb – This should be set to the city / suburb from which you will ship.
  • Origin State – This should be set to the state from which you will ship. This should be in capitals (e.g. NSW, VIC etc).
  • Origin Postcode – This should be set to the postcode from which you will ship.
  • Handling Charge Type – Select either a percentage or flat rate to add onto the returned shipping costs.
  • Handling Charge – Enter the value of this percentage or flat rate. (e.g. 5, 10, 15, 20) – no symbols.
  • Display ETA – Optional display of the ETA as provided by CouriersPlease.
  • Handle GST Locally – If enabled, GST will be excluded from the returned total. If disabled, GST will be included.
  • Quotes to display – Select whether you’d like all available quotes returned or the cheapest option only.
  • Debug mode – Display API request and response information. Useful for debugging with support (please provide a copy).
  • Test mode – Utilises the CouriersPlease Test API server and API key (must be provided above).

4. Ensure your products are in the correct format. Make sure you have entered correct Weight and Dimensions.

5. Ensure that in WooCommerce -> Settings -> Shipping you have checked the box next to “Hide shipping cost until an address is entered”. The carrier requires an address, so cannot return a rate without one.

 

Displaying the calculated price on the cart page

Please note that many courier companies require a suburb (city) to perform their cost estimate. By default WooCommerce does not provide this option on the cart page which prevents this calculator from loading until the full address is provided in the checkout. It is possible to disable shipping calculation on the cart page via the WooCommerce Shipping settings. Alternatively, there are a number of workarounds including the snippet below which can be added to your theme’s functions.php file.

add_filter('woocommerce_shipping_calculator_enable_city','EnableCity');
function EnableCity() { return true;}