Diese Dokumentation gibt es nur auf Englisch.
Doku
Dokumentation
Richte Address Validation iO auf deiner Shop-Plattform ein oder binde die Plattform-API an.
Erste Schritte
- IntroductionWhat Address Validation iO does, where it runs and where to start reading.
- How a check worksThe steps of an address check, the four results, the Strict, Balanced and Loose modes and the free pre-check.
Shopify-App
- Install and set upInstall the Shopify app, approve the plan, work through the Setup checklist on Home and test an address.
- CheckoutThe checkout address check, address suggestions, the email check and the checkout rules, which of them need Shopify Plus, and how wallets behave.
- Order checks, tags and correctionsWhich orders Address Validation iO checks, the order tags, checking orders again, and how customers correct their address by email, on the order status page and in their account.
- Fulfillment holdsHold new orders with an invalid address until the customer fixes or confirms it, with an automatic release and a reminder email to you.
- Email and phone checksOptional checks of each order's email address and phone number, what the results mean and how they work with correction emails and checkout.
- Address rules and delivery pointsYour own rules that block, flag, rewrite or skip addresses, and per-country settings for PO boxes, parcel lockers and pickup points.
- Analytics, logs, insights and A/B testsThe Analytics page and savings estimate, the Logs and order history, AI insights with backtests, and provider A/B tests on your own orders.
- Plans and billingHow the Shopify app is billed, the 500 free checks, what counts as a verified order, the optional packages, the spending cap and how to change your plan.
WooCommerce
- Set up the WooCommerce pluginInstall the Address Validation iO plugin for WooCommerce, connect it with your API key and choose how checkout and orders are checked.
Shopware
- Set up the Shopware appInstall the Address Validation iO app in Shopware 6, let it connect itself and choose how checkout and orders are checked.
Headless-Widget
- Headless widgetEmbed the Address Validation iO widget on a headless Shopify storefront so signed-in customers can fix order addresses and get address-book checks.
- Widget tokensSign a short-lived token on your server so the headless widget can load the signed-in customer's orders.
API
- AuthenticationAuthenticate to the Address Validation iO platform API with a bearer API key, and check which shop a key belongs to.
- Errors and rate limitsThe platform API's error format, request ids, body size limit, hourly limits and which requests are safe to retry.
- Validate an addressCheck a postal address with POST /v1/addresses/validate and act on the decision, suggestions and issues it returns.
- Validate an email and a phoneCheck an email address with POST /v1/emails/validate and a phone number with POST /v1/phones/validate.
- OrdersSubmit an order for checking with the idempotent PUT /v1/orders/{orderId}, read it back, record a correction and erase it.
- UsageRead your shop's metered usage and current prices with GET /v1/usage and the last twelve months with GET /v1/usage/months.
- API-Referenz
SDKs
- TypeScript and PHP clientsThe official TypeScript and PHP clients for the Address Validation iO platform API, their methods, errors, timeouts and retries.