Shopify Plus Integration Guide
Get Loqate services running in Shopify Plus in just a few minutes
Download from the Shopify App Store
In this guide we will provide all of the information you need to get up and running using the Loqate Shopify Plus Integration. If you’re looking for the full details of what the Loqate Shopify Plus Integration does and what it looks like in practice, you can find that here:
About the Loqate Shopify Plus Integration
Prerequisites
Before you start installing and setting up the Loqate Shopify Plus Integration, you will need the following:
- A live Shopify Plus account
- A live Loqate account
- A new Loqate API key (see the API keys section below for more information on this)
Loqate accounts
You can use the Loqate Shopify Plus app with both the Loqate Saas platform (available to North American customers) and Classic platform. If you’re in the US and you’re not sure which platform you’re using, see our guide to the Loqate Saas Platform.
It’s important to note, however, that Address Verify functionality is only available via the Classic platform. You can use both Address Capture and Address Verify with a single Classic platform API key.
API keys
You’ll need a new Loqate API key, dedicated to this service (our Creating API Keys page has lots of information about how to set one up, and what to consider when you’re doing that). For the Loqate Saas platform you can use any key; for the Classic platform we recommend you create a generic API key, but any key will work.
For information about how to ensure your Loqate integration is as secure as possible, see our API Security page.
Installation
There are a few quick steps to get the Loqate Shopify Plus Integration up and running:
- Install and configure the Loqate app
- Enable Address Capture, Address Verify and Email Validation
- Recommended - include company name
As well as those key actions, there are also some additional steps that you can follow if required:
Follow these steps in order, and you’ll get up and running quickly and easily. If you need help you can contact support@loqate.com.
Installing and configuring the Loqate app
The initial setup will add the Loqate app to your Shopify store, at which point Address Capture will be enabled by default. You can then also enable Address Verify and/or Email Validation.
First, install the Loqate app from the Shopify App Store (see the Shopify app installation instructions for more details). Once that is done:
- 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 in to the API Key field on this screen, then click the Save button:
With that done, you can add one or more of the Loqate services to your store using the steps below.
Enabling Loqate services
With the app installed, Address Capture is automatically available. 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 layou
- 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.
With the app installed, Address Capture is automatically available. 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 layou
- 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 to 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.
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.
NOTE: Address Verify is only available if you’re using a Classic platform API key. If you’re using a Saas platform API key, the Address Verify section below the API key section will remain greyed out.
If you’re using a Classic platform API key, 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 - but this time 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
By default, Shopify is set to not include a Company name address field. As such, if an address includes a company name (for example if a customer orders a delivery to their place of work) it won’t be included in the address that’s populated in Shopify.
We recommend setting Shopify to include Company name as an optional address field, so that it will be populated any time an address does include a company name. Here’s how to change that setting:
- 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
With that done, you should now see an optional Company address field in the checkout:
Optional - Use without Address Capture (not recommended)
We recommend always using Address Capture, as this helps reduce the chances of mistakes caused by manual address entry, ensuring addresses can be trusted as correct and giving the best customer experience. It is, however, possible to use just Address Verification or just Email Validation if you don’t want any kind of address autocompletion functionality.
If you want to use Address Verification and/or Email Validation on their own, follow the full installation and setup process as above, then you can manually disable Address Capture. Here’s how to do that:
- First, make sure that you’ve enabled at least one of Address Verification and/or Email Validation (see the Basic Setup 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
This will have disabled the Address Capture functionality, while leaving Address Verify and/or Email Validation running.
Optional - Advanced Settings
The Advanced Settings page is located in the Admin section of your Loqate app, and includes the following optional settings.
Troubleshooting
Further reading
If you haven’t already, check out our ‘About the Loqate Shopify Plus Integration’ article for examples of the Loqate Shopify Plus Integration in use.