FindLocations Method

Finds Canada Post location(s) based on the input data.

Syntax

canadapostaddress.findLocations([callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Searches for nearby Canada Post locations.

Searching can be done based on a variety of inputs. If GeographicCoordinates is set, the coordinates will be used as the search criteria. If GeographicCoordinates is not set, then the PostalCode will be used. If neither is set, then Address1, City, and Province will be used as the search criteria.

If Address1 is set, it should only contain the street name. If a street number is provided, the request will fail.

Inspect the Location* properties for information about the returned locations.