OnlineAPI Web Service

OnlineAPI

Click here for a complete list of operations.

GetInventory_ProductSearch_v2

For a given Rep# or Customer#, PriceType (Retail, wholesale, etc.), Locale ID (default of 1), and Country (USA, etc.) one can search for an Inventory Item for a given search term and/or a price range. 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.bydesign.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.securefreedom.com/GetInventory_ProductSearch_v2"

<?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_ProductSearch_v2 xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <RepNumber>string</RepNumber>
      <CustomerNumber>string</CustomerNumber>
      <PriceType>string</PriceType>
      <LocaleID>int</LocaleID>
      <SearchTerm>string</SearchTerm>
      <MinPrice>double</MinPrice>
      <MaxPrice>double</MaxPrice>
      <Country>string</Country>
    </GetInventory_ProductSearch_v2>
  </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_ProductSearch_v2Response xmlns="http://www.securefreedom.com/">
      <GetInventory_ProductSearch_v2Result>
        <GetInventoryReturn_v2>
          <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>
          <QtyOptions>string</QtyOptions>
          <CurrencyTypeID>int</CurrencyTypeID>
          <CurrencyType>string</CurrencyType>
          <DisplayLocale>string</DisplayLocale>
          <DisplayLocale_Net>string</DisplayLocale_Net>
        </GetInventoryReturn_v2>
        <GetInventoryReturn_v2>
          <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>
          <QtyOptions>string</QtyOptions>
          <CurrencyTypeID>int</CurrencyTypeID>
          <CurrencyType>string</CurrencyType>
          <DisplayLocale>string</DisplayLocale>
          <DisplayLocale_Net>string</DisplayLocale_Net>
        </GetInventoryReturn_v2>
      </GetInventory_ProductSearch_v2Result>
    </GetInventory_ProductSearch_v2Response>
  </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.bydesign.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_ProductSearch_v2 xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <RepNumber>string</RepNumber>
      <CustomerNumber>string</CustomerNumber>
      <PriceType>string</PriceType>
      <LocaleID>int</LocaleID>
      <SearchTerm>string</SearchTerm>
      <MinPrice>double</MinPrice>
      <MaxPrice>double</MaxPrice>
      <Country>string</Country>
    </GetInventory_ProductSearch_v2>
  </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_ProductSearch_v2Response xmlns="http://www.securefreedom.com/">
      <GetInventory_ProductSearch_v2Result>
        <GetInventoryReturn_v2>
          <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>
          <QtyOptions>string</QtyOptions>
          <CurrencyTypeID>int</CurrencyTypeID>
          <CurrencyType>string</CurrencyType>
          <DisplayLocale>string</DisplayLocale>
          <DisplayLocale_Net>string</DisplayLocale_Net>
        </GetInventoryReturn_v2>
        <GetInventoryReturn_v2>
          <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>
          <QtyOptions>string</QtyOptions>
          <CurrencyTypeID>int</CurrencyTypeID>
          <CurrencyType>string</CurrencyType>
          <DisplayLocale>string</DisplayLocale>
          <DisplayLocale_Net>string</DisplayLocale_Net>
        </GetInventoryReturn_v2>
      </GetInventory_ProductSearch_v2Result>
    </GetInventory_ProductSearch_v2Response>
  </soap12:Body>
</soap12:Envelope>