iSAMS Stores API Web Service

iSAMS Stores API

Click here for a complete list of operations.

ListStoresByArea

List all stores in an area.

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 /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/ListStoresByArea"

<?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>
    <ListStoresByArea xmlns="http://www.estaronline.com/api/">
      <authenticationToken>string</authenticationToken>
      <area>
        <Name>string</Name>
        <Country>string</Country>
      </area>
    </ListStoresByArea>
  </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>
    <ListStoresByAreaResponse xmlns="http://www.estaronline.com/api/">
      <ListStoresByAreaResult>
        <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>
      </ListStoresByAreaResult>
    </ListStoresByAreaResponse>
  </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>
    <ListStoresByArea xmlns="http://www.estaronline.com/api/">
      <authenticationToken>string</authenticationToken>
      <area>
        <Name>string</Name>
        <Country>string</Country>
      </area>
    </ListStoresByArea>
  </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>
    <ListStoresByAreaResponse xmlns="http://www.estaronline.com/api/">
      <ListStoresByAreaResult>
        <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>
      </ListStoresByAreaResult>
    </ListStoresByAreaResponse>
  </soap12:Body>
</soap12:Envelope>