Store Locator Admin Console

Store Locator web services

Version 3.17.2

The following web services provide a view of store locator data in XML/json/csv format where applicable. All services are REST-based, and are accessible using a simple HTTP GET request (no additional request parameters are needed). These are read-only services, and so specific authentication is not required. Unless noted otherwise, parameters and formats are NOT case sensitive.

Location Information Service

URL: /storelocator/service/storeinfo/{division}/storeno/{no};jsessionid=zXBkhM7KoAoRdS8MZWG34cWMzUxZbn30HYYznvhO.asp00003-master:Storelocator-Server1

URL: /storelocator/service/storeinfo/{division}/storeno/{no}/{wks};jsessionid=zXBkhM7KoAoRdS8MZWG34cWMzUxZbn30HYYznvhO.asp00003-master:Storelocator-Server1

Description

Provides information about a single location including trading hours and facilities.

Parameters

division - The name of the division e.g. BIGW, DICKSMITH, PETROL
no - The store number e.g. 1234

Location Information Service - extra info

URL: /storelocator/service/storeinfoextra/{division}/storeno/{no};jsessionid=zXBkhM7KoAoRdS8MZWG34cWMzUxZbn30HYYznvhO.asp00003-master:Storelocator-Server1

Description

Provides information about a single location including trading hours, facilities, website URL, and two 'additional info' fields populated with custom data.

Parameters

division - The name of the division e.g. BIGW, DICKSMITH, PETROL
no - The store number e.g. 1234

Location Information Service for Voice and Speech

URL: /storelocator/service/speechstoreinfo/{division}/storeno/{no};jsessionid=zXBkhM7KoAoRdS8MZWG34cWMzUxZbn30HYYznvhO.asp00003-master:Storelocator-Server1

Description

Provides information about a single location including trading hours, facilities, website URL, and two 'additional info' fields populated with custom data, with more friendly format for Voice and Speech applications

Parameters

division - The name of the division e.g. BIGW, DICKSMITH, PETROL
no - The store number e.g. 1234

Location Information Service for Corporate Info

Xml Response URL: /storelocator/service/corporateinfo/country/{country}/division/{divisions}/tradinghours/{tradingHours}/weeks/{number of weeks};jsessionid=zXBkhM7KoAoRdS8MZWG34cWMzUxZbn30HYYznvhO.asp00003-master:Storelocator-Server1

Json Response URL: /storelocator/service/corporateinfo/country/{country}/division/{divisions}/tradinghours/{tradingHours}/weeks/{number of weeks};jsessionid=zXBkhM7KoAoRdS8MZWG34cWMzUxZbn30HYYznvhO.asp00003-master:Storelocator-Server1/json

Description

Provides information about a single location including trading hours, facilities, website URL, and two 'additional info' fields populated with custom data, with more friendly format for Voice and Speech applications

Parameters

country - Country Name e.g. au, nz, all
division - The name of the division separated by pipe symbol e.g. BIGW|DICKSMITH. For all divisions, it should be "all".
tradingHours - Trading Hours. Can be either "current" or "standard".

Postcode Proximity Service

URL: /storelocator/service/proximity/{division}/postcode/{postcode}/range/{range}/max/{max};jsessionid=zXBkhM7KoAoRdS8MZWG34cWMzUxZbn30HYYznvhO.asp00003-master:Storelocator-Server1
URL: /storelocator/service/proximitydetail/{division}/postcode/{postcode}/range/{range}/max/{max};jsessionid=zXBkhM7KoAoRdS8MZWG34cWMzUxZbn30HYYznvhO.asp00003-master:Storelocator-Server1

URL: /storelocator/service/proximity/{division}/postcode/{postcode}/facility/{facitlity}/range/{range}/max/{max};jsessionid=zXBkhM7KoAoRdS8MZWG34cWMzUxZbn30HYYznvhO.asp00003-master:Storelocator-Server1
URL: /storelocator/service/proximitydetail/{division}/postcode/{postcode}/facility/{facitlity}/range/{range}/max/{max};jsessionid=zXBkhM7KoAoRdS8MZWG34cWMzUxZbn30HYYznvhO.asp00003-master:Storelocator-Server1

