README

Loqate AU NZ Address Autocomplete plugin for WooCommerce.

Performance Address lookup and validation for WooCommerce Checkout and Account Billing and Shipping Addresses, as well as checkout with Address lookup and validation, business lookup and validation, email and phone validation

For the up to date user guide please visit https://docs.mastersoftgroup.com/loqate-harmony-api/integrations/woocommerce-plugin/woocommerce-user-guide

Description

Turns your checkout into a performance checkout by saving the customer time in checkout, reduces failed deliveries, reduces failed contacts and builds trust. Powered by the most curated address and location data in the world. Loqate is the most advanced software for capturing, verifying and enriching address data globally - delivering the unrivalled precision businesses need.

Features:

Autocomplete billing and shipping address, business lookup, email and phone validation in Checkout page
Autocomplete address in My Account page for Customer's billing address and shipping address
Support for over 245 countries addresses, including AU, NZ, US, UK, CA etc
Flexible configurations for the lookup and validation depending on the business needs.

Get started with a FREE Trial licence key.

Installation

This plugin requires WooCommerce. Please make sure WooCommerce is installed.

Automatic installation

Automatic installation is not currently available.

Manual installation

Download the zip file of the latest release from GitHub.
Upload the zip file to your WordPress plugins directory by either:
- Upload the zip file using your WordPress Admin:
  
  Log in to WordPress Admin > go to Plugins > Add New > Upload Plugin button > upload the zip file
  
  OR
- Upload and unzip the zip file into your WordPress plugins directory: WP_ROOT/wp-content/plugins/. The WP_ROOT is usually /var/www/html/.

After installation, the WordPress plugins directory should include the woocommerce-mastersoft-address directory with the same file structure as the GitHub.

Composer installation

The plugin is also available for installation from Packagist.

Download and install composer:

$ curl -sS https://getcomposer.org/installer | php
$ mv composer.phar /usr/local/bin/composer

Install with composer by either:
- Create composer.json file in the WP_ROOT and add the mastersoft/woocommerce-mastersoft-address package. For example, to add woocommerce-mastersoft address v1.0.1.
```
{
    "require": {
        "mastersoft/woocommerce-mastersoft-address": "1.0.1"
    }
}
```
  Install the package:
  
  $ composer install
  
  OR
- Use extended composer command and install:
  
  $ composer require mastersoft/woocommerce-mastersoft-address:<version>
  
  The <version> is optional.

After installation, the WordPress plugins directory should include the woocommerce-mastersoft-address directory with the same file structure as the GitHub.

Updating an existing Composer installation

Update composer.json in your WordPress plugins directory with the version to be downloaded:

$ composer require mastersoft/woocommerce-mastersoft-address:<version> --no-update

Alternatively, you can also update the version of mastersoft/woocommerce-mastersoft-address package in the composer.json file by directly editing it.
Download and install the updated version of mastersoft/woocommerce-mastersoft-address:

$ composer update

Post installation

Activate plugin: log in your WordPress Admin > got to Plugins > Installed Plugins > scroll to Mastersoft Address plugin and click Activate
Configure plugin by following the Configuration guide.

Disable/enable plugin

To disable: log in to your WordPress Admin > go to Plugins > Installed Plugins > scroll to Mastersoft Address plugin and click Deactivate to disable plugin.

This will disable the functionality but will still keep all your configuration settings, so you do not need to configure when you enable the plugin again.

To enable: log in to your WordPress Admin > go to Plugins > Installed Plugins > scroll to Mastersoft Address plugin and click Activate to enable plugin.

Uninstallation

Log in to your WordPress Admin > go to Plugins > Installed Plugins > scroll to Mastersoft Address and click Deactivate and Delete.

This will uninstall and delete all the configuration settings in your database.

If there is an error message during the deleting process Could not fully remove the plugin ...., please make sure the file ownership is set to www-data. To correct the ownership, change to your WordPress plugins directory:

$ chown -R www-data:www-data woocommerce-mastersoft-address

Configuration

Licence Key: (mandatory). Get your FREE Trial licence key. Must be in username-without-domain:password format. Default Value: blank/empty.
URL: Default value if empty/blank: https://hosted.mastersoftgroup.com.
Default Widget Options: Generic Widget Options for both AUSTRALIA and NEW ZEALAND. Pre-configured and default value:

{ singleLineHitNumber: 5, caseType: "TITLE" }
Widget Options for AUSTRALIA: Widget Options for AUSTRALIA only. If the same key is in the Default Widget Options, the value here will take precedence for AUSTRALIA. Pre-configured and default value:

{ sot: "GNAF" }.
Widget Options for NEW ZEALAND: Widget Options for NEW ZEALAND only. If the same key is in the Default Widget Options, the value here will take precedence for NEW ZEALAND. Pre-configured and default value:

{ sot: "NZAD", exposeAttributes: "1" }.

All Widget Options must be in valid JSON format. Here is the full list of available Feature Options.

Frequently Asked Questions

How do I get a licence key?

You can get a FREE Trial licence key and start using it right away.

What are all available Widget Options to configure in the settings?

Widget Options are basically sot for Source of Truth value and key value of FeatureOptions.

Currently these Source of Truth are available for AUSTRALIA: AUPAF, GNAF and for NEW ZEALAND: NZPAF, NZAD.

Here is the full list of Feature Options.

Why the Region for New Zealand is not auto-selected after selecting an address?

New Zealand Region will only be selected if Source of Truth is NZAD and exposeAttributes is turned on.

Go to Mastersoft Address WooCommerce Settings in your WordPress Admin and change Widget Options for NEW ZEALAND value to { sot: "NZAD", exposeAttributes: "1" }.

Where can I report bugs or ask further questions?

Any questions or bugs can be reported either by opening an issue on Mastersoft GitHub.

Alternatively, you can contact us via our website https://www.loqate.com/anz/contact/customer-support/.

Where can I find the REST API documentation?

You can find the documentation of our REST API here.

Changelog

The release history is available on GitHub.

Support

If you have any questions or issues with this module, open an issue on GitHub. Alternatively you can contact us via our website:

https://www.loqate.com/anz/contact/customer-support/

mastersoft / woocommerce-mastersoft-address

Maintainers

Details