Ideal Postcodes provides a Magento Extension that facilitiates UK address search and validation across a Magento Store.
This extension is ideal if you are after a postcode finder or address finder on your checkout 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.
Configure the plugin from your admin dashboard. Plugin configuration can be scoped specific to each of your stores.
This extension can be retrieved using the following methods
For the Composer and Manual installation, when the extension is copied, you will need to run the final install steps
Install via composer with
composer require idealpostcodes/module-ukaddresssearch
This repository needs to be loaded into your Magento directory. The following directory needs to be present in your Magento codebase
app/code/Idealpostcodes/Ukaddresses you can retrieve the extension by
git clone --depth=1 https://github.com/ideal-postcodes/magento.git
git clone --branch <tag> -depth=1 https://github.com/ideal-postcodes/magento.git
Find us on the Magento Marketplace.
For the composer and manual installation methods, you will also need to execute the following commands to complete the installation:
magento module:enable Idealpostcodes_Ukaddresssearch magento setup:upgrade magento setup:di:compile magento setup:static-content:deploy -f
After installation is complete you will need to apply your API Key from your Ideal Postcodes account.
A guide on creating an Ideal Postcodes account and enabling automated top-ups can be found here: https://ideal-postcodes.co.uk/guides/account-setup.
The administration page can be found at
Stores Menu ->
Services Tab ->
You can apply your API Key on the configuration dashboard as well as manage other configuration options. A free test balance is available on your first key, so you can test your extension before having to pay.
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 autocomplete 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 enabled if you prefer.
This will hoist the country input field to the top of your address form. This is useful if your default country is not a UK territory - lifting the country field to the top of the address form means that the user will be presented with the correct search tools when the get to address entry.
Our UK search solutions will only present on address forms where the selected country is a UK territory. When a non-UK territory is selected, our tools are detached from your form.
For exceptionally complex integrations, where the checkout has been substantially modified, you may need to tell this extension how to find your address form.
targets under the Advanced Configuration tab are CSS selectors that identify which DOM element(s) will contain a single address input form for your checkout.
The defaults will enable address validation correctly on the majority of Magento checkouts. If you are unable to attach address search on a particular form, let us know and we can find the right
targets for you.
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.