https://docs.addresszen.com/assets/js/2efc3879.6941d94d.js

1"use strict";(globalThis.webpackChunk_atlas_docs_zen=globalThis.webpackChunk_atlas_docs_zen||[]).push([[2468],{4056(e,n,t){t.d(n,{R:()=>a,x:()=>r});var i=t(2155);const o={},s=i.createContext(o);function a(e){const n=i.useContext(s);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),i.createElement(s.Provider,{value:n},e.children)}},5788(e,n,t){t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>i,toc:()=>d});const i=JSON.parse('{"id":"integrations/magento","title":"Magento Address Verification Integration | Documentation","description":"Magento extension for US address search and verification. Follow our setup guide to get started. Quick and easy implementation. Live developer support available.","source":"@site/docs/integrations/magento.mdx","sourceDirName":"integrations","slug":"/integrations/magento","permalink":"/docs/integrations/magento","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{"sidebar_label":"Magento","title":"Magento Address Verification Integration | Documentation","description":"Magento extension for US address search and verification. Follow our setup guide to get started. Quick and easy implementation. Live developer support available."},"sidebar":"integrations","previous":{"title":"WooCommerce","permalink":"/docs/integrations/woocommerce"},"next":{"title":"Contact Form 7","permalink":"/docs/integrations/contact-form-7"}}');var o=t(5723),s=t(4056);const a={sidebar_label:"Magento",title:"Magento Address Verification Integration | Documentation",description:"Magento extension for US address search and verification. Follow our setup guide to get started. Quick and easy implementation. Live developer support available."},r="Installing Address Verification for Magento",l={},d=[{value:"Screenshots",id:"screenshots",level:2},{value:"Works With",id:"works-with",level:2},{value:"Step 1: Sign Up for an Account",id:"step-1-sign-up-for-an-account",level:2},{value:"Step 2: Install the Magento Plugin",id:"step-2-install-the-magento-plugin",level:2},{value:"Method A: Install via Magento Marketplace",id:"method-a-install-via-magento-marketplace",level:3},{value:"Method B: Install via Composer",id:"method-b-install-via-composer",level:3},{value:"Method C: Install Manually",id:"method-c-install-manually",level:3},{value:"Step 3: Plugin Setup",id:"step-3-plugin-setup",level:2},{value:"Configuration Options",id:"configuration-options",level:2},{value:"Required",id:"required",level:3},{value:"Enabled",id:"enabled",level:4},{value:"API Key",id:"api-key",level:4},{value:"Optional",id:"optional",level:3},{value:"Enable Address Autocomplete",id:"enable-address-autocomplete",level:4},{value:"Remove Organization",id:"remove-organization",level:4},{value:"Custom Forms and Configuration",id:"custom-forms-and-configuration",level:3}];function c(e){const n={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",img:"img",li:"li",ol:"ol",p:"p",pre:"pre",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("img",{className:"page-icon",src:"/img/icons/integrations/magento.svg",alt:"",width:"64",height:"64"}),"\n",(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"installing-address-verification-for-magento",children:"Installing Address Verification for Magento"})}),"\n",(0,o.jsx)(n.p,{children:"To add address verification to your Magento store, follow these simple steps. You can enable address verification on your billing or shipping address forms. This guide will walk you through signing up for an account, installing the plugin, configuring it, and exploring advanced settings."}),"\n",(0,o.jsx)(n.h2,{id:"screenshots",children:"Screenshots"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{alt:"Activate Address Lookup on your address collection forms-screenshot",src:t(7285).A+"",width:"1280",height:"800"})}),"\n",(0,o.jsx)(n.h2,{id:"works-with",children:"Works With"}),"\n",(0,o.jsx)(n.p,{children:"Listed below are 3rd party Magento extensions we test against:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"https://www.mageplaza.com/magento-2-one-step-checkout-extension/",children:"Mageplaza.com One Step Checkout"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"https://www.onestepcheckout.com/",children:"OneStepCheckout.com Extension"})}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"step-1-sign-up-for-an-account",children:"Step 1: Sign Up for an Account"}),"\n",(0,o.jsx)(n.p,{children:"To use AddressZen, you\u2019ll first need to create an account and get your API key."}),"\n",(0,o.jsxs)(n.ol,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"https://account.addresszen.com/users/sign_up",children:"Sign up"})," to create a free account."]}),"\n",(0,o.jsx)(n.li,{children:"Navigate to the KEYS section in your account."}),"\n",(0,o.jsxs)(n.li,{children:["Copy your API Key - you\u2019ll need this to complete the setup in Magento. It\u2019s a string of characters that begins with the letters ",(0,o.jsx)(n.code,{children:"ak_"}),"."]}),"\n"]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"step-2-install-the-magento-plugin",children:"Step 2: Install the Magento Plugin"}),"\n",(0,o.jsx)(n.p,{children:"You have three ways to install the AddressZen plugin for Magento: directly through the Magento Marketplace, via Composer, or manually."}),"\n",(0,o.jsx)(n.h3,{id:"method-a-install-via-magento-marketplace",children:"Method A: Install via Magento Marketplace"}),"\n",(0,o.jsx)(n.p,{children:"This is the simplest method to integrate address verification into your Magento store."}),"\n",(0,o.jsxs)(n.p,{children:["You can purchase the extension from ",(0,o.jsx)(n.a,{href:"https://commercemarketplace.adobe.com/addresszen-magento.html",children:"Magento Marketplace"})," for free."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"method-b-install-via-composer",children:"Method B: Install via Composer"}),"\n",(0,o.jsxs)(n.ol,{children:["\n",(0,o.jsx)(n.li,{children:"Install via composer using this command"}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-bash",children:"$ composer require addresszen/magento\n"})}),"\n",(0,o.jsxs)(n.ol,{start:"2",children:["\n",(0,o.jsx)(n.li,{children:"Execute the following commands to complete the installation:"}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-bash",children:"magento module:enable Addresszen_Lookup\nmagento setup:upgrade\nmagento setup:di:compile\nmagento setup:static-content:deploy -f\n"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"method-c-install-manually",children:"Method C: Install Manually"}),"\n",(0,o.jsxs)(n.ol,{children:["\n",(0,o.jsx)(n.li,{children:"Load the repository into your Magento directory"}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"app/code/Addresszen/Lookup"})," needs to be present in your Magento codebase"]}),"\n",(0,o.jsx)(n.li,{children:"Retrieve the extension by the following methods:"}),"\n"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:['Download and "untar" from ',(0,o.jsx)(n.a,{href:"https://github.com/addresszen/magento/releases",children:"our releases page"})]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Git clone this project"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-bash",children:"$ git clone --depth=1 https://github.com/addresszen/magento.git\n"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Git clone a specific version"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-bash",children:"$ git clone --branch <tag> --depth=1 https://github.com/addresszen/magento.git\n"})}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.ol,{start:"4",children:["\n",(0,o.jsx)(n.li,{children:"Execute the following commands to complete the installation:"}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-bash",children:"magento module:enable Addresszen_Lookup\nmagento setup:upgrade\nmagento setup:di:compile\nmagento setup:static-content:deploy -f\n"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"step-3-plugin-setup",children:"Step 3: Plugin Setup"}),"\n",(0,o.jsxs)(n.ol,{children:["\n",(0,o.jsx)(n.li,{children:"Once the plugin is installed, it\u2019s time to configure it."}),"\n",(0,o.jsxs)(n.li,{children:["Head to the administration page. Click ",(0,o.jsx)(n.code,{children:"Stores Menu"})," -> ",(0,o.jsx)(n.code,{children:"Configuration"})," -> ",(0,o.jsx)(n.code,{children:"Services Tab"})," -> ",(0,o.jsx)(n.code,{children:"AddressZen"}),"."]}),"\n",(0,o.jsx)(n.li,{children:"Enter your API Key (the one you copied when signing up) in the designated field. You can always find the API Key under KEYS in your AddressZen account."}),"\n"]}),"\n",(0,o.jsx)(n.admonition,{type:"info",children:(0,o.jsxs)(n.p,{children:["Read our guide on ",(0,o.jsx)(n.a,{href:"/docs/guides/automated-topups",children:"creating an AddressZen account and enabling automated top-ups"}),"."]})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"configuration-options",children:"Configuration Options"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{alt:"Configuring settings-screenshot",src:t(7346).A+"",width:"1920",height:"918"})}),"\n",(0,o.jsx)(n.h3,{id:"required",children:"Required"}),"\n",(0,o.jsx)(n.h4,{id:"enabled",children:"Enabled"}),"\n",(0,o.jsx)(n.p,{children:"Enable or disable the extension altogether."}),"\n",(0,o.jsx)(n.h4,{id:"api-key",children:"API Key"}),"\n",(0,o.jsxs)(n.p,{children:["The API Key is required to verify your account for address verification. This can be found on your account dashboard on ",(0,o.jsx)(n.a,{href:"https://addresszen.com",children:"addresszen.com"}),"."]}),"\n",(0,o.jsx)(n.h3,{id:"optional",children:"Optional"}),"\n",(0,o.jsx)(n.h4,{id:"enable-address-autocomplete",children:"Enable Address Autocomplete"}),"\n",(0,o.jsx)(n.p,{children:"This will enable Address Lookup on the first address line on your address forms."}),"\n",(0,o.jsx)(n.h4,{id:"remove-organization",children:"Remove Organization"}),"\n",(0,o.jsx)(n.p,{children:"This will prevent the organization name from being added to the address line one."}),"\n",(0,o.jsx)(n.h3,{id:"custom-forms-and-configuration",children:"Custom Forms and Configuration"}),"\n",(0,o.jsxs)(n.p,{children:["If you wish to add an additional field or use a custom form, include the parameter name ",(0,o.jsx)(n.a,{href:"/docs/api/find-address",children:"from our documentation"}),"."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-json",children:"[\n  {\n    'line_1': 'input[name=\"billing_street0\"]',\n    'line_2': 'input[name=\"billing_street1\"]',\n    'city': 'input[name=\"billing_city\"]',\n    'state': 'input[name=\"billing_state\"]',\n    'zip_plus_4_code': 'input[name=\"billing_zipcode\"]'\n  }\n]\n\n"})}),"\n",(0,o.jsx)(n.admonition,{type:"info",children:(0,o.jsxs)(n.p,{children:["If you need support, you can either reach out to us via live chat or visit our ",(0,o.jsx)(n.a,{href:"https://addresszen.com/support",children:"support page"}),"."]})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(c,{...e})}):c(e)}},7285(e,n,t){t.d(n,{A:()=>i});const i=t.p+"assets/images/magento-demo-d0cee2f62dde889e9df1e2cc9307c47d.png"},7346(e,n,t){t.d(n,{A:()=>i});const i=t.p+"assets/images/magento-config-5fe40152af754f2e5c7de9cf8cdce956.png"}}]);