endereco Address Management Service Module (AMS)
For Shopware 5.4.x - 5.6.x
Functional description #
The endereco Address Management Services (AMS) enable you to improve the quality of the address data entered by your customers in a simple and uncomplicated way. Customers can correct incorrect addresses directly by suggesting corrections. The spelling of addresses is standardized. A two-stage process is integrated into the address forms for this purpose, which ensures that data is entered correctly across almost all input devices
Installation instructions #
Reinstalling the module #
Download the latest release of the endereco AMS module for Shopware 5.3.x and higher from GitHub.
Now upload the zip archive in the Shopware backend via the plugin manager.
The endereco module will then appear in the list of uninstalled modules. You can then install it with one click.
At Custom Themes problems can occur with our plugin if it is implemented incorrectly. The problems are manifested by the fact that certain components of the plugin that should be visible in the frontend are not visible. This is caused by the template blocks not being overwritten. There are usually two reasons for this:
- The custom theme either has „false“ in the Theme.php file for „protected $injectBeforePlugins“, or the field is not defined at all. It must be changed to „true“. Otherwise the theme will overwrite the plugin's customizations and abort its function.
- The blocks that the custom theme overwrites are missing the parent call. The customizations are therefore final and will not be overwritten by our plugin.
Update of the module #
To keep the endereco client for Shopware up to date, please download the latest version of the module via GitHub.
You can always find the latest release on Github at
PS: Subscribe for our Release Newsletter and you will be informed quickly in the event of an update.
Upload the module via the plugin manager in your shopware backend.
Now you can start and execute the update by clicking 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
- Plugin Manager → Uninstalled modules → Click on „endereco AMS“
- Install and activate
Translation of the plugin (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 have not yet received one, you can request it here or directly by e-mail to info@endereco.de free of charge.
You can now try out the module for 30 days free of charge on your test instance or directly in the live store and use all functions without restrictions. We will contact you after the test period or at the halfway point to ask how things should continue or if you had any problems.
Switch to the paid productive mode #
For the live access data, we need your consent to our terms and conditions and the signed data processing agreement. You can do this using our form: Use of endereco services.
Data processing agreement: For some services in which we process the customer's personal data or pass it on to third parties via interfaces in accordance with the GDPR, we require a data processing agreement.
To our AGB's: 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
- Email check
- Salutation check
"Preselect default 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.
"Address validation and input wizard" - 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.
"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.
"Also check 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.
"Check PayPal Express Check-out" - The data of customers who want to complete the order with PayPal Express Check-out are checked.
ATTENTION:
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.
"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 field "First name".
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 the option is inactive, the user must initiate the sending of the form manually after closing the pop-up.
"(beta) Automatically fill in fields with only one address suggestion remaining (SmartAutocomplete)". - If only one input variant is still possible when entering a part of an address, this suggestion can be automatically transferred to the address fields. e.g. "Würzb" → "Würzburg".
"Email verification" verifies the syntax, accessibility and deliverability of an e-mail box, as well as the existence of an entered e-mail address.
"Salutation check" determines whether selected salutation matches first name and marks salutation field if wrongly selected.
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.
Use standard CSS - Specifies whether standard CSS classes of the endereco module should be loaded.
If this option is not activated, no CSS information is loaded. You can then define the styling of the elements yourself, e.g. in the theme.
Further colour settings - This allows you to customize the colors for warning messages, error texts and notices to match the colors of your webshop.
"Trigger address validation when submitting the form". - In this case, the address check will not take place until you click on "Next" or "Save".
"Output debug information to the browser console". - This function is particularly useful for developers. If it is active, helpful information for debugging the endereco module is displayed in the browser console/developer tools.
This completes the setup.
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
Add privacy policy #
Now you should still inform your customers that we check the address data, possibly also other personal data.
You now have 2 options to include this information:
We have created a text proposal for you to include in your privacy policy. Customize the proposal according to the services you have booked.
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.
We use the service provider endereco, Balthasar-Neumann-Straße 4b, 97236 Randersacker, Germany, to provide these functions. The service provider processes the data exclusively in accordance with our instructions. The legal basis for the transmission, processing and temporary storage of the data by the service provider is Art. 6 para. 1 lit. b GDPR, 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 are checked for correctness. 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)
Phone number (if not activated please delete)
The data is processed separately by the service provider and is not merged. The requests are deleted by the service provider as soon as the status of the data entered has been determined and storage in the web store has been completed, but after 30 days at the latest.
If you are already a customer of IT Law Firm and manage your legal texts there, you can simply add another text section to your other privacy policy content.
