The Loqate Adobe Commerce integration is a simple package that contains our market leading services designed to allow you to improve your end user experience, reduce failed deliveries and improve data quality for you and your Adobe Commerce customers. 

We have added best-in-class customer experience optimisations for you to customise your business requirements that best serve your operations.

The integration we have designed includes the following services in one simple package:

This section will include instructions on how to install, upgrade and uninstall the Loqate Adobe Commerce Integration.

As stated in the introduction of this document, this part of the guide is primarily aimed at technical users with knowledge of Adobe Commerce who manage your environment.

Supported Versions

There are configurations that Loqate offer within your account section on a key. The configurations you will see in this guide are solely related to the performance and capabilities of the integration for Adobe commerce.

For further configurations, please visit your Loqate account and you can find more information on this here: https://www.loqate.com/developers/guides/advanced-setup-guide/

Integration Configuration

Once the installation process has completed, you can then configure the module in the admin panel of the store.  

The configuration section for the integration can be found by navigating to Stores -> Configuration -> Loqate -> Main Settings.

For this integration to work, you need to provide a valid API key to the API Key input field found in the configuration section of the module. This is a required field and can be found in the “Your services” section of your account on https://www.loqate.com/.

Under the Loqate configuration you will find the below sections which we have within the integration.

Main Settings

API Key - Navigate to the Your Services section of your Loqate account and copy your API key. Next, navigate back to the Adobe Loqate configuration page and paste it in this field for your integration to work.

Address Capture

Our market leading address capture product allows you to search for and select global accurate premise level addresses from our comprehensive data sources. This service is available to be added in below sections of your Adobe commerce store: 

Merchants can restrict the address results to search only within specific countries. By default, no country is selected and the integration doesn’t apply any country restrictions.

Multiple consecutive countries can be selected by clicking on the first country, scrolling towards the end country, holding down SHIFT and clicking on that end country.  

Multiple countries can be selected by holding down CTRL and clicking on them. All the countries can be selected by clicking once within the field and pressing CTRL+A.

Our address verification product allows you to parse, cleanse and select the most accurate addresses from our comprehensive data sources. You are able to determine the level of quality according to your preferences, more information below:

Address Quality Index: this is used to indicate the quality of an address. Two factors decide the address quality post-processed verification and match level and Matchscore. Based on the Address Quality chosen, the address will be validated or not. All the settings from Address Verify will be based on the address quality set.

Address Quality and index:  

Validate the accuracy of the emails captured in your Adobe Commerce environment with our simple but effective email validation product. 

In the config menu for this service you will first see the option below: 

• Prevent Submit on Invalid Email Address: this is used to prevent the user from adding invalid email in the email fields.

If set to NO then a warning will be displayed at the save address in which the customer is told that the email address is unable to be validated. This may be useful if you do not depend too much on the accuracy of the email address and wish to proceed with the entered information. If the end user selects ‘Save’ a second time, the entered email address will be accepted and the user can proceed.

If set to YES then your end user will be unable to proceed until a validated email address has been entered.  

This service is available to be added in below sections of your Adobe commerce store: 

Phone Validation 

Validate the accuracy of the phone numbers captured in your Adobe Commerce environment with our simple but effective phone validation product. 

In the config menu for this service you will first see the option below: 

• Prevent Submit on Invalid Phone Number: this is used in order to prevent the user from adding invalid phone numbers in the phone fields

If set to NO then a warning will be displayed at the save address in which the customer is told that the phone number is unable to be validated. This may be useful if you do not depend too much on the accuracy of the phone number and wish to proceed with the entered information. If the end user selects ‘Save’ a second time, the entered phone number will be accepted and the user can proceed.

If set to YES then your end user will be unable to proceed until a validated email address has been entered.  

This service is available to be added in below sections of your Adobe commerce store: 

IP2Country 

This optimisation can pre-determine the country of the end user’s IP to populate the country selection field within parts of the integration.

The user’s IP (if redeemable) is gathered by Loqate and the API returns the country ISO2 code, that is then mapped within Magento’s country form. The form will be set by default to that country and addresses will be searched from that country unless the customer changes it.

Upon accessing a page with an address form creation (new customer address, new address at checkout), an Ip2Country request is done if configured for the integration: 

Loqate API results can be customised via the enhanced fields functionality. Before the address is auto-completed by the end user, values can be enhanced by specifying the fields within this section of the integration config.

Trailing characters can be added in admin config page, for example ! for capitalisation and $ to remove diacritics.

The fields are mapped as following: 

Note: State/Province will be changed only in the case of a text field, as Adobe Commerce displays a dropdown for certain countries. 

In the screenshot above, all values will be enhanced – replaced from the enhanced fields call, capitalised and without diacritics. 

Multiple storefront support

The Loqate integration supports multiple store(s) configuration. If you had an operation that needed to interact differently for the UK, and another for a Spanish storefront, then this capability has been introduced to allow management of this.

The priority for configuration values is defaulted to the standard Magento site: Store->Website->Default 

In this store, the API key is inherited from the parent website, which inherits it from the Default config:

Different stores can use different API keys for the Loqate service, and even different settings (e.g.: restrict one store to specific countries and another to other countries).