Loqate Harmony Documentation
Ask or search…
K

Woocommerce Settings guide v2.0.0

How to configure the settings Loqate AU NZ Woocommerce Plugin. You have full control over what is enabled with full access to API settings.
Version: 2.0.0
Navigate to Plugins and click on settings... /wp-admin/plugins.php and find 'Loqate AU & NZ Address' plugin

Step 1: Get your API Keys

Get your Loqate AU NZ API Keys from https://hosted.mastersoftgroup.com/console/#/login
We wrote a guide for getting your API keys.
If you don't have a Loqate AU NZ account sign up here to free trial: https://www.loqate.com/anz/register/

Step 2: Add your API Keys to Woocommerce V2 Plugin

Navigate to Plugins and click on settings... /wp-admin/plugins.php and find 'Loqate AU & NZ Address' plugin
Your API key is concatenated {user name}:{password}.
For example if
User Name = 'myuser' and password ='mypassword' then you enter myuser:mypassword. Don't forget the semi colin :
Alright you should be all set to start using using our default performance checkout settings.

Optional Settings

Address Layout Options

Address Layout modifies your checkout experience for your users. We have two options available Optimised or Default.
Optimised being single line address. This hides 5 address fields and shortens your overall checkout form. Its the recommended setting.
Insert the below code block for Optimised
{ "layout": "DEFAULT" }
Default is Woocommerces standard checkout.
Insert the below code block for Default
{ "layout": "DEFAULT" }

Checkout experience

Address FeatureOptions

Address FeatureOptions is the API settings for our Address Lookup service. Our Address Lookup has a broad range of feature that you can optimise for your application.
All of these settings we can configure for you in the backend meaning you don't have to update these settings yourself.

Default setting

This shows 5 results, in Title Case and suppresses Lot information when street numbers are available.
{ "singleLineHitNumber": 5, "caseType": "TITLE", "displayGnafLot":1,"suppressLot":1 }

Add User Derived Address:

Learn about User Derived Address
{ "userInferred": 1, "singleLineHitNumber": 5, "caseType": "TITLE", "displayGnafLot":1,"suppressLot":1 }
Grouping addresses particularly in countries with large populations in multi dwelling premises. Recommended setting.
We don't apply grouping to AU & NZ country searches.
{ "groupAddresses": "1", "singleLineHitNumber": 5, "caseType": "TITLE", "displayGnafLot":1,"suppressLot":1 }

Add AustPost Parcel Locker data

This will include Australia Post parcel lockers, post offices and post shops to delivery selection options.
{ "moreSources": "AUPOST", "singleLineHitNumber": 5, "caseType": "TITLE", "displayGnafLot":1,"suppressLot":1 }

Add them all

We've only list some of the available featureOptions.
{ "userInferred": 1, "groupAddresses": "1", "moreSources": "AUPOST", "singleLineHitNumber": 5, "caseType": "TITLE", "displayGnafLot":1,"suppressLot":1 }

Address Data - Australia

Within Australia we have 3 datasets the you can use. Choosing the right dataset is critical. Contact us for advice.
AUPAF: Australia Post Postal Address File (Postal Certified)
GNAF: Geocoded National Address File (Physical addresses)
AUSOTS: Combined AUPAF & GNAF for highest coverage.
// for GNAF
{ "sot": "GNAF" }
// for Australia Post
{ "sot": "AUPAF" }
// for Australia Post & GNAF combined
{ "sot": "AUSOTS" }

Address Data - New Zealand

Within New Zealand we have 3 datasets the you can use. Choosing the right dataset is critical. Contact us for advice.
NZPAF: New Zealand Posts - Postal Address File (Postal Certified deliverable)
NZAD: New Zealand Posts - Address File (Physical addresses)
CNAR: Critchlow / National Map is Physical address file with improved Geocoding results.
// for New Zealand Posts - Postal Address File (Postal Certified deliverable)
{ "sot": "NZPAF" }
// for New Zealand Posts - Address File (Physical addresses)
{ "sot": "NZAD" }
// for Critchlow / National Map
{ "sot": "CNAR" }

Enhanced State/County/Region

Loqate is a global address experts.
Ticking this box overrides Woocommerce representations of regional information and uses Loqates comprehensive collection of state/county/region or the equivalent.
For some regions syncing of Loqate data with Woocommerce lists of regions is not always possible. Enabling will overwrite with Loqate data.

Business Lookup

Enable or disable the Business Lookup service. Business Lookup enables users to search for the business names, business or company numbers within the company field in checkout.
In checkout, reduce time in checkout, accurately capture business customers, know your business identifiers.

Checkout experience

Filter for Active Businesses

{
"caseType": "TITLE",
"hits": 5,
"taxStatus": "ACT",
"bnStatus": "",
"state": [],
"nameTypes": []
}

Filter for Active Businesses & Active tax registration

{
"caseType": "TITLE",
"hits": 5,
"taxStatus": "ACT",
"bnStatus": "ACT",
"state": [],
"nameTypes": []
}

Filter by State

If only conducting business in a particular state you can filter your results.
{
"caseType": "TITLE",
"hits": 5,
"taxStatus": "",
"bnStatus": "",
"state": ["VIC", "NSW"],
"nameTypes": []
}
Main/legal entity name which might be different from the entity's alias name entered by user.
For example: You might know McDonalds the brand or a 'trading name'. Legal entity name is different and this option changes the information being displayed to legal entity names.

Email Validation

Enable or disable the Email Validation within the checkout experience.

Checkout experience

This displays the result of the validation to the end user. Results that are valid or indeterminate can proceed to the next step. Invalid email addresses are alerted within checkout enabling users to correct any issues they have.

Default Email Options

We recommend you keep the default configuration.
{ "sot": "VE_ALL", "options": [ "FORMAT", "BLOCKLIST", "DOMAIN", "MAILSERVER", "MAILBOX" ] }

Phone Validation

Enable or disable the phone validation.
Like email validation phone displays the result of the validation to the end user. Results that are valid or indeterminate can proceed to the next step. Invalid phone numbers are alerted within checkout enabling users to correct any issues they have.