Shopify Plus Integration Guide

Documentation Index

Fetch the complete documentation index at: https://docs.loqate.com/llms.txt

Use this file to discover all available pages before exploring further.

​

Setup Video

​

Prerequisites

• A live Shopify Plus account
• A live Loqate account (available at account.loqate.com)
• A new Loqate API key (see the API keys section below for more information on this)

​

API keys

​

Installation

• Install and configure the Loqate app
• Enable Address Capture, Address Verify and Email Validation
• Recommended - include company name

• Use without Address Capture (not recommended)
• Advanced Settings (optional)

​

Installing and configuring the Loqate app

• You should automatically be taken to the Admin section for your new Loqate app
• If not, go to accounts.shopify.com, select the Your store option, then select the Loqate app on the left-hand side of the screen to open it

• Copy and paste your Loqate API key into the API Key field on this screen, then click the Save button:

​

Enabling Loqate services

• Enabling Address Capture
• Enabling Address Verify
• Enabling Email Validation

With the app installed, the Standard Address Capture is automatically available. We however recommend adding the Custom Capture Search Input as it offers an improved experience when searching sub-buiding addresses.First, you need to add the Loqate-Checkout app block to your store on the Checkout page. (see https://www.shopify.com/enterprise/blog/customize-shopify-checkout). App blocks allow you to customise the look and functionality of your checkout layout. This block is required in order to use the Custom Capture Search Input on the Checkout page. Here’s how to add this block:

• In the Admin section of your Shopify Plus account, go to Settings > Checkout. From here you can either edit your existing checkout, or create a new draft of your checkout layout
• Next, select the Apps icon (the bottom icon) in the left-hand menu of the checkout editor, then search for ‘Loqate’
• Select the loqate-checkout app, then click the plus button and select Checkout from the drop-down list - this adds the app block to the Checkout page
• Next the Standard Address Capture search must be disabled. This will not turn off Capture entirely. Capture will now only run in the app block added using the instructions above. If the standard search is left enabled, Capture address searches will happen in two places on the checkout page(in the custom search input as well as the address text input)
• With that done, make sure to save the changes to your checkout, then exit the editor. If you created a new checkout draft, you can click the Publish button to make it live.
  Only stores which are not password protected will successfully allow app blocks to be added. If the site is password protected, please disable this before adding.

The final step is to enable the Custom Capture Search Input in the Loqate app’s Admin page. First go to the advanced settings in the Loqate App on Shopify. From there enable the Custom Capture Search Input option and save. Please test and check that on checkout a new address search input has been added above the address form and addresses become available when searching addresses there. It’s best practice to test these changes in a lower environment before going to production if possible.If continuing with the Classic Capture Search which places the address dropdown in the default address text input there is, however, an additional step to make sure Address Capture is added to your checkout. Here are the steps to follow:

• In the Admin section of your Shopify Plus account, go to Settings > Checkout. From here you can either edit your existing checkout, or create a new draft of your checkout layout.
• To edit your existing checkout click the Customize button, or to create a new draft checkout click the Duplicate button followed by Customize on the new version.
• Once you’re editing your checkout, go to the Settings menu (the cog icon on the left-hand side), scroll down to the Address autocompletion section and select the Loqate option to set Loqate as your provider:
• Make sure you save the changes to your checkout, then exit the editor. If you created a new checkout draft, you can click the Publish button to make it live.

Address Capture will now be available on your checkout. If you also want to enable Address Verify and/or Email Validation, carry on through the Address Verify and Email Validation tabs.

There are a few steps required to enable Address Verify functionality on your checkout:First, you need to add the Loqate-Checkout app block to your store (see https://www.shopify.com/enterprise/blog/customize-shopify-checkout). App blocks allow you to customise the look and functionality of your checkout layout and process, and this block is required in order to use Address Verify on the Thank You page. Here’s how to add this block:

• In the Admin section of your Shopify Plus account, go to Settings > Checkout. From here you can either edit your existing checkout, or create a new draft of your checkout layout (see the Address Capture section above for more details)
• Next, select the Apps icon (the bottom icon) in the left-hand menu of the checkout editor, then search for ‘Loqate’
• Select the loqate-checkout app, then click the plus button and select Thank you from the drop-down list - this adds the app block to the Thank You page
• With that done, make sure you save the changes to your checkout, then exit the editor. If you created a new checkout draft, you can click the Publish button to make it live.
  Only stores which are not password protected will successfully allow app blocks to be added. If the site is password protected, please disable this before adding.

The next step is to disable the default address verification by Shopify. If this is left enabled, additional suggestions may be displayed against individual address fields, which can cause confusion for customers.

• Still in Settings > Checkout, scroll down to the Address collection preferences section:
• Make sure the Validate shipping address option is unticked, then click the Save button

The final step is to enable Address Verify in the Loqate app’s Admin page.Once you’ve entered your key into the API Key field in the Loqate app’s Admin page, the Address Verify section below will become editable:

• Scroll down to the Address Verify section and select the Enable address verification for post checkout option
  • NOTE: to use the post checkout option, please ensure your store is not password protected
  • If you also want to enable Address Verify on the checkout page you can select the Enable address verification for checkout option too - this is not recommended, however, and this option will be removed soon
  • Click the Save button, and Address Verify will now be available.

The steps to enable Email Validation in your checkout are similar to those for Address Verify.First, add the Loqate-Checkout app block to your store(if it hasn’t already been added by the Capture installation) - It needs to be added to the Checkout section.

• In the Admin section of your Shopify Plus account, go to Settings > Checkout. From here you can either edit your existing checkout, or create a new draft of your checkout layout (see the Address Capture section above for more details)
• Select the Apps icon (the bottom icon) in the left-hand menu of the checkout editor, then search for ‘Loqate’
• Select the loqate-checkout app, then click the plus button and select Checkout from the drop-down list

Once that’s done, you just need to select the Enable email validation option from the ‘Email Validation’ section on the Loqate app’s Admin page:Once that’s selected, click the Save button and move on to the next section.

​

Recommended - Include company name

• Go to the site Settings page for your Shopify store
• Select the Checkout option from the left-hand menu
• Scroll down to the Customer information section

• Set Company name to Optional, then click the Save button

​

Optional - Use without Address Capture (not recommended)

• First, make sure that you’ve enabled at least one of Address Verification and/or Email Validation (see the Enabling Loqate services section earlier)
• Then, go to Settings > checkout and click the Customize option for your checkout
• Click on the Settings icon on the left-hand side, then scroll down to the Address autocompletion section

• Untick the Use address autocompletion option, then save the change to your Checkout configuration

​

Optional - Advanced Settings

Force addresses to be returned in latin character sets where available

With this selected, Address Capture will always attempt to use any English results to set the delivery address, even with non-latin results. Note that for this setting to work, the ‘Display a Custom Loqate Capture Search Input on the checkout page’ option must be enabled.For example, here’s a Japanese address searched for using Kanji characters:And here’s the result populated using the English version of the address:This is useful for when carriers have difficulty processing non-latin addresses.

Use address capture to allow customers to update their address if the shipping address cannot be verified

With this enabled, customers can manually amend their addresses post-checkout, if what they initially entered can’t be verified. For example, if a customer hasn’t entered their building number or apartment number they can go back and add it in.Under these circumstances, after an order has been confirmed the customer will be presented with a list of possible addresses to choose from:If the customer selects one of the suggested addresses, they will then see a notification acknowledging the address they’ve selected and giving them the option to update their shipping address:

Use enhanced country validation on unverified addresses

Sometimes it can be possible for a customer to enter an address with the wrong country, which as standard will be flagged as an unverified address.Selecting this option enables Address Verify to be automatically called for a second time whenever an address is returned as unverified. For the second call, Address Verify will run using enhanced country verification, providing another opportunity to verify the address with the correct country.For this to function Address Verify must be enabled on the Thank you page. This functionality will incur additional charges for additional verification.

Custom field mappings

Custom field mappings allow you to control how Loqate address data is mapped into Shopify’s checkout fields. By default, the app uses built-in logic to populate fields like Address Line 1, Address Line 2, City, and so on. With custom field mappings, you can override this behaviour — either globally or on a per-country basis — to handle address formats that don’t fit the default mapping.This is useful when you need to combine multiple address components into a single Shopify field, apply conditional logic based on whether certain fields have values, or handle country-specific formatting requirements.To configure custom field mappings, click the Custom Field Mappings link on the Advanced Settings page. For full details on how to set up and use this feature, see the dedicated guide:

Custom Field Mappings Guide

Learn how to configure custom field mappings with template syntax, country overrides, and examples.

​

Troubleshooting

I can't see some of the Admin options described in this guide

The Loqate Shopify Integration requires a Shopify Plus account. If you don’t use Shopify Plus, you won’t see all of the necessary options and won’t be able to use this integration.

The Capture autocomplete field is not showing on my checkout

Ensure that the API key is correct on the Admin page.

When selecting an address, the fields do not populate

Ensure that your API key is correct on the Admin page, and that you have sufficient credit on your Loqate account.

How do I uninstall the Loqate app?

If you no longer want to use the Loqate Shopify Plus integration, you can uninstall it from your Shopify Plus store.Please note: if you uninstall the Loqate app and then want to start using it again at a later date, you will need to go through the full installation process again.To uninstall the Loqate app, go to the Admin page of the app within your Shopify account and click on the three dots at the top-right of the screen. You will see an option to uninstall there:When you click Uninstall, you’ll be prompted to choose a reason for uninstalling:Select one or more reasons, then click the Uninstall button. This will uninstall the app and return you to the ‘Installed Apps’ section of your Admin page.