OpenCart Module for UK Address Search and Validation
Updated 30 Dec 2020
Ideal Postcodes provides an OpenCart extension that enables UK address search and validation across an OpenCart Store.
This extension is ideal if you are after a postcode or address finder on your checkout and user account pages.
This extension is free to download and install. However, our address validation services requires a paid account at ideal-postcodes.co.uk.
You can opt to insert postcode lookup and/or address autocomplete functionality. These features will only be triggered when a UK territory is selected.
Contact us if you get stuck. Drop by our developer chat page for in depth assistance.
If you need support, you can either reach out to us on our support page or drop by our developer chat page
The latest release can be found on our GitHub releases page.
Download the file labeled Ideal Postcodes Open Cart Module x.x.x
.
From the Extension Installer page upload the zip file downloaded from (1).
From the Extensions page, select "Module" and scroll down to "Ideal Postcodes UK Address Validation".
Click to install and configure. See the Configuration section below for more information.
At the very least, you will need to add your API Key and set the Enabled field to Enabled
.
You will need to add the module code to your Checkout
and Account
layouts to enable UK address validation on both the checkout and user addressbook page.
Click on the Content Bottom
dropdown, select Ideal Postcodes UK Address Validation
and click the save button on the top right. You will need to repeat this on both the Checkout
and Account
layouts.
After installation is complete you will need to apply your API Key from your Ideal Postcodes account and enable the extension.
Our guide on creating an Ideal Postcodes account and enabling automated top-ups outlines this process.
Enable or disable extension altogether.
The API Key is required to verify your account for address validation. This can be found on your account dashboard on ideal-postcodes.co.uk.
This will present a Postcode Lookup search box on your address forms. The user will be directed to type their postcode and select an address from a list.
This will enable Address Finder on the first address line on your address forms.
Fill the Company field based on selected address. Enabling this will ensure that the organisation name in your form is populated by the organisation name present at the address selected by the user (if one exists).
This will populate the region field with the county name. County data is no longer used in the UK to identify a premise. However, this can be disabled if you prefer. The user will be required to manually select their region.
This is an advanced setting which overrides the JavaScript initialisation code. Leave as {}
. Invalid inputs will cause the integration to break.
This is an advanced setting which overrides the JavaScript initialisation code. Leave as {}
. Invalid inputs will cause the integration to break.
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.
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.
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.