The Loqate commercetools Integration Guide
The Loqate commercetools plugin (loqate-commercetools-b2c-frontend) provides integration between the commercetools platform and the Loqate API.
Overview
The loqate-commercetools repository contains a commercetools plugin that integrates with the Loqate API to provide access to Address Capture, Address Verify, Email Validation, and Phone Validation.
The plugin makes modifications in the following areas:
- Checkout
- My Account
- Registration
The modifications are applied in two areas:
- Backend-for-frontend (BFF): commercetools extensions - used to make the Loqate API calls and handle the responses
- Frontend: React components - used to display the address capture, address verification, email validation, and phone validation features
Feature overview
The following Loqate products are supported:
- Address Capture: suggests addresses based on user input
- Address Verify: verifies address validity
- Email Validation: validates email addresses
- Phone Validation: validates phone numbers
These features can be toggled on or off through project settings.
Please refer to the Feature Overview page for more information on the supported features.
Setup
The Setup Guide provides instructions on how to set up and configure the Loqate commercetools Composable Commerce Plugin.
The Studio Settings page provides instructions on how to configure the Loqate commercetools Composable Commerce Plugin in the Studio.
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
