Postcode Lookup Services Implementation

This article details the parameters available when using the getAddressByPostcode and getAddressById AJAX requests for the Postcode Anywhere service.

Example Implementation

A simple example implementation can be viewed by logging into Aurora and navigating to the following page: www.yourdomain.com/**aurora/orders/postcode**.

Ajax Requests

There are two possible AJAX requests: getAddressByPostcode and getAddressById.

getAddressByPostcode

Find addresses matching a search term.

ParameterExampleRequiredExplanation
postcodeE3 4WEYThe search term to find.

If the LastId is provided, the SearchTerm searches within the results from the LastId.
search_forPostalCodesYFilters the search results.
countryGBRNThe name or ISO 2 or 3 character code for the country to search in.

Most country names will be recognised, but the use of the ISO country code is recommended for clarity.
languageenNThe 2 or 4 character language preference identifier e.g. (en, en-gb, en-us etc).
max_suggestions10NThe maximum number of autocomplete suggestions to return.
max_results10NThe maximum number of results to return.

(Only for use with Capture Plus)
last_id1NThe ID from a previous Find or FindByPosition.

getAddressById

Returns the full address based on the Id.

ParameterExampleRequiredExplanation
idGBR|52509478YThe ID from a Find method to retrieve the detailed address for.