--- title: "Addressify Integration - Setup and Configuration" canonical: "https://kb.myframeworks.com.au/space/FRAM/475037700/Addressify%20Integration%20-%20Setup%20and%20Configuration" format: markdown --- This configuration supports the integration of **Addressify**, a cloud-based address verification and autocomplete API, into the Frameworks platform. The integration enhances Sales Order Processing (SOP), Point of Sale (POS), and Delivery Maintenance modules by enabling efficient, accurate, and user-friendly address entry for deliveries. The solution streamlines address input, reduces errors, and improves user experience for customer-facing staff. **Modules Enhanced:** - **Sales Order Processing (SOP)**: New sales order popup, delivery details tab, edit header actions - **Point of Sale (POS)**: Delivery details tab - **Delivery Maintenance**: Delivery address entry popup **User Experience:** - When enabled, an **Address Lookup** field becomes available in delivery address entry screens - Users type delivery addresses in the **Address Lookup** field and address suggestions appear as they type - Selecting a suggestion automatically populates suburb/city, state, postcode, and country fields - Manual address entry remains available through standard address fields if users prefer not to use the **Address Lookup** field - Standard address entry workflow continues if Addressify is disabled **Who performs this:** System Administrator **Impact:** Enables address autocomplete and validation across delivery address entry points in SOP, POS, and Delivery Maintenance > 📝 ## Prerequisites > 📝 > 📝 - System Administrator access to Frameworks > 📝 - Addressify API key (obtained through Addressify licensing process, see: [Address verification Australia. Address validation | Addressify](https://www.addressify.com.au/) ) ![image-20260209-004217.png](media://1fa39560-8f91-419d-9dc4-03d85f2c8469) ## Configuration Steps ### Step 1: Access Auto-suggest Settings 1. Navigate to **System Administration > System Setup > Integrations > Auto-suggest Default Settings** 2. The Auto-suggest Default Settings screen opens ### Step 2: Enable Addressify 1. Locate the Addressify configuration line 2. Enable the **Active **checkbox for the Addressify option ### Step 3: Enter API Key and URL 1. In the **autoSuggestUrl** field, enter: **https://api.addressify.com.au/addresspro **or **https://api.addressify.com.au/addressnz/ **(for New Zealand customers). 2. In the **API Key** field, enter your Addressify API key > ⚠ī¸ The API key is provided by Addressify through their licensing process ### Step 4: Configure Additional Settings (Required) 1. Set **autoSuggestMinChar** to **3** (recommended starting value) 2. Set **autoSuggestMaxResults** to **10** (recommended starting value) 3. Verify **autoSuggestEndPoint** is set to **autocomplete** (Addressify default) 4. Verify **autoSuggestDisplayField** is set to **AddressFull** (Addressify default) 5. Leave **autoSuggestTimeout** and **autoSuggestDelay** at their default values (10,000.00 and 500) 6. These settings can be adjusted later based on user feedback ### Step 5: Save Configuration 1. Click **Save** to apply the configuration 2. The system confirms the settings have been saved 3. Log out of Frameworks and back in to establish the API connection. ## Result After completing the configuration and saving the settings, users must log out and log back into Frameworks for the Addressify integration to be enabled in Frameworks - Once logged back in, As users type delivery addresses in the **Address Lookup** field, Addressify provides address suggestions - Selecting a suggestion auto-populates address fields (suburb/city, state, postcode, country) - Manual address entry remains available as a fallback --- ## Configuration Options ### Optional Configuration Adjustments After enabling Addressify with your API key, you can adjust these settings to optimise the user experience for your organisation: **autoSuggestMinChar (Minimum Characters)** Controls how many characters users must type before address suggestions appear. - **2 characters**: Suggestions appear very early - may show too many results - **3 characters**: Balanced approach - specific enough to limit results (recommended) - **4 characters**: Very specific - fewer false matches but requires more typing > ℹī¸ **Recommendation:** Start with **3 characters** and adjust based on user feedback. **autoSuggestMaxResults (Maximum Results)** Controls how many address suggestions display in the dropdown list. - **5 results**: Minimal list - only top matches - **10 results**: Standard list - balanced (recommended) - **15 results**: Extended list - more options but may overwhelm users > ℹī¸ **Recommendation:** Start with **10 results** and adjust based on user feedback. ### Provider-Specific Settings (Configure as Defaults) **autoSuggestEndPoint **and **autoSuggestDisplayField** These fields control the API method and address field mapping for Addressify: - **autoSuggestEndPoint**: autocomplete - **autoSuggestDisplayField**: AddressFull > ⚠ī¸ **Recommendation:** Verify these fields are set to the Addressify defaults shown above. These values are provider-specific and should not be changed unless directed by Support. ### Timing Settings (Leave as Default) **autoSuggestTimeout **and **autoSuggestDelay** These timing settings control API response timeout and typing delay before making API calls. The default values are optimised for most environments: - **autoSuggestTimeout**: 10,000.00 milliseconds (10 seconds) - **autoSuggestDelay**: 500 milliseconds (0.5 seconds) > ⚠ī¸ **Recommendation:** Leave these at default values unless experiencing performance issues. If you need to adjust these settings, contact Sterland Support for guidance. --- ## Troubleshooting Configuration Issues :warning: ** Problem:** Error message appears: "AutoSuggest API Error: AutoSuggest provider 'addressify' not configured (missing API key, URL, DisplayField or EndPoint)" 🛠ī¸ **Solution:** This error appears when a user attempts to use the **Address Lookup** field but their session was established before Addressify was configured or activated. Even when all configuration settings are correct (API key, URL, DisplayField, and EndPoint), users must log out and log back into Frameworks to establish the API connection. **Steps to resolve:** 1. Verify all configuration settings are complete in Auto-suggest Default Settings: - **Active** checkbox is ticked - **autoSuggestUrl** is set to: https://api.addressify.com.au/addresspro or https://api.addressify.com.au/addressnz/ for New Zealand customers. - **API Key** is entered correctly - **autoSuggestEndPoint** is set to: autocomplete - **autoSuggestDisplayField** is set to: AddressFull 2. Ensure the Addressify provider is set to **Active** 3. Instruct the user to log out of Frameworks completely 4. Have the user log back into Frameworks 5. The **Address Lookup** field will now connect to Addressify successfully > ⚠ī¸ **Important:** This error is expected immediately after configuration and does not indicate a configuration problem. It simply means the user's session needs to be refreshed. :warning: **Problem:** Address Lookup field not visible 🛠ī¸ **Solution:** The **Address Lookup** field only appears when the Addressify provider is set to **Active** in Auto-suggest Default Settings. **Steps to resolve:** 1. Navigate to **System Administration > System Setup > Integrations > Auto-suggest Default Settings** 2. Locate the Addressify provider row (Code: addressify) 3. Enable the **Active** checkbox (tick the box) 4. Click **Save** 5. Users must log out and log back into Frameworks for the **Address Lookup** field to appear > ✅ ## Related Tasks > ✅ > ✅ - [Create a Sales Order](https://sterlandsupport.atlassian.net/wiki/spaces/fwksproau/pages/30521804) - Use Addressify when entering delivery addresses in sales orders > ✅ - [Process a Cash Sale with Delivery](https://sterlandsupport.atlassian.net/wiki/spaces/fwksproau/pages/30529154) - Use Addressify when entering delivery addresses at point of sale > ✅ - [Maintain Delivery Addresses](https://sterlandsupport.atlassian.net/wiki/spaces/fwksproau/pages/474316813) - Use Addressify when creating or updating customer delivery addresses --- > ⚠ī¸ **Licensing:** Addressify API usage requires a valid licence. Contact Addressify or your DMSi account manager for licensing information and API key provisioning. > ⚠ī¸ > ⚠ī¸ **Support:** For Addressify API issues, contact Addressify support. For Frameworks integration issues, contact [Framework Support](https://kb.myframeworks.com.au/page/support).