SmartMaps Address Autocomplete: Configuration
Settings of the SmartMaps Address Autocomplete plugin: API key, activation and country filter, per-sales-channel configuration and practical examples.
Configuration
This documentation always describes the latest published version.
You find the settings in the admin under Extensions > My Extensions > SmartMaps Address Autocomplete. They are in the card SmartMaps Autocomplete.
Settings
| Setting | Type | Default | Description |
|---|---|---|---|
API Key (apiKey) |
Password, required | empty | Your SmartMaps API key. You can protect it in the SmartMaps portal with domain restrictions. |
Enable Autocomplete (enabled) |
Switch | on | Turns address autocomplete in the address forms on or off. |
Country Filter (ISO Codes) (countryFilter) |
Text | empty | Comma-separated ISO country codes that restrict the suggestions, for example DE, AT, CH. Empty allows all countries. |
When the plugin becomes active
Autocomplete is only included when all three conditions are met.
- Enable Autocomplete is switched on.
- The API key is not empty and at least 10 characters long. Leading and trailing whitespace is removed.
- The API key contains only letters, digits and the characters
_ - / + = % . :.
If a condition is not met, the address forms stay unchanged and nothing is loaded from SmartMaps.
Country filter
- Each entry must be exactly two characters long. Case does not matter, whitespace around entries is removed.
- Invalid entries are silently ignored. If no valid entry remains, no filter applies.
- The filter only restricts the SmartMaps suggestions. It does not change the form's country list.
Configuration per sales channel
All three settings can be overridden per sales channel. In the configuration view, pick the sales channel at the top and enter its own values, otherwise the global value applies.
Practical examples
DACH shop
| Setting | Value |
|---|---|
| API Key | your key |
| Enable Autocomplete | on |
| Country Filter | DE, AT, CH |
Result: only addresses from Germany, Austria and Switzerland are suggested.
International shop
| Setting | Value |
|---|---|
| API Key | your key |
| Enable Autocomplete | on |
| Country Filter | empty |
Result: suggestions from every country SmartMaps returns.
One sales channel per country
Global: Country Filter DE. In the sales channel "Austria shop": Country Filter AT. The main shop then suggests only German addresses, the Austria shop only Austrian ones.
Switch autocomplete off in one sales channel
Set Enable Autocomplete to off in that sales channel. The other sales channels stay unchanged.