Description

Provides a list of locations ordered by proximity to a given postcode. Locations closest to the given postcode are listed first, and distances are given in km.

Parameters

division - The name of the division; e.g. BIGW, DICKSMITH, PETROL
postcode - The Aus Post postcode; e.g. 2153
range - The range to search in km; e.g. 100
max - The maximum number of results to show; e.g. 5

Notes

If no locations are found within the given range, the range is reset to 5000.

Suburb Proximity Service

URL: /storelocator/service/proximity/{division}/state/{state}/suburb/{suburb}/range/{range}/max/{max};jsessionid=zXBkhM7KoAoRdS8MZWG34cWMzUxZbn30HYYznvhO.asp00003-master:Storelocator-Server1

URL: /storelocator/service/proximitydetail/{division}/state/{state}/suburb/{suburb}/range/{range}/max/{max};jsessionid=zXBkhM7KoAoRdS8MZWG34cWMzUxZbn30HYYznvhO.asp00003-master:Storelocator-Server1

URL: /storelocator/service/suburbproximity/{division}/{facility}/{short|long};jsessionid=zXBkhM7KoAoRdS8MZWG34cWMzUxZbn30HYYznvhO.asp00003-master:Storelocator-Server1

Description

Provides a list of locations ordered by proximity to a given suburb name. Locations closest to the given suburb are listed first, and distances are given in km.

Parameters

division - The name of the division; e.g. BIGW, DICKSMITH, PETROL
state - The state name; e.g. NSW
suburb - The suburb name; e.g. Baulkham Hills
range - The range to search in km; e.g. 100
max - The maximum number of results to show; e.g. 5

Full Proximity Service

URL: /storelocator/service/proximity/{division}/state/{state}/postcode/{postcode}/suburb/{suburb}/range/{range}/max/{max};jsessionid=zXBkhM7KoAoRdS8MZWG34cWMzUxZbn30HYYznvhO.asp00003-master:Storelocator-Server1

URL: /storelocator/service/proximitydetail/{division}/state/{state}/postcode/{postcode}/suburb/{suburb}/range/{range}/max/{max};jsessionid=zXBkhM7KoAoRdS8MZWG34cWMzUxZbn30HYYznvhO.asp00003-master:Storelocator-Server1

Description

Provides a list of locations ordered by proximity to a given postcode and suburb combination. As a single postcode may contain multiple suburbs, this service allows more specific selection of suburbs than the above services. Locations closest to the given suburb are listed first, and distances are given in km.

Parameters

division - The name of the division; e.g. BIGW, DICKSMITH, PETROL
state - The state name; e.g. NSW
postcode - The Aus Post postcode; e.g. 2153
suburb - The suburb name; e.g. Baulkham Hills
range - The range to search in km; e.g. 100
max - The maximum number of results to show; e.g. 5

Geocode Proximity Service

URL: /storelocator/service/proximity/{division}/latitude/{latitude}/longitude/{longitude}/range/{range}/max/{max};jsessionid=zXBkhM7KoAoRdS8MZWG34cWMzUxZbn30HYYznvhO.asp00003-master:Storelocator-Server1

URL: /storelocator/service/proximitydetail/{division}/latitude/{latitude}/longitude/{longitude}/range/{range}/max/{max};jsessionid=zXBkhM7KoAoRdS8MZWG34cWMzUxZbn30HYYznvhO.asp00003-master:Storelocator-Server1

Description

Provides a list of locations ordered by proximity to a given latitude and longitude coordinate. Locations closest to the given geocode are listed first, and distances are given in km.

Parameters

division - The name of the division; e.g. BIGW, DICKSMITH, PETROL
latitude - The latitude as a decimal number; e.g. -31.12312
longitude - The longitude as a decimal number; e.g. 159.1123
range - The range to search in km; e.g. 100
max - The maximum number of results to show; e.g. 5

Suburb Lookup Service

URL: /storelocator/service/lookup/{searchstring}/{countrycode};jsessionid=zXBkhM7KoAoRdS8MZWG34cWMzUxZbn30HYYznvhO.asp00003-master:Storelocator-Server1

Description

Allows searching for a suburb/postcode given a partial search string and a country code. For example, entering "Bau" would bring up all suburbs whose names begin with the string "bau" (case insensitive). For example, suburbs such as "Baulkham Hills" and "Bauple Forest".

Parameters

searchstring - A partial suburb name or postcode; e.g. PARRA
countrycode - A country code; e.g. AU for Australia and NZ for New Zealand

URL Defaults

URL: /storelocator/service/lookup/{searchstring};jsessionid=zXBkhM7KoAoRdS8MZWG34cWMzUxZbn30HYYznvhO.asp00003-master:Storelocator-Server1

is equivalent of /storelocator/service/lookup/{searchstring};jsessionid=zXBkhM7KoAoRdS8MZWG34cWMzUxZbn30HYYznvhO.asp00003-master:Storelocator-Server1/au

Suburb List Service

URL: /storelocator/service/lookup/suburb/{countrycode}/csv;jsessionid=zXBkhM7KoAoRdS8MZWG34cWMzUxZbn30HYYznvhO.asp00003-master:Storelocator-Server1

Description

Allows listing all suburb/postcode given a country code. For example, entering "AU" would list all suburbs in Australia.

Parameters

countrycode - A country code; e.g. AU for Australia and NZ for New Zealand

Output Format

CSV is output instead of XML. Line break is in Linux/Unix format, instead of Windows.

Location Search Service - Search by Name

URL: /storelocator/service/location/search/{division}/{name};jsessionid=zXBkhM7KoAoRdS8MZWG34cWMzUxZbn30HYYznvhO.asp00003-master:Storelocator-Server1

Description

Allows searching for locations by location name. A partial search string is accepted. For example, entering "Castle" would bring up all locations whose names contain the string "castle" (case insensitive). For example, locations such as "Castle Towers DSE" and "Newcastle DSM".

Parameters

division - The name of the division; e.g. BIGW, DICKSMITH, PETROL
name - A part of the location name; e.g. CASTLE

Location Search Service - Search by Division

URL: /storelocator/service/location/search/{division};jsessionid=zXBkhM7KoAoRdS8MZWG34cWMzUxZbn30HYYznvhO.asp00003-master:Storelocator-Server1

URL: /storelocator/service/corporateinfo/country/{country}/division/{division}/tradinghours/{tradinghours}/weeks/{wk};jsessionid=zXBkhM7KoAoRdS8MZWG34cWMzUxZbn30HYYznvhO.asp00003-master:Storelocator-Server1

Description

Provides a list of all locations which belong a given division.

Parameters

division - The name of the division; e.g. BIGW, DICKSMITH, PETROL
country - country code, e.g. au
tradinghours - e.g. current
wk - number of weeks for each store. e.g. 6

Location Search Service - Search by Facility

URL: /storelocator/service/location/search/{division}/facility/{facility};jsessionid=zXBkhM7KoAoRdS8MZWG34cWMzUxZbn30HYYznvhO.asp00003-master:Storelocator-Server1

Description

Provides a list of all locations that contain a specified facility.

Parameters

division - The name of the division; e.g. BIGW, DICKSMITH, PETROL
facility - The exact name of the facility; e.g. Pet Centre

Location Search Service - Search by Route

URL: /storelocator/service/proximity/{division}/start/{start_address}/end/{end_address}/width/{width};jsessionid=zXBkhM7KoAoRdS8MZWG34cWMzUxZbn30HYYznvhO.asp00003-master:Storelocator-Server1

Description

Provides a list of locations along a route from start address to end address within width Km.

Parameters

division - The name of the division; e.g. BIGW, DICKSMITH, PETROL
addresses - The address; e.g. melbourne,vic,australia
width - The width of path to locate stores, in Km; e.g. 2

Location Search Service - Search by State

URL: /storelocator/service/location/search/{division}/state/{state};jsessionid=zXBkhM7KoAoRdS8MZWG34cWMzUxZbn30HYYznvhO.asp00003-master:Storelocator-Server1

Description

Provide a list of locations in an australian state

Parameters

division - The name of the division; e.g. BIGW, DICKSMITH, PETROL
state - The state code; e.g. vic

 Home