API_v1


Click here for a complete list of operations.

StoresByZip

This operation,returns All Stores within a City and State

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
APIKEY:
ZipCode:

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 /api.asmx HTTP/1.1
Host: supermarketapi.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.SupermarketAPI.com/StoresByZip"

<?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>
    <StoresByZip xmlns="http://www.SupermarketAPI.com">
      <APIKEY>string</APIKEY>
      <ZipCode>string</ZipCode>
    </StoresByZip>
  </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>
    <StoresByZipResponse xmlns="http://www.SupermarketAPI.com">
      <StoresByZipResult>
        <Store>
          <Storename>string</Storename>
          <Address>string</Address>
          <City>string</City>
          <State>string</State>
          <Zip>string</Zip>
          <Phone>string</Phone>
          <StoreId>string</StoreId>
        </Store>
        <Store>
          <Storename>string</Storename>
          <Address>string</Address>
          <City>string</City>
          <State>string</State>
          <Zip>string</Zip>
          <Phone>string</Phone>
          <StoreId>string</StoreId>
        </Store>
      </StoresByZipResult>
    </StoresByZipResponse>
  </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 /api.asmx HTTP/1.1
Host: supermarketapi.com
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>
    <StoresByZip xmlns="http://www.SupermarketAPI.com">
      <APIKEY>string</APIKEY>
      <ZipCode>string</ZipCode>
    </StoresByZip>
  </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>
    <StoresByZipResponse xmlns="http://www.SupermarketAPI.com">
      <StoresByZipResult>
        <Store>
          <Storename>string</Storename>
          <Address>string</Address>
          <City>string</City>
          <State>string</State>
          <Zip>string</Zip>
          <Phone>string</Phone>
          <StoreId>string</StoreId>
        </Store>
        <Store>
          <Storename>string</Storename>
          <Address>string</Address>
          <City>string</City>
          <State>string</State>
          <Zip>string</Zip>
          <Phone>string</Phone>
          <StoreId>string</StoreId>
        </Store>
      </StoresByZipResult>
    </StoresByZipResponse>
  </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 /api.asmx/StoresByZip?APIKEY=string&ZipCode=string HTTP/1.1
Host: supermarketapi.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfStore xmlns="http://www.SupermarketAPI.com">
  <Store>
    <Storename>string</Storename>
    <Address>string</Address>
    <City>string</City>
    <State>string</State>
    <Zip>string</Zip>
    <Phone>string</Phone>
    <StoreId>string</StoreId>
  </Store>
  <Store>
    <Storename>string</Storename>
    <Address>string</Address>
    <City>string</City>
    <State>string</State>
    <Zip>string</Zip>
    <Phone>string</Phone>
    <StoreId>string</StoreId>
  </Store>
</ArrayOfStore>

HTTP POST

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

POST /api.asmx/StoresByZip HTTP/1.1
Host: supermarketapi.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfStore xmlns="http://www.SupermarketAPI.com">
  <Store>
    <Storename>string</Storename>
    <Address>string</Address>
    <City>string</City>
    <State>string</State>
    <Zip>string</Zip>
    <Phone>string</Phone>
    <StoreId>string</StoreId>
  </Store>
  <Store>
    <Storename>string</Storename>
    <Address>string</Address>
    <City>string</City>
    <State>string</State>
    <Zip>string</Zip>
    <Phone>string</Phone>
    <StoreId>string</StoreId>
  </Store>
</ArrayOfStore>