# ![AddressZen BigCommerce Integration](https://img.ideal-postcodes.co.uk/BigCommerce%20Integration%20Logo%403x.png)

## Features[​](#features "Direct link to Features")

* Address Lookup on checkout shipping and billing pages

* Binds to the following address forms:

  <!-- -->

  * Checkout billing address
  * Checkout shipping address
  * Account registration
  * Account management

* Checks if key is usable before enabling address search

* Populates organization name from selected address

* Add Address Lookup to the BigCommerce dashboard via the [Browser Extension](/docs/integrations/browser-extension.md)

info

If you need support, you can either reach out to us on our [support page](https://addresszen.com/support) or drop by our [developer chat page](https://chat.ideal-postcodes.co.uk).

## Screenshots[​](#screenshots "Direct link to Screenshots")

### Address Lookup[​](#address-lookup "Direct link to Address Lookup")

![Activate address autocompletion on your address collection forms-screenshot](https://img.ideal-postcodes.co.uk/bigcommerce-autocomplete.png)

### Script Setup[​](#script-setup "Direct link to Script Setup")

In the Script Manager and Verification Tag install you will find the script below with some amendments.

```
<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/bigcommerce@3">

</script>
```

You will need to replace `apiKey` attribute in the first script tag. This should be replaced with the **Key on your account**

[]()

### Add to Site Verification Tags[​](#add-to-site-verification-tags "Direct link to Add to Site Verification Tags")

1. Navigate to your Tracking Code page by clicking on the `Advanced Settings` tab from your dashboard.

2. Check `Data Solutions`

3. Click `Connect` to `Site Verification Tags`.

   ![Site Verification Tag checkbox](/assets/images/BigCommerce-1-e733a5c1fa800d1b7ea0d2fec63a0e08.png)

4. Insert the Setup Script. Under the `Site Verification Tags` tab, insert the script from our [script setup step](#script-setup) and click on Save.

   ![Manually add Site Verification Tags setup](/assets/images/BigCommerce-2-2f1d88255ad33f5afb52d6b35f049f1a.png)

[]()

### Add to Script Manager[​](#add-to-script-manager "Direct link to Add to Script Manager")

1. From the Administration page, click on `Store Front` and then `Script Manager`.
2. Click on the blue `Create a Script` button.
3. On the `Create Script` page, name your script. Select the following options:

* `Footer` as the location on page

* `Checkout` as the page on which the script will be added

* `Essential` as the script category

* `Script` as the script type

  ![Edit script page](https://img.ideal-postcodes.co.uk/bigcommerce-configuration.png)

4. Insert the script from our [script setup step](#script-setup) below in the `Script contents` editor and click on 'Save'. The page should appear like below:

   ![Insert initialization code](/assets/images/BigCommerce-3-39029f781a248390c6efa99da91864ae.png)

## Configuration[​](#configuration "Direct link to Configuration")

The minimum configuration is as follows:

```
<script>

  window.idpcConfig = {

    apiKey: "Your API Key goes here"

  };

</script>
```

See our [integration configuration guide](https://ideal-postcodes.co.uk/guides/integration-configuration) to understand how to customize this.

### Defaults[​](#defaults "Direct link to Defaults")

The available configuration attributes for the configuration are as follows:

```
window.idpcConfig = {

   // 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[​](#upgrades "Direct link to Upgrades")

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

## Version Pinning[​](#version-pinning "Direct link to Version Pinning")

It's possible to fix the version number of the integration script. The version suffix `@VERSION` in `src` can be replaced with a specific version number. Versions are automatically logged and tracked on our Changelog.

## Admin Pages[​](#admin-pages "Direct link to Admin Pages")

![BigCommerce Admin Dashboard Integration-screenshot](https://img.ideal-postcodes.co.uk/bigcommerce-admin.gif)

To enable address validation on your admin page, you will need to use our [Browser Extension](/docs/integrations/browser-extension.md).