About this integration
The Loqate commercetools plugin (loqate-commercetools) integrates the commercetools platform with the Loqate API to provide Address Capture, Address Verify, Email Validation and Phone Validation in the Checkout, My Account and Registration flows.
The modifications are applied in two areas:
- Backend-for-frontend (BFF): commercetools extensions that make the Loqate API calls and handle the responses
- Frontend: React components that display the Loqate features to your customers
Supported Loqate Services
Each service can be toggled on or off through project settings. The configuration options below are set in Studio settings.- Address Capture
- Address Verify
- Email Validation
- Phone Validation
Type-Ahead Address Lookup
Address Capture suggests possible addresses based on user input.How it works:- Calls to the Find endpoint are made continuously until an address of type
Addressis found - If the type is
Container, the system continues making calls to the Find endpoint - Once an address of type
Addressis found, the Retrieve endpoint is called to capture the full address details
LOQATE_IP_TO_COUNTRY_ENABLED- toggle for IP to Country functionalityLOQATE_ADDRESS_LOOKUP_CHECKOUT- toggle for address lookup during checkoutLOQATE_ADDRESS_LOOKUP_MY_ACCOUNT- toggle for address lookup on the My Account pageCHECKOUT_ADDRESS_REQUEST_LIMIT- debounce time for address capture requestsRESTRICTED_COUNTRIES- list of restricted country ISO2 codes to exclude from address capture suggestions
Setup guide
Install the plugin and apply the backend-for-frontend and frontend changes
Studio settings
Configure the plugin in commercetools Frontend Studio
Integrate in 3 steps
1) Get your API key 2) Clone the repository 3) Configure and integrate
Get your API key, then start from the reference implementation
Clone the repository, configure the project in Studio, and carry the changes over to your own project.
Additional Resources
Disclaimers
The loqate-commercetools repository demonstrates the integration of Loqate Address Capture, Address Verify, Email Validation and Phone Validation features with commercetools. It is to be used as a reference implementation for your own integration - it is not intended to be used as is in a production environment. Please refer to the Setup Guide for instructions on the changes required to carry over the Loqate commercetools integration into your own project. It uses the commercetools Frontend B2C template as a base, specifically the latest as of 3 June 2024. This plugin:- Does not aim to keep up with the latest changes in the commercetools frontend template, but rather to provide a reference implementation
- Should not be cloned and used as is in a production environment. It is recommended to use it as a reference and adapt it to your own needs by copying the relevant parts of the code and applying them to the merchant’s implementation
- Does not aim to fix any bugs or issues in the commercetools frontend template. If you encounter any issues related with the B2C Frontend Template, please refer to the commercetools documentation
- Is not responsible for any bugs or issues coming from the commercetools B2C Frontend Template, nor any customizations made to it and does not aim to fix them. You should refer to the commercetools documentation for support for any issues related to the specific version of the commercetools B2C Frontend Template that you are using
- Does not take an opinion of the flow you should support in your store - it applies changes to the out of the box checkout, my account and registration flows
Pricing
View Pricing Plans
Flexible plans starting with a 45-day free trial. Choose the plan that fits your business needs.
Frequently Asked Questions
Can I use the plugin as-is in production?
Can I use the plugin as-is in production?
No. The plugin is a reference implementation. Get the latest version of the commercetools B2C Frontend template and apply the backend-for-frontend and frontend changes described in the setup guide on top of your existing implementation.
What do I need before I start?
What do I need before I start?
Node.js 18.16.0 or higher, Yarn 1.22.19 or higher, a commercetools project, commercetools Frontend Studio, and a Loqate API key.
Which parts of my store does it change?
Which parts of my store does it change?
The plugin modifies the out-of-the-box Checkout, My Account and Registration flows. It doesn’t take an opinion on which flows you should support in your store.
Can I turn individual features on and off?
Can I turn individual features on and off?
Yes. Each feature can be toggled per area through the project settings. See Studio settings for the full list.
Still have questions or need support? Send us an email