Open Nav

Magento Extension

Magento extension for UK address search and validation

Updated 9 Mar 2020

Ideal Postcodes Magento Extension

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.

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.

Features

  • Adds UK address validation to address forms:
    • User billing address
    • User shipping address
    • User address book
  • Allows for following address selection mode:
  • Address search and validation enabled for countries covered by Postcode Address File
  • Hides address search for non-UK territories
  • API Key and other configuration scoped by website, store or view
  • Asynchronously performs checks if key is active and usable
    • Checks if your API Key is currently usable before presenting your users with address search fields
    • Allows regular address entry if, for example, your key runs out of balance or accidental misconfiguration
  • Option hoists country selection above address fields
  • Option populate company name based on address
  • Option populate county field
  • Administration Page
    • Insert API Key credentials

Screenshots

Postcode Lookup

postcode lookup

Address Autocomplete

autocomplete

Configuration

configuration

Links

Support

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

Installation

This extension can be retrieved using the following methods

Once the extension is copied, you will need to run the final install steps

Composer

Install via composer with

composer require idealpostcodes/module-ukaddresssearch

Manual

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

Inside of app/code/Idealpostcodes/Ukaddresses you can retrieve the extension by

  • Download and untar from our releases page
  • Git clone this project git clone --depth=1 https://github.com/ideal-postcodes/magento.git
  • Git clone a specific version git clone --branch <tag> -depth=1 https://github.com/ideal-postcodes/magento.git

Magento Connect

Currently not available

Final Install Steps

You may enable and install this extension with the following commands

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

Configuration

Apply your API Key via the Configuration dashboard.

You can find this on your administration page under Stores Menu -> Configuration -> Services Tab -> Ideal Postcodes.

Configuration