Endereco Address Management Service Module (AMS)
For Shopware 6.0.x and newer
Functional description #
What does the plugin do? #
The endereco address management services plugin improves the quality of customer addresses in your Shopware 6 store through real-time validation and automatic correction functions.
Core functions #
Intelligent address correction
- Immediate correction suggestions for typing errors or incomplete addresses
- Customers can make corrections directly in the form
- Prevents incorrect address entries during input
Automatic address standardization
- Standardized spellings according to postal specifications
- Uniform formatting of all address components
- Improves data quality for downstream systems (ERP, shipping software)
Responsive validation
- Two-stage validation process optimized for all end devices
- Works on desktop PCs, tablets and smartphones
- Seamless integration and optimization of the user experience
Technical implementation #
The plugin extends the standard Shopware 6 address forms with the following functions:
- Live validation during input
- Suggested corrections to the selection
- Automatic completion when entering zip code or city
Business benefits for your store operators #
- Fewer shipping problemsCorrect addresses reduce delivery errors by up to 90%
- Lower returns rate: Fewer undeliverable items
- Better conversionSmooth checkout experience without interruptions
- Clean customer dataStandardized addresses for CRM and marketing automation
- ComplianceFulfillment of data quality requirements of the management
Functions in detail #
Installation #
Reinstalling the module #
To install the endereco plugin for Shopware 6, you have two options:
- Installation via the Shopware Store
- Installation via GitHub / via Composer
You should decide on an installation method, as a subsequent change may result in the loss of status codes for verified existing customers. Both plugins use a slightly different data structure.
Installation via the Shopware Store #
Installation via the store is straightforward and only takes a few minutes:
Call up Shopware Store
Call up the store in the backend of your store or click on this link to get to the plugin in the store:
Search endereco plugin
Alternatively, you can search in the store backend in the Shopware Store for „endereco“ search.
- Look for the endereco icon (white envelope on a blue background) and the plugin manufacturer (endereco)
Select the right plugin for Shopware 6.
Install plugin free of charge
Now you go to your Shopware 6 admin backend.
Go to: Settings → System → Shopware Account → My extensions.
There you click on „Download“ next to the endereco plugin.
Install and activate
After the download you will find the plugin under Settings → System → Plugins.
Click on the three-dot menu next to Endereco → Install.
- After installation, return to the three-point menu → Activate.
Access data and configuration
- Request your access data
- Configure the module (see below)
Installation via the GitHub #
Download endereco module
Download the latest release of the endereco Shopware 6 plugin from GitHub.
Depending on the version of your Shopware store, choose the appropriate version of the plugin:
- Plugin v. 7.0.X - compatible with Shopware 6.7.0.0 - 6.7.5.0
- Plugin v. 6.5.X - compatible with Shopware 6.6.0.0 - 6.6.10.3
- Plugin v. 5.5.X - compatible with Shopware 6.5.0.0 - 6.5.8.15
- Plugin v. 4.5.X - compatible with Shopware 6.4.0.0 - 6.4.20.2
Upload module in the Shopware backend
Now upload the zip archive in the Shopware backend via the plugin manager.
The Endereco module will then appear in the list of modules. You can then install it with one click.
Update of the already installed module
To keep the Endereco client for shopware up-to-date, please download the latest version of the module from GitHub.
You can always find the latest release on Github at
PS: Subscribe for our Release Newsletter and you will always be informed when an update is available.
Upload the module via the Plugin Manager in your Shopware backend. Now you can start and execute the update via the update button to the right of the module.
The theme is recompiled and the caches are deleted. Now the module is up to date.
Activate the module in the Shopware backend
- Log in to the backend
- Click on my extensions → „endereco address services for Shopware“
- Activate
Adaptations of texts and translations (optional) #
The plugin contains German and English translations. Translations for other languages must be maintained using text module management in the backend.
The corresponding text modules can be found via the namespace "Endereco".
Request access data #
Access data #
The module only works with a valid API key, which you will receive from us. If you haven't received one yet, you can request it here for free.
You can try the module 30 days free of charge on your test instance or in the live store from the moment you receive the API key and use all functions.
Limitation:
For licensing reasons, the test is not performed at the house number level during the test period. We will activate this for you in live operation! You can find more conditions here.
Switch to the paid productive mode #
For the live access data we need your consent to our terms and conditions as well as signed order processing contract. You can do this via our form: Use of Endereco Services.
Regarding the order processing contract: For some services in which, according to the DSGVO, we process the customer's personal data or pass it on to third parties via interfaces, we require a data processing contract.
To our terms and conditions: www.endereco.de/agb
We need an approval from the German Post, which can take about 2-3 days.
Entering the access data #
In the module settings you can now define the access data and configure the address checks.
Configuration of the module #
Selection of the test mode #
You have the possibility to switch on and off different services, e.g.:
- Auto-completion for address data
- Address check
- Verification of existing customers
- Verification of PayPal Express orders
"Standard country"
Here you can set which country is automatically preselected in your address form if Shopware has not defined a country. Ideally, it is the country for which you receive the most customer orders.
(Note: Currently without function - we are working on a solution)
„Activate AMS (address check and input assistant)“
The input wizard generates suggestions for the zip code, associated city and streets for the customer based on the data entered. Selected suggestions are transferred to the corresponding address fields when selected.
In the address check, the address is checked again when the form is submitted.
If there is an error, the customer is informed of this via a pop-up window. He now has the option of retaining his entry or accepting a correction suggestion.
„Activate the input assistant (Autocomplete) - Here you can switch off the address input wizard if you wish, e.g. if no input wizard is available for your country. The address fields are then not rotated in the order, but the default setting of the store is used.
"Allow closing of correction notes" - If this function is active, the customer can skip address suggestions of the address check without having to make a selection.
"Customer has to confirm an incorrect address with a checkbox". - If this function is active, the customer must actively confirm his input if he does not want to accept correction suggestions from Endereco.
"Divide street into street name and house number". - When activated, the standard field 'Street and house no.', is divided into two mandatory fields 'Street' and 'House number'.
The customer must now enter both fields separately. This has the advantage that no house number can be forgotten anymore. Shopware still stores the data in a common field.
"Check addresses of existing customers once". - Your existing customers who have not yet been checked will be automatically checked when they log in. If these customers then go through the checkout process, they will be notified of an incorrect address on the "Check and Order" page and redirected accordingly.
"Verify addresses via PayPal Express Checkout" - The data of customers who want to complete the order with PayPal Express Checkout are checked.
„Write validation of billing and delivery addresses in „Custom Fields““
The status codes of an address check are now saved in custom fields. This currently only happens for one check, so it is not available for every order. Dhe status codes are currently intended for internal use, but can also be used - without warranty - for other purposes. We will officially support this function in the future.
„Perform address check during customer import“
If customer data is updated by an import or synchronization with a control room management system, this switch can be used to define whether the synchronized customers are checked or not.
Please operate this switch with caution or ask us if any unwanted tests are running.
Notes: #
For Amazon Pay customers - Paying with Amazon - takes place No test of the customer addresses!
In the case of "Login with Amazon", the customer is also not checked.
Name check #
The „name check“ determines whether selected salutation matches the first name. Furthermore, the first name, last name and title are recognized and the spelling is normalized.
If no form of address has yet been selected by entering the first name, it can be set automatically, provided the first name entered has been recognised and can be clearly assigned to a gender.
Upper and lower case is also automatically adjusted. Names that are not known or may be ambiguous are not marked as incorrect.
Email address verification #
The „E-mail check“ verifies the syntax, accessibility and deliverability of an e-mail box, as well as the existence of an entered e-mail address.
Phone number check #
Our "Phone number check" recognizes mobile and landline numbers. This are automatically normalized in a format to be defined. Mobile phone numbers are checked for reachability on request.
Advanced settings #
"Trigger address validation immediately after leaving the address fields". - If this function is active, the address check is triggered immediately after leaving the address fields. e.g. by selecting the "First name" field.
If this function is not active, the address check is not executed until the form is submitted.
"Continue submitting the form after address selection". - If there is an error in one of the addresses, the address check pop-up appears. If the user now makes a selection, he can confirm it with the "Apply" button.
If this option is enabled, the form submission will continue automatically.
If it is inactive, the user must manually trigger the form submission after closing the pop-up.
"Trigger address validation when submitting the form". - In this case, the address check will not take place until you click "Next" or "Save".
"Customize default path to proxy file "io.php" (optional)". - If there are problems with the execution of the proxy file "io.php" (e.g. when using AMAZON AWS, or if plugin bundles are stored in another folder), the path to the "io.php" file can be stored manually. A copy of the io.php file can be created in the "/public" folder. Then, for example, the path "%SHOP_URL%/io.php" can be entered.
"Load default CSS" - Specifies whether standard CSS classes of the Endereco module should be loaded. If this option is not enabled, no CSS information is loaded. You can then define the styling of the elements yourself, for example, in the theme.
"Load Endereco JavaScript file only on certain pages (default pages with address forms)" -. If this function is active, the endereco.min.js file is loaded only on certain pages. This improves the loading time of the store. Default controller names are already whitelisted.
"Enable plugin also for the following controllers (optional, comma separated)". - The Javascript from Endereco is output for the controllers stored here. The controller names must be entered separated with ",".
This completes the setup.
Add privacy policy #
Now you should still inform your customers that we check the address data, possibly also other personal data.
You now have 3 options for integrating this information:
We have created a text proposal for you, which you can include in your privacy policy. Customize the proposal according to the booked services.
On our website we offer you the possibility to check certain entries in address forms of our webshop for input errors in real time. This is to avoid problems with the delivery of the products you ordered due to incorrect information.
Furthermore, we want to ensure that their contact information is valid for sending information about their order or for any necessary queries.
For the provision of these functions, we use the service provider Endereco, Balthasar-Neumann-Straße 4b, 97236 Randersacker. The service provider processes the data exclusively according to our instructions. The legal basis for the transmission, processing and temporary storage of the data with the service provider is Art. 6 (1) lit. b DS-GVO, as it is absolutely necessary for the fulfillment of the contract or for the implementation of pre-contractual measures that some of the data entered by you in the input mask is checked for accuracy. The following data is processed by the service provider:
- Address (country, city, postal code, street, house number if applicable)
- E-mail address (if not activated please delete)
- Salutation, first name, last name and title (if not activated please delete)
- Phone number (if not activated please delete)
The data is processed separately at the service provider and not merged. The requests are deleted by the service provider as soon as the status of the entered data has been determined and the storage in the webshop has been completed, but at the latest after 30 days.
If you are already a customer of IT Law Firm and manage your legal texts there, you can easily add another text section to your other privacy policy content.
In the legal text generator of the Händlerbund for the privacy policy, there is now the new item in the category "Contact":
"Are they using automatic address validation tools on their website?"
Here "endereco" is now selectable.
After selection and saving, the legal text generator is now extended by an enstrpechent paragraph.
Functional test #
Now, after selecting the country "Germany" and entering a postcode, you should receive suitable suggestions for the city. Suggestions should also appear when you enter the street.
Have fun using our module. We are looking forward to your feedback, suggestions and feedback. This is the only way we can optimize our services for you!
If you have any questions we will be happy to help you!
Simply send an e-mail to: support@endereco.de or Tel: 0931 66 39 839 - 0
Your Endereco Team
