ShopWired Integration

Ideal Postcodes provides a ShopWired integration that facilitates UK address search and validation across a ShopWired Store.

This extension is free to download and install. However, our address validation services require a paid account at ideal-postcodes.co.uk.

This integration works by hooking into the custom scripts enabled for Google Analytics. It waits until a valid address form is present before binding itself.

To enable address validation on the admin page, please use our Browser Extension.

Contact us if you get stuck. Drop by our developer chat page for in-depth assistance.

Features

• Address autocompletion on:
  • Checkout (shipping and billing pages)
  • User registration page
  • Account details page
• Checks if the API Key is usable before enabling autocomplete
• Populates organisation name from selected address

Screenshots

Address Finder

Postcode Lookup

Links

• Guide
• Changelog
• npm Module
• CDN

Support

If you need support, you can either reach out to us on our support page or drop by our developer chat page.

Enable on Checkout

To enable Address Validation on checkout, you will need to use ShopWired's Advanced Customisation.

Access Advanced Customisation

From the Administration page sidebar, navigate to Checkout → Platform Checkout and scroll down to Advanced Customisation.

Insert Activation Code

In the Script contents editor, insert the below configuration code and click on Save.

<script>
  window.idpcConfig = {
    apiKey: "Your API Key goes here"
  };
</script>

<script 
  async 
  type="text/javascript"
  crossorigin="anonymous"
  src="https://cdn.jsdelivr.net/npm/@ideal-postcodes/shopwired@2">
</script>

When inserting the configuration and initialisation codes into the editor, take special care to replace the following:

• The apiKey attribute in the first script tag. This should be replaced with the Key on your account.

Enable on Accounts

To enable Address Validation on user accounts and other pages you will need to update your ShopWired theme template.

Access Theme Templates

From the Administration page sidebar, navigate to Themes → Installed Themes click on Page Editor.

Insert Activation Code

From the Page Editor, click on Views then Templates then master.twig. At the bottom of the editor before </body>, add the same activiation code as the checkout section (above).

Once again update apiKey.

Testing

Your first key on your Ideal Postcodes account will carry a free test balance which you can use to verify and test your integration. Please contact support if you need a larger test balance.

Going Live

In order to go live, you will need to purchase a balance of lookups on your API Key. This can be done manually or automated from your dashboard. Each address search consumes one lookup from your Key balance.

See our account setup guide for the quickest way to go live by creating your first API Key and enabling automated top-ups.

Configuration

The minimum configuration is as follows:

<script>
  window.idpcConfig = {
    apiKey: "Your API Key goes here"
  };
</script>

See our integration configuration guide to understand how to customise this.

Defaults

The available configuration attributes for the configuration are as follows:

{
   // API Key is not set by default
  apiKey: "",

  // Postcode Lookup is enabled
  postcodeLookup: true,

  // Autocomplete is enabled
  autocomplete: true,

  // Company name field is updated
  populateOrganisation: true,
  // County name field is not updated
  populateCounty: false,

  // Advanced configuration
  autocompleteOverride: {},
  postcodeLookupOverride: {}
}

Upgrades

This integration will be continually updated without your action. However there will be occassion when a backwards breaking change is introduced. When this happens we will increment the version number at the end of the script src.

API Key

Your API Key is central to how our service recognises your integration. See our guide on API Keys to find out more.

API Keys can also be safeguarded against potential misuse. Please see our guide on securing your API Key to find out more.

Admin Pages

To enable address validation on your admin page, you will need to use our Browser Extension.