This request returns a list of any customer addresses that match the postcode and customer given and if a postcode provider has been set up, it also returns a list of addresses that match the postcode given.
For example, if the request includes just a postcode, the response will return a list of all addresses found that match that postcode. This can be used to allow a customer to input a postcode and return a list of matching addresses to choose from, for example.
If a customer name is included in the request, the response will return both a list of addresses found that match the postcode and a list of customers (with their address and contact details) in the database with a postcode matching the search. This is useful if you want to return the details of a customer who has already booked with you before, so that all of their details, like email address for example, can be retrieved easily.
The structure of the XML will be:
The structure of the XML will be:
<PostcodeLookupRequest>
<LoginDetails>
<Login>TestLogin</Login>
<Password>TestPassword</Password>
</LoginDetails>
<Postcode>W1U 7BU</Postcode>
<Customer>Brown</Customer>
</PostcodeLookupRequest>
<PostcodeLookupResponse>
<ReturnStatus>
<Success>true</Success>
<Exceptions />
</ReturnStatus>
<Addresses>
<Address>
<CustomerTitle>Miss</CustomerTitle>
<CustomerFirstName>Daphne</CustomerFirstName>
<CustomerLastName>Brown</CustomerLastName>
<CustomerID>3</CustomerID>
<Address1>52 Baker Street</Address1>
<TownCity>Manchester</TownCity>
<County />
<Postcode>M8 1PR</Postcode>
<BookingCountryID>3</BookingCountryID>
<CountryISOCode>GBR</CountryISOCode>
<LanguageID>1</LanguageID>
<BuildingID>27355971.00</BuildingID>
<Description>52 Baker Street London</Description>
</Address>
<Address>
<CustomerTitle />
<CustomerFirstName />
<CustomerLastName />
<CustomerID />
<Address1>54 Baker Street</Address1>
<TownCity>London</TownCity>
<County />
<Postcode>W1U 7BU</Postcode>
<BookingCountryID>1</BookingCountryID>
<CountryISOCode>GBR</CountryISOCode>
<LanguageID>1</LanguageID>
<BuildingID>27355981.00</BuildingID>
<Description>54 Baker Street London</Description>
</Address>
<Address>
<CustomerTitle />
<CustomerFirstName />
<CustomerLastName />
<CustomerID />
<Address1>56 Baker Street</Address1>
<TownCity>London</TownCity>
<County />
<Postcode>W1U 7BU</Postcode>
<BookingCountryID>1</BookingCountryID>
<CountryISOCode>GBR</CountryISOCode>
<LanguageID>1</LanguageID>
<BuildingID>27355991.00</BuildingID>
<Description>56 Baker Street London</Description>
</Address>
</Addresses>
</PostcodeLookupResponse>