iSAMS Stores API Web Service

iSAMS Stores API

Click here for a complete list of operations.

ListStoresBySatellite

List all stores linked to a satellite.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

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 /global/api/Stores.asmx HTTP/1.1
Host: demo.viare.io
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.estaronline.com/api/ListStoresBySatellite"

<?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>
    <ListStoresBySatellite xmlns="http://www.estaronline.com/api/">
      <authenticationToken>string</authenticationToken>
      <wsID>int</wsID>
    </ListStoresBySatellite>
  </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>
    <ListStoresBySatelliteResponse xmlns="http://www.estaronline.com/api/">
      <ListStoresBySatelliteResult>
        <Data>
          <Store>
            <ID>int</ID>
            <Active>boolean</Active>
            <BranchCode>string</BranchCode>
            <Name>string</Name>
            <Manager>string</Manager>
            <Area xsi:nil="true" />
            <Latitude>string</Latitude>
            <Longitude>string</Longitude>
            <Address>string</Address>
            <AddressDetails xsi:nil="true" />
            <Details>string</Details>
            <Type>string</Type>
            <Email>string</Email>
            <StoreLocator>boolean</StoreLocator>
            <StoreAvailability>boolean</StoreAvailability>
            <ClickAndCollect>boolean</ClickAndCollect>
          </Store>
          <Store>
            <ID>int</ID>
            <Active>boolean</Active>
            <BranchCode>string</BranchCode>
            <Name>string</Name>
            <Manager>string</Manager>
            <Area xsi:nil="true" />
            <Latitude>string</Latitude>
            <Longitude>string</Longitude>
            <Address>string</Address>
            <AddressDetails xsi:nil="true" />
            <Details>string</Details>
            <Type>string</Type>
            <Email>string</Email>
            <StoreLocator>boolean</StoreLocator>
            <StoreAvailability>boolean</StoreAvailability>
            <ClickAndCollect>boolean</ClickAndCollect>
          </Store>
        </Data>
      </ListStoresBySatelliteResult>
    </ListStoresBySatelliteResponse>
  </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 /global/api/Stores.asmx HTTP/1.1
Host: demo.viare.io
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>
    <ListStoresBySatellite xmlns="http://www.estaronline.com/api/">
      <authenticationToken>string</authenticationToken>
      <wsID>int</wsID>
    </ListStoresBySatellite>
  </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>
    <ListStoresBySatelliteResponse xmlns="http://www.estaronline.com/api/">
      <ListStoresBySatelliteResult>
        <Data>
          <Store>
            <ID>int</ID>
            <Active>boolean</Active>
            <BranchCode>string</BranchCode>
            <Name>string</Name>
            <Manager>string</Manager>
            <Area xsi:nil="true" />
            <Latitude>string</Latitude>
            <Longitude>string</Longitude>
            <Address>string</Address>
            <AddressDetails xsi:nil="true" />
            <Details>string</Details>
            <Type>string</Type>
            <Email>string</Email>
            <StoreLocator>boolean</StoreLocator>
            <StoreAvailability>boolean</StoreAvailability>
            <ClickAndCollect>boolean</ClickAndCollect>
          </Store>
          <Store>
            <ID>int</ID>
            <Active>boolean</Active>
            <BranchCode>string</BranchCode>
            <Name>string</Name>
            <Manager>string</Manager>
            <Area xsi:nil="true" />
            <Latitude>string</Latitude>
            <Longitude>string</Longitude>
            <Address>string</Address>
            <AddressDetails xsi:nil="true" />
            <Details>string</Details>
            <Type>string</Type>
            <Email>string</Email>
            <StoreLocator>boolean</StoreLocator>
            <StoreAvailability>boolean</StoreAvailability>
            <ClickAndCollect>boolean</ClickAndCollect>
          </Store>
        </Data>
      </ListStoresBySatelliteResult>
    </ListStoresBySatelliteResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /global/api/Stores.asmx/ListStoresBySatellite?authenticationToken=string&wsID=string HTTP/1.1
Host: demo.viare.io

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

