StoreLocator Web Service

StoreLocator

Click here for a complete list of operations.

GetLocationByMaxDistance

Retrieve locations near a geographic point specified by lat/lng.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /services/storelocator.asmx HTTP/1.1
Host: locator.coles.com.au
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://locator.coles.com.au/services/GetLocationByMaxDistance"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <ServiceAuthHeader xmlns="http://locator.coles.com.au/services/">
      <Username>string</Username>
      <Password>string</Password>
    </ServiceAuthHeader>
  </soap:Header>
  <soap:Body>
    <GetLocationByMaxDistance xmlns="http://locator.coles.com.au/services/">
      <latitude>decimal</latitude>
      <longitude>decimal</longitude>
      <brandIDs>
        <string>string</string>
        <string>string</string>
      </brandIDs>
    </GetLocationByMaxDistance>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetLocationByMaxDistanceResponse xmlns="http://locator.coles.com.au/services/">
      <GetLocationByMaxDistanceResult>
        <Location>
          <LocationID>int</LocationID>
          <BrandID>int</BrandID>
          <StoreID>int</StoreID>
          <Latitude>double</Latitude>
          <Longitude>double</Longitude>
          <StoreName>string</StoreName>
          <Address>string</Address>
          <Suburb>string</Suburb>
          <Postcode>string</Postcode>
          <State>string</State>
          <Phone>string</Phone>
          <Distance>double</Distance>
          <Fax>string</Fax>
          <LocationFeatures>
            <LocationFeature xsi:nil="true" />
            <LocationFeature xsi:nil="true" />
          </LocationFeatures>
          <OpeningHours>
            <MondayOpen>string</MondayOpen>
            <MondayClose>string</MondayClose>
            <TuesdayOpen>string</TuesdayOpen>
            <TuesdayClose>string</TuesdayClose>
            <WednesdayOpen>string</WednesdayOpen>
            <WednesdayClose>string</WednesdayClose>
            <ThursdayOpen>string</ThursdayOpen>
            <ThursdayClose>string</ThursdayClose>
            <FridayOpen>string</FridayOpen>
            <FridayClose>string</FridayClose>
            <SaturdayOpen>string</SaturdayOpen>
            <SaturdayClose>string</SaturdayClose>
            <SundayOpen>string</SundayOpen>
            <SundayClose>string</SundayClose>
          </OpeningHours>
          <OperationalInfo>
            <StoreManager>string</StoreManager>
            <AreaRegion>string</AreaRegion>
            <AreaRegionMgr>string</AreaRegionMgr>
            <RegionZone>string</RegionZone>
            <RegionZoneMgr>string</RegionZoneMgr>
          </OperationalInfo>
          <OpeningHoursExceptions>
            <OpeningHoursException xsi:nil="true" />
            <OpeningHoursException xsi:nil="true" />
          </OpeningHoursExceptions>
          <IsOpen>boolean</IsOpen>
          <OpeningDate>dateTime</OpeningDate>
          <ClosingDate>dateTime</ClosingDate>
        </Location>
        <Location>
          <LocationID>int</LocationID>
          <BrandID>int</BrandID>
          <StoreID>int</StoreID>
          <Latitude>double</Latitude>
          <Longitude>double</Longitude>
          <StoreName>string</StoreName>
          <Address>string</Address>
          <Suburb>string</Suburb>
          <Postcode>string</Postcode>
          <State>string</State>
          <Phone>string</Phone>
          <Distance>double</Distance>
          <Fax>string</Fax>
          <LocationFeatures>
            <LocationFeature xsi:nil="true" />
            <LocationFeature xsi:nil="true" />
          </LocationFeatures>
          <OpeningHours>
            <MondayOpen>string</MondayOpen>
            <MondayClose>string</MondayClose>
            <TuesdayOpen>string</TuesdayOpen>
            <TuesdayClose>string</TuesdayClose>
            <WednesdayOpen>string</WednesdayOpen>
            <WednesdayClose>string</WednesdayClose>
            <ThursdayOpen>string</ThursdayOpen>
            <ThursdayClose>string</ThursdayClose>
            <FridayOpen>string</FridayOpen>
            <FridayClose>string</FridayClose>
            <SaturdayOpen>string</SaturdayOpen>
            <SaturdayClose>string</SaturdayClose>
            <SundayOpen>string</SundayOpen>
            <SundayClose>string</SundayClose>
          </OpeningHours>
          <OperationalInfo>
            <StoreManager>string</StoreManager>
            <AreaRegion>string</AreaRegion>
            <AreaRegionMgr>string</AreaRegionMgr>
            <RegionZone>string</RegionZone>
            <RegionZoneMgr>string</RegionZoneMgr>
          </OperationalInfo>
          <OpeningHoursExceptions>
            <OpeningHoursException xsi:nil="true" />
            <OpeningHoursException xsi:nil="true" />
          </OpeningHoursExceptions>
          <IsOpen>boolean</IsOpen>
          <OpeningDate>dateTime</OpeningDate>
          <ClosingDate>dateTime</ClosingDate>
        </Location>
      </GetLocationByMaxDistanceResult>
    </GetLocationByMaxDistanceResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /services/storelocator.asmx HTTP/1.1
Host: locator.coles.com.au
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <ServiceAuthHeader xmlns="http://locator.coles.com.au/services/">
      <Username>string</Username>
      <Password>string</Password>
    </ServiceAuthHeader>
  </soap12:Header>
  <soap12:Body>
    <GetLocationByMaxDistance xmlns="http://locator.coles.com.au/services/">
      <latitude>decimal</latitude>
      <longitude>decimal</longitude>
      <brandIDs>
        <string>string</string>
        <string>string</string>
      </brandIDs>
    </GetLocationByMaxDistance>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetLocationByMaxDistanceResponse xmlns="http://locator.coles.com.au/services/">
      <GetLocationByMaxDistanceResult>
        <Location>
          <LocationID>int</LocationID>
          <BrandID>int</BrandID>
          <StoreID>int</StoreID>
          <Latitude>double</Latitude>
          <Longitude>double</Longitude>
          <StoreName>string</StoreName>
          <Address>string</Address>
          <Suburb>string</Suburb>
          <Postcode>string</Postcode>
          <State>string</State>
          <Phone>string</Phone>
          <Distance>double</Distance>
          <Fax>string</Fax>
          <LocationFeatures>
            <LocationFeature xsi:nil="true" />
            <LocationFeature xsi:nil="true" />
          </LocationFeatures>
          <OpeningHours>
            <MondayOpen>string</MondayOpen>
            <MondayClose>string</MondayClose>
            <TuesdayOpen>string</TuesdayOpen>
            <TuesdayClose>string</TuesdayClose>
            <WednesdayOpen>string</WednesdayOpen>
            <WednesdayClose>string</WednesdayClose>
            <ThursdayOpen>string</ThursdayOpen>
            <ThursdayClose>string</ThursdayClose>
            <FridayOpen>string</FridayOpen>
            <FridayClose>string</FridayClose>
            <SaturdayOpen>string</SaturdayOpen>
            <SaturdayClose>string</SaturdayClose>
            <SundayOpen>string</SundayOpen>
            <SundayClose>string</SundayClose>
          </OpeningHours>
          <OperationalInfo>
            <StoreManager>string</StoreManager>
            <AreaRegion>string</AreaRegion>
            <AreaRegionMgr>string</AreaRegionMgr>
            <RegionZone>string</RegionZone>
            <RegionZoneMgr>string</RegionZoneMgr>
          </OperationalInfo>
          <OpeningHoursExceptions>
            <OpeningHoursException xsi:nil="true" />
            <OpeningHoursException xsi:nil="true" />
          </OpeningHoursExceptions>
          <IsOpen>boolean</IsOpen>
          <OpeningDate>dateTime</OpeningDate>
          <ClosingDate>dateTime</ClosingDate>
        </Location>
        <Location>
          <LocationID>int</LocationID>
          <BrandID>int</BrandID>
          <StoreID>int</StoreID>
          <Latitude>double</Latitude>
          <Longitude>double</Longitude>
          <StoreName>string</StoreName>
          <Address>string</Address>
          <Suburb>string</Suburb>
          <Postcode>string</Postcode>
          <State>string</State>
          <Phone>string</Phone>
          <Distance>double</Distance>
          <Fax>string</Fax>
          <LocationFeatures>
            <LocationFeature xsi:nil="true" />
            <LocationFeature xsi:nil="true" />
          </LocationFeatures>
          <OpeningHours>
            <MondayOpen>string</MondayOpen>
            <MondayClose>string</MondayClose>
            <TuesdayOpen>string</TuesdayOpen>
            <TuesdayClose>string</TuesdayClose>
            <WednesdayOpen>string</WednesdayOpen>
            <WednesdayClose>string</WednesdayClose>
            <ThursdayOpen>string</ThursdayOpen>
            <ThursdayClose>string</ThursdayClose>
            <FridayOpen>string</FridayOpen>
            <FridayClose>string</FridayClose>
            <SaturdayOpen>string</SaturdayOpen>
            <SaturdayClose>string</SaturdayClose>
            <SundayOpen>string</SundayOpen>
            <SundayClose>string</SundayClose>
          </OpeningHours>
          <OperationalInfo>
            <StoreManager>string</StoreManager>
            <AreaRegion>string</AreaRegion>
            <AreaRegionMgr>string</AreaRegionMgr>
            <RegionZone>string</RegionZone>
            <RegionZoneMgr>string</RegionZoneMgr>
          </OperationalInfo>
          <OpeningHoursExceptions>
            <OpeningHoursException xsi:nil="true" />
            <OpeningHoursException xsi:nil="true" />
          </OpeningHoursExceptions>
          <IsOpen>boolean</IsOpen>
          <OpeningDate>dateTime</OpeningDate>
          <ClosingDate>dateTime</ClosingDate>
        </Location>
      </GetLocationByMaxDistanceResult>
    </GetLocationByMaxDistanceResponse>
  </soap12:Body>
</soap12:Envelope>