The following guide provides illustrations to explain:
The address finder widget is responsible for orchestrating the user's input on your website's address fields and interacting with Addy's address finder API to search for address suggestions.
There are multiple ways to deploy the address finder widget on your website:
After a search request is made in step 1, the address finder API will retrieve a list of address suggestions that match the user's input. The widget will use the API response to display an autocomplete list of addresses that the user can choose from. The user can use their keyboard or mouse to move up and down the list of address suggestions.
A user can validate their address by clicking on an address suggestion. When the user clicks on their address, the widget will make a call to the address details API and retrieve detailed information about the address such as the suburb, city, postcode and geo coordinates.
The address details API will securely log that a completed address request was made and subtract it from the 1,500 free completed address lookup requests available for that month. When a website exceeds the 1,500 free completed address requests per month, additional requests will count towards that month's invoice. For example, if 2,000 completed address requests are made per month, you'll be charged for 500 completed address requests and an invoice of $10.00 will be generated. Use the pricing calculator to estimate your monthly usage and cost based on the number of orders you may receive in a month.
The address finder widget will use the response from the address details API in step 3 above to populate all of the registered address fields on the page.
Using the address finder widget and address APIs, users can complete address forms fast and accurately. Businesses and users will have confidence that goods will be delivered to the right place with a complete, consistent and validated address.