<?xml version="1.0" encoding="utf-8"?>
<StoresApiResponse xmlns="http://www.estaronline.com/api/">
  <Data>
    <Store>
      <ID>int</ID>
      <Active>boolean</Active>
      <BranchCode>string</BranchCode>
      <Name>string</Name>
      <Manager>string</Manager>
      <Area>
        <Name>string</Name>
        <Country>string</Country>
      </Area>
      <Latitude>string</Latitude>
      <Longitude>string</Longitude>
      <Address>string</Address>
      <AddressDetails>
        <Company>string</Company>
        <Street>string</Street>
        <Suburb>string</Suburb>
        <City>string</City>
        <State>string</State>
        <Postcode>string</Postcode>
        <ContactPhone>string</ContactPhone>
      </AddressDetails>
      <Details>string</Details>
      <Type>string</Type>
      <Email>string</Email>
      <StoreLocator>boolean</StoreLocator>
      <StoreAvailability>boolean</StoreAvailability>
      <ClickAndCollect>boolean</ClickAndCollect>
    </Store>
    <Store>
      <ID>int</ID>
      <Active>boolean</Active>
      <BranchCode>string</BranchCode>
      <Name>string</Name>
      <Manager>string</Manager>
      <Area>
        <Name>string</Name>
        <Country>string</Country>
      </Area>
      <Latitude>string</Latitude>
      <Longitude>string</Longitude>
      <Address>string</Address>
      <AddressDetails>
        <Company>string</Company>
        <Street>string</Street>
        <Suburb>string</Suburb>
        <City>string</City>
        <State>string</State>
        <Postcode>string</Postcode>
        <ContactPhone>string</ContactPhone>
      </AddressDetails>
      <Details>string</Details>
      <Type>string</Type>
      <Email>string</Email>
      <StoreLocator>boolean</StoreLocator>
      <StoreAvailability>boolean</StoreAvailability>
      <ClickAndCollect>boolean</ClickAndCollect>
    </Store>
  </Data>
</StoresApiResponse>

HTTP POST

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

POST /global/api/Stores.asmx/ListStoresBySatellite HTTP/1.1
Host: demo.viare.io
Content-Type: application/x-www-form-urlencoded
Content-Length: length

authenticationToken=string&wsID=string

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

<?xml version="1.0" encoding="utf-8"?>
<StoresApiResponse xmlns="http://www.estaronline.com/api/">
  <Data>
    <Store>
      <ID>int</ID>
      <Active>boolean</Active>
      <BranchCode>string</BranchCode>
      <Name>string</Name>
      <Manager>string</Manager>
      <Area>
        <Name>string</Name>
        <Country>string</Country>
      </Area>
      <Latitude>string</Latitude>
      <Longitude>string</Longitude>
      <Address>string</Address>
      <AddressDetails>
        <Company>string</Company>
        <Street>string</Street>
        <Suburb>string</Suburb>
        <City>string</City>
        <State>string</State>
        <Postcode>string</Postcode>
        <ContactPhone>string</ContactPhone>
      </AddressDetails>
      <Details>string</Details>
      <Type>string</Type>
      <Email>string</Email>
      <StoreLocator>boolean</StoreLocator>
      <StoreAvailability>boolean</StoreAvailability>
      <ClickAndCollect>boolean</ClickAndCollect>
    </Store>
    <Store>
      <ID>int</ID>
      <Active>boolean</Active>
      <BranchCode>string</BranchCode>
      <Name>string</Name>
      <Manager>string</Manager>
      <Area>
        <Name>string</Name>
        <Country>string</Country>
      </Area>
      <Latitude>string</Latitude>
      <Longitude>string</Longitude>
      <Address>string</Address>
      <AddressDetails>
        <Company>string</Company>
        <Street>string</Street>
        <Suburb>string</Suburb>
        <City>string</City>
        <State>string</State>
        <Postcode>string</Postcode>
        <ContactPhone>string</ContactPhone>
      </AddressDetails>
      <Details>string</Details>
      <Type>string</Type>
      <Email>string</Email>
      <StoreLocator>boolean</StoreLocator>
      <StoreAvailability>boolean</StoreAvailability>
      <ClickAndCollect>boolean</ClickAndCollect>
    </Store>
  </Data>
</StoresApiResponse>

Parameter	Value
authenticationToken:
wsID: