API_v1


Click here for a complete list of operations.

SearchForItem

This operation,returns search results for Products(LIMIT 20)

Test

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

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

<?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>
    <SearchForItem xmlns="http://www.SupermarketAPI.com">
      <APIKEY>string</APIKEY>
      <StoreID>string</StoreID>
      <ItemName>string</ItemName>
    </SearchForItem>
  </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>
    <SearchForItemResponse xmlns="http://www.SupermarketAPI.com">
      <SearchForItemResult>
        <Product>
          <Itemname>string</Itemname>
          <ItemDescription>string</ItemDescription>
          <ItemCategory>string</ItemCategory>
          <ItemID>string</ItemID>
          <ItemImage>string</ItemImage>
          <AisleNumber>string</AisleNumber>
        </Product>
        <Product>
          <Itemname>string</Itemname>
          <ItemDescription>string</ItemDescription>
          <ItemCategory>string</ItemCategory>
          <ItemID>string</ItemID>
          <ItemImage>string</ItemImage>
          <AisleNumber>string</AisleNumber>
        </Product>
      </SearchForItemResult>
    </SearchForItemResponse>
  </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>
    <SearchForItem xmlns="http://www.SupermarketAPI.com">
      <APIKEY>string</APIKEY>
      <StoreID>string</StoreID>
      <ItemName>string</ItemName>
    </SearchForItem>
  </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>
    <SearchForItemResponse xmlns="http://www.SupermarketAPI.com">
      <SearchForItemResult>
        <Product>
          <Itemname>string</Itemname>
          <ItemDescription>string</ItemDescription>
          <ItemCategory>string</ItemCategory>
          <ItemID>string</ItemID>
          <ItemImage>string</ItemImage>
          <AisleNumber>string</AisleNumber>
        </Product>
        <Product>
          <Itemname>string</Itemname>
          <ItemDescription>string</ItemDescription>
          <ItemCategory>string</ItemCategory>
          <ItemID>string</ItemID>
          <ItemImage>string</ItemImage>
          <AisleNumber>string</AisleNumber>
        </Product>
      </SearchForItemResult>
    </SearchForItemResponse>
  </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/SearchForItem?APIKEY=string&StoreID=string&ItemName=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"?>
<ArrayOfProduct xmlns="http://www.SupermarketAPI.com">
  <Product>
    <Itemname>string</Itemname>
    <ItemDescription>string</ItemDescription>
    <ItemCategory>string</ItemCategory>
    <ItemID>string</ItemID>
    <ItemImage>string</ItemImage>
    <AisleNumber>string</AisleNumber>
  </Product>
  <Product>
    <Itemname>string</Itemname>
    <ItemDescription>string</ItemDescription>
    <ItemCategory>string</ItemCategory>
    <ItemID>string</ItemID>
    <ItemImage>string</ItemImage>
    <AisleNumber>string</AisleNumber>
  </Product>
</ArrayOfProduct>

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/SearchForItem HTTP/1.1
Host: supermarketapi.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfProduct xmlns="http://www.SupermarketAPI.com">
  <Product>
    <Itemname>string</Itemname>
    <ItemDescription>string</ItemDescription>
    <ItemCategory>string</ItemCategory>
    <ItemID>string</ItemID>
    <ItemImage>string</ItemImage>
    <AisleNumber>string</AisleNumber>
  </Product>
  <Product>
    <Itemname>string</Itemname>
    <ItemDescription>string</ItemDescription>
    <ItemCategory>string</ItemCategory>
    <ItemID>string</ItemID>
    <ItemImage>string</ItemImage>
    <AisleNumber>string</AisleNumber>
  </Product>
</ArrayOfProduct>