Saltar al contenido
Address Validation iO

Esta documentación solo está disponible en inglés.

Shopware

Set up the Shopware app

Install the Address Validation iO app in Shopware 6, let it connect itself and choose how checkout and orders are checked.

The Address Validation iO app for Shopware 6 checks delivery addresses at checkout and on every order, suggests corrections, tags orders that need a look and gives customers a link to fix their own address. The app connects your shop by itself: there is no API key to copy.

Note: The app is not in the Shopware Store yet. To get it, use the Shopware contact form.

Requirements

  • Shopware 6.6.10.15 or a later 6.6 version, or Shopware 6.7.10.0 or a later 6.7 version. Shopware 6.7.0.0 to 6.7.9.x is not supported.
  • A shop reachable on a public HTTPS address.
  • Open the Shopware admin on your shop's own address. If you use a separate admin address or port, the Address Validation iO pages stay blank.

Install

  1. Get the app from us via the contact form.
  2. In the Shopware admin, install and activate it under Extensions → My extensions.
  3. Allow the permissions Shopware asks for, including the checkout gateway. The checkout gateway lets Address Validation iO check addresses at checkout. If you decline it, there is no error, but only orders are checked after they are placed.

Connect

Installing the app registers your shop with Address Validation iO automatically. On the first request from your shop, Address Validation iO confirms it can reach your shop. The app's Overview then shows the status "Connected".

The app adds an Address Validation iO module to the Shopware admin with the tabs Overview, Analytics, Usage, Settings, Providers, Logs and Help.

Test shop and going live

Every new install starts as a test shop. Nothing is charged, and the Overview says so. Until the shop is live, your real checkout, new orders and Flow actions are not checked, so test answers never reach your customers. Only the Check address button on an order and Providers → Test an address run, with test answers.

To go live, contact us. Your prices are shown on the Overview; see also Pricing.

Setup checklist

The Overview has a Setup list:

  • Review your settings
  • Checkout check is working: shows the last checkout check. If no checkout has reached Address Validation iO yet, you probably declined the checkout gateway. Reinstall the app and allow it.
  • Send customers a correction email: a ready-made email text for Flow Builder (see below).

Configure

Open the Address Validation iO module and go to Settings.

Your Shopware store

Setting Default What it does
Checkout check Warn Off, Warn (show a hint, the customer can still order) or Block (the customer must fix an invalid address).
Check new orders and address changes On Checks every new order and re-checks when an order's address changes.
Also check the billing address Off Checks the billing address as well.
Check the customer's email address Off Email check on new orders. Billed per check.
Check the customer's phone number Off Phone check on new orders. Billed per check.
Mark orders with an invalid address as on hold Off Marks the order as on hold (see Holds).
Start Flow Builder flows when an address is invalid or fixed On Fires the Address Validation iO flow triggers.
Give customers a link to fix their address On Fills the order's correction link.
Lock address changes once the order is Partially shipped In progress, Partially shipped or Shipped. A cancelled or shipped order is always locked.
Also lock after Empty A time limit in hours or days, counted from the order date. Empty means no time limit; at most 60 days.
Sales channels All Leave all unticked to check every sales channel.
Tag orders with the result On Adds a Shopware tag with the result. You can set the prefix, format and words.

Address checks

  • Ignore the second address line
  • PO boxes and parcel lockers: allow or block each, for all countries and per country.
  • Checkout rules: require a house number in the countries you list, check the postal code format in chosen countries, set a maximum length for an address line (0 = no limit), and block invalid or disposable email addresses.
  • Email and phone checks: the provider to check with and an optional fallback ("If that fails"), each with its price per check.

Providers

The Providers tab shows which data provider checks which country, lets you change the provider per country and has Test an address to try any address.

What happens at checkout

When the customer confirms the order, Shopware asks Address Validation iO through the checkout gateway.

  • Warn: the customer sees a hint, with "Did you mean: …" and the suggested address when there is one, and can still order.
  • Block: the customer must fix an invalid address before ordering.
  • Checkout rules: a broken rule (for example a missing house number or a blocked PO box) stops the order in both modes.

The suggestion is shown as a message; there is no one-click "use this address" at checkout. Messages come from Address Validation iO in the shopper's language.

If Address Validation iO is slow or can't be reached, the checkout goes through.

What happens after the order

Each new order is checked in the background, and again when its address changes. The result is written to the order's Address Validation iO address check fields:

Field Values
Result Valid, Needs a check, Invalid, Not checked
Follow-up Nothing to do, Open, Address corrected, Kept by the customer
Suggested address The suggestion, if any
Correction link The customer's link to fix the address
On hold Set when the order is held
Checked at Time of the last check

With tags on, the order also gets a tag with the result.

On the order page you find Check address (Address Validation iO), Address Validation iO history and Release Address Validation iO hold. In the orders list, Check addresses (Address Validation iO) checks up to 10 selected orders.

Customer corrections

When an address needs attention and the correction link is on, the customer gets a link to a page where they can fix their address. The link appears on the order confirmation page (when the check is already done) and on the order in the customer's account, with the text "Please check your delivery address." You can change that text in Shopware's Snippets module.

There is no address check when customers save an address in their account.

Flow Builder

Address Validation iO sends no emails from Shopware. Instead it adds these flow triggers:

  • Address Validation iO: address invalid
  • Address Validation iO: address corrected
  • Address Validation iO: order held

And one flow action: Address Validation iO: check order address, with the option "Re-check even if unchanged".

To email customers, create a flow with the trigger Address Validation iO / Address / Invalid and the action Send email. Use the order's correction link in the mail, for example:

twig
Hello {{ order.orderCustomer.firstName }},

we could not confirm the delivery address of your order {{ order.orderNumber }}. Please check it here:
{{ order.customFields.avio_correction_url }}

Thank you!

Holds

Shopware has no hold that an app can set, so the hold is advice: Address Validation iO marks the order (the On hold field and a tag) and fires "order held". Your own fulfillment rules or flows must respect it. Release Address Validation iO hold on the order clears it.

Uninstall

Uninstalling the app removes Address Validation iO's access to your shop. Unless you choose to keep the app's data, your shop's order checks and logs are erased. Order data is kept for at most 180 days after the last check in any case.

Troubleshooting

The Address Validation iO module is blank

Open the Shopware admin on your shop's own address, not on a separate admin address or port.

Checkout isn't checked

Check Checkout check is working on the Overview. If no checkout has reached Address Validation iO, reinstall the app and allow the checkout gateway. A test shop doesn't check the real checkout until it is live.

The status says your shop refused access

Reinstall the app to reconnect.