Function description #
Endereco Address Management Services (AMS) provides a simple and straightforward way to improve the quality of address data entered by your customers. Incorrect addresses can be corrected directly by customers by suggesting corrections. The spelling of addresses is standardized. For this purpose, a two-step process is integrated into the address forms, which ensures correct data entry across almost all input devices.
Installation instructions #
Reinstalling the module #
The module can be installed via Composer.
Run the following command in the root directory of the store:
composer require endereco/endereco-oxid6-clientThe command downloads the latest version and the namespaces are registered. To install a special version, for example 4.3.2, the command can be customized as follows.
composer require endereco/endereco-oxid6-client:4.3.2Update of the module #
To update Endereco Client for OXID, simply run the following command:composer update endereco/endereco-oxid6-client
Notice. When updating from version 3.3.3 to the latest version, the old plugin should first be deactivated and then deleted in the module folder. The latest version of the plugin can then be installed as a new installation.
PS: Feel free to sign up for our Release Newsletter and you will always be informed when an update is available.
Adjustment of the field order #
Notice. Since version 4.2.0 this manual adjustment is omitted. Optimization of the field order can be triggered in the settings of the module.
For this you simply adjust in the template files
"application/views/MYTHEME/tpl/form/fieldset/user_billing.tpl"
"application/views/MYTHEME /tpl/form/fieldset/user_shipping.tpl"
The order of the input fields by simply changing the block order in the two files. The correct order in billing address and shipping address is:
COUNTRY
Postcode / City
Street / House number
Therefore the following blocks in the code must be swapped:
Before |
After |
|---|---|
|
Additional Info "div" Element |
Additional Info "div" Element |
|
StreetAndNo "div" element |
Country + State (Block Element) |
|
PostcodeAndCIty "div" element |
PostcodeAndCIty "div" element |
|
Country + State (Block Element) |
StreetAndNo "div" element |
|
VatIdNo |
VatIdNo |
Example: Swap "street" and "postal code":
After adjusting the field order, the address fields should look like this:
Activate the module in the admin backend #
- Log in to the backend
- Extension → Click on the module → "Endereco AMS".
- Click on the "Trunk" tab.
- Click on the button to the right called "Activate".
Request access data #
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 get it here or directly by sending an email to info@endereco.de .
You can now try out the module for 30 days free of charge on your test instance or in the live store and use all functions without any restrictions. We will contact you after the test period or at the half-time and ask you how to continue or if you have any problems.
Switch to the paid productive mode #
For the live access data we need your consent to our terms and conditions and signed data processing agreement. You can do this via our form: Use of Endereco Services.
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.
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 store backend click on Extensions/Modules and select Endereco Address Services for OXID
- Select settings
- Enter API key, select service endpoint
- Save entries
Configuration of the module #
Selection of the test mode #
"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.
"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 activated, the form is automatically continued to be submitted.
If it is inactive, the user must manually trigger the form submission 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 the selected salutation matches the first name and marks the salutation field if the salutation is incorrectly selected. If no salutation has been selected yet with the input of the first name, this can be set automatically, provided that the entered first name has been recognized 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 feature 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.
Choice of styling (.css file) #
module has been extensively tested with various oxide themes and optimized for them. We support
- Flow (Responsive Theme)
- Wave (Responsive Theme)
- Azure (Standard Oxide Theme)
- Roxide (Responsive Theme)
- RoxIVE (Responsive Theme) <- Select also for the FLOW theme
- Custom (Individual Theme)
By selecting the respective entry, the corresponding styling (stylesheet) is selected for each installed template. You can adapt this according to your needs.
Our module usually detects the installed theme, and usually configures itself. Now you have the possibility to customize colors for different functions yourself.
Insert bootstrap into modal?
Should CSS be inserted for Bootstrap Modal? (Please only if no bootstrap is used!)Usually the switch can be left off, because most themes are already based on bootsrap.
This completes the setup. Please empty the temp folder of your webshop before using the module.
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.
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)
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.
