Installation instructions for Shopware

Endereco Address Management Service Module (AMS)
For Shopware 5.4.x - 5.6.x

Functional description

Endereco Address Management Services (AMS) is a simple and straightforward way to improve the quality of the address data entered by your customers. Incorrect addresses can be corrected directly by the customers through correction suggestions. The spelling of addresses is standardised . For this purpose, a two-stage process is integrated into the address forms, which ensures that the data is entered correctly via almost all input devices.

Step 1 - directly during the input

a) Address entry wizard

Suggestions for entered address fragments are displayed in an autocomplete function of street, postcode and city. This works on PCs, tablets and smartphones. Address entry is simplified, accelerated and the error rate is massively reduced.

b) Salutation check (Does the salutation match the first name?)

The Endereco first name database with over 30,000 entries can recognise gender-specific first names and marks the corresponding salutation field of your webshop. Ambiguous or unknown names are ignored. Upper and lower case is automatically corrected.

c) Validation of the e-mail address

An entered e-mail address is checked for various characteristics in real time:

  • Valid syntax of the e-mail address
  • Valid country domain
  • Is the e-mail inbox registered and accessible?
  • Is the mailbox full or deliverable?
  • Is it a disposable address or SPAM e-mail address?

Step 2 - when submitting the form

a) AddressCheck

The address check validates entered address fields for validity in the overall context. For implausible entries, valid correction surcharges are automatically offered. The customer can choose between his entry and one of the correction thresholds.


Installation instructions

2.1 New installation of the module

Download the latest release of the Endereco AMS module for Shopware 5.3.x and above from GitHub.

Now upload the zip archive in the Shopware backend via the plugin manager.

The Endereco module then appears in the list of uninstalled modules. You can then install it with one click.

2.2 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: Carry you gladly in our Release Newsletter then you will always be informed quickly when an update is made. 

Upload the module via the plugin manager in your shopware backend.
Now you can start and execute the update with the Update button on the right side of the module.
The theme is recompiled and the caches are deleted. Now the module is up to date. 

2.3 Activating the module in the shopware backend

  • Log in to the backend
  • Plugin Manager → Uninstalled modules → Click on "Endereco AMS
  • Install and activate

2.3 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".

Maintain text modules menu
Find text blocks

Request access data

3.1 Access data

The module only works with a valid API key, which you will get from us. If you haven't received one yet, you can download it here or send it directly via email 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 in the liveshop and use all functions without restrictions. We will contact you after the test period or at half time and ask you how to proceed or if you have any problems.

3.2 Switching to the production mode with costs

For the live access data we need two signed and approved contracts, namely provider contract and data processing contract. Both contracts will be sent to you by e-mail.

About the data processing contract: For some services in which we process personal data of the customer or pass them on to third parties via interfaces according to the DSGVO, we need a data processing contract. For example, when it comes to an e-mail deliverability check or telephone number standardization.

Please send both signed contracts to
info@endereco.de or by fax to: 0931 6639839-9 or by mail to us.
We need a release from the German Post, which can take about 2-3 days.

Endereco UG (limited liability)
Robert Rieser
Balthasar-Neumann-Str. 4b,
97236 Edge bag

3.3 Entering the access data

In the module settings you can now define the access data and configure the address checks.


Configuration of the module 

4.1 Selecting the test mode

You have the possibility to switch different services on and off, for example:

  • Auto-completion for address data
  • Address verification
  • E-mail verification
  • 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 check and entry wizard"  - The input assistant generates suggestions for the customer for postcode, city and streets based on the data entered. Selected suggestions are transferred to the corresponding address fields when selected.

During the address check, the address is checked again when the form is sent.

If there is an error, the customer is informed about it via a pop-up window. He now has the option of retaining his entry or accepting a suggested correction.

"Divide street into street name and house number" - When activated, the standard field "Street and house number" 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. Showare still stores the data in a common field.

"Also check existing customers once" - Your existing customers who have not yet been checked will be checked automatically when you log in. If these customers go through the checkout process, they will be redirected to the "Check and Order" page.

ATTENTION:

For Amazon Pay customers - paying with Amazon - there is no check of the customer addresses!

With "Login with Amazon" the customer is also checked.

"Trigger address check 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 only carried out when the form is submitted.

"Continue submitting the form after selecting the address"

If there is an error in one of the addresses, the address check popup appears. If the user now makes a selection, he can confirm this by clicking on the "Apply" button.
If this option is activated, the form is automatically continued to be submitted.
If it is inactive, the user must manually trigger the form submission after closing the popup.

"(beta) Fields to be filled in automatically if only one address suggestion remains (SmartAutocomplete)" - If only one input variant is possible when entering an address list part, this suggestion can be automatically adopted in the address fields. e.g. "Würzb" -> "Würzburg".

"Email verification" verifies the syntax, reachability and deliverability of an e-mail inbox and the existence of an entered e-mail address.

"Salutation check" determines whether selected salutation matches the first name and marks the salutation field if the salutation is incorrectly 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, for example in the theme.

Further colour settings - This allows you to adjust the colors for warnings, error texts and notes to the colors of your webshop.

"Trigger address check when form is submitted" - In this case, the address check will not take place until you click "Next" or "Save".

"Outputting debugging information to the browser console" - This function is especially 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


Extract of our customers

    References

    Copyright Endereco UG (haftungsbeschränkt) - Company for Master Data Quality Management
    2014 - 2020