OnlineAPI Web Service

OnlineAPI

Click here for a complete list of operations.

GetInventory_SingleItem

This function allows one to enter the context for a single item and retrieve that item. One can enter the product ID, Rep# or Customer#, PriceType (retail, wholesale, etc.), and the Locale ID (default 1) to retrieve the item. Note: Should a Price type not exists for that product ID for the current rank of the Rep or Customer's Rep, this function will not return the item as the system will not allow that item to be purchased for the given Rep/Customer. Deprecation Note: This API has been deprecated in favor of our REST API: ~/api/inventory/InventoryShopping.

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

<?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>
    <GetInventory_SingleItem xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <RepNumber>string</RepNumber>
      <CustomerNumber>string</CustomerNumber>
      <ProductID>string</ProductID>
      <PriceType>string</PriceType>
      <LocaleID>int</LocaleID>
    </GetInventory_SingleItem>
  </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>
    <GetInventory_SingleItemResponse xmlns="http://www.securefreedom.com/">
      <GetInventory_SingleItemResult>
        <GetInventoryReturn>
          <ProductID>string</ProductID>
          <Description>string</Description>
          <Explanation>string</Explanation>
          <LongExplanation>string</LongExplanation>
          <Price>double</Price>
          <Volume>double</Volume>
          <Volume2>double</Volume2>
          <Volume3>double</Volume3>
          <Volume4>double</Volume4>
          <OtherPrice>double</OtherPrice>
          <OtherPrice2>double</OtherPrice2>
          <OtherPrice3>double</OtherPrice3>
          <OtherPrice4>double</OtherPrice4>
          <Compare>double</Compare>
          <FeaturedItem>int</FeaturedItem>
          <SmallImage>string</SmallImage>
          <LargeImage>string</LargeImage>
          <CategoryID>int</CategoryID>
          <Category>string</Category>
          <SubCategory>string</SubCategory>
          <LocaleID>string</LocaleID>
          <OnHand>int</OnHand>
        </GetInventoryReturn>
        <GetInventoryReturn>
          <ProductID>string</ProductID>
          <Description>string</Description>
          <Explanation>string</Explanation>
          <LongExplanation>string</LongExplanation>
          <Price>double</Price>
          <Volume>double</Volume>
          <Volume2>double</Volume2>
          <Volume3>double</Volume3>
          <Volume4>double</Volume4>
          <OtherPrice>double</OtherPrice>
          <OtherPrice2>double</OtherPrice2>
          <OtherPrice3>double</OtherPrice3>
          <OtherPrice4>double</OtherPrice4>
          <Compare>double</Compare>
          <FeaturedItem>int</FeaturedItem>
          <SmallImage>string</SmallImage>
          <LargeImage>string</LargeImage>
          <CategoryID>int</CategoryID>
          <Category>string</Category>
          <SubCategory>string</SubCategory>
          <LocaleID>string</LocaleID>
          <OnHand>int</OnHand>
        </GetInventoryReturn>
      </GetInventory_SingleItemResult>
    </GetInventory_SingleItemResponse>
  </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 /adapturedemo/webservice/OnlineAPI.asmx HTTP/1.1
Host: api.securefreedom.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>
    <GetInventory_SingleItem xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <RepNumber>string</RepNumber>
      <CustomerNumber>string</CustomerNumber>
      <ProductID>string</ProductID>
      <PriceType>string</PriceType>
      <LocaleID>int</LocaleID>
    </GetInventory_SingleItem>
  </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>
    <GetInventory_SingleItemResponse xmlns="http://www.securefreedom.com/">
      <GetInventory_SingleItemResult>
        <GetInventoryReturn>
          <ProductID>string</ProductID>
          <Description>string</Description>
          <Explanation>string</Explanation>
          <LongExplanation>string</LongExplanation>
          <Price>double</Price>
          <Volume>double</Volume>
          <Volume2>double</Volume2>
          <Volume3>double</Volume3>
          <Volume4>double</Volume4>
          <OtherPrice>double</OtherPrice>
          <OtherPrice2>double</OtherPrice2>
          <OtherPrice3>double</OtherPrice3>
          <OtherPrice4>double</OtherPrice4>
          <Compare>double</Compare>
          <FeaturedItem>int</FeaturedItem>
          <SmallImage>string</SmallImage>
          <LargeImage>string</LargeImage>
          <CategoryID>int</CategoryID>
          <Category>string</Category>
          <SubCategory>string</SubCategory>
          <LocaleID>string</LocaleID>
          <OnHand>int</OnHand>
        </GetInventoryReturn>
        <GetInventoryReturn>
          <ProductID>string</ProductID>
          <Description>string</Description>
          <Explanation>string</Explanation>
          <LongExplanation>string</LongExplanation>
          <Price>double</Price>
          <Volume>double</Volume>
          <Volume2>double</Volume2>
          <Volume3>double</Volume3>
          <Volume4>double</Volume4>
          <OtherPrice>double</OtherPrice>
          <OtherPrice2>double</OtherPrice2>
          <OtherPrice3>double</OtherPrice3>
          <OtherPrice4>double</OtherPrice4>
          <Compare>double</Compare>
          <FeaturedItem>int</FeaturedItem>
          <SmallImage>string</SmallImage>
          <LargeImage>string</LargeImage>
          <CategoryID>int</CategoryID>
          <Category>string</Category>
          <SubCategory>string</SubCategory>
          <LocaleID>string</LocaleID>
          <OnHand>int</OnHand>
        </GetInventoryReturn>
      </GetInventory_SingleItemResult>
    </GetInventory_SingleItemResponse>
  </soap12:Body>
</soap12:Envelope>