Address API
Usage Restrictions and Deprecation Policy
Written Permission Required
Use of this API without explicit, written permission from the Ingrid Sales Team is strictly prohibited. To request access, please contact our sales department.
Deprecation Notice
Ingrid reserves the right to modify or deprecate any part of the API. In such cases, we will provide at least 12 months’ notice prior to the removal of any functionality, unless a critical security or legal issue necessitates immediate action.
Overview
Welcome to the Address API, a powerful tool designed to empower retailers using Ingrid Checkout by allowing them to craft their custom address form frontends. With Address API, retailers can seamlessly integrate Ingrid's comprehensive and personalized address tools within their platforms.
Key Features of Address API
Customization & Flexibility: Allows retailers to design and implement their address form UI/UX, leveraging Ingrid's backend for comprehensive address solutions.
Seamless Integrations: Easily integrates with a wide array of address validation and autocomplete services, bringing flexibility and efficiency to your address input process.
Optimized Address Options: Utilize smart address logic that dynamically suggests and validates optimal address options, enhancing customer satisfaction and conversion rates.
Smart Address Logic: Automatically finds the best address suggestions tailored to each product, region, and customer, facilitating smart address up-sell and driving higher average order values.
Key Components of Address API
Address Books: Manage user addresses efficiently with endpoints to create, read, update, and delete addresses associated with a user's account. More details can be found on the Address Books page.
Address Suggestions: Enhance the address entry experience by providing real-time address suggestions based on user input, improving accuracy and speed. More details can be found on the Address Suggestions page.
Address Validation: Ensure the accuracy of addresses entered by users by validating them against authoritative data sources and standardizing them for consistency. More details can be found on the Address Validation page.
Sounds great, where to next?
- Backend Integration Guide when you want to integrate quickly,
- Errors when you want to implement error handling or debug your integration,
- Address Books to manage user addresses,
- Address Suggestions to implement address autocomplete and suggestions,
- Address Validation to validate and standardize addresses,
- Reference reference documentation for all API endpoints,