OnlineAPI Web Service

OnlineAPI

Click here for a complete list of operations.

GetInventory_Signup

For a given Rep#, PriceType (Retail, Wholesale, etc.), and Locale ID (default of 1), one can retrieve all Inventory Items available for signup.

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_Signup"

<?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_Signup xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <SponsorRepNumber>string</SponsorRepNumber>
      <PriceType>string</PriceType>
      <LocaleID>int</LocaleID>
    </GetInventory_Signup>
  </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_SignupResponse xmlns="http://www.securefreedom.com/">
      <GetInventory_SignupResult>
        <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_SignupResult>
    </GetInventory_SignupResponse>
  </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_Signup xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <SponsorRepNumber>string</SponsorRepNumber>
      <PriceType>string</PriceType>
      <LocaleID>int</LocaleID>
    </GetInventory_Signup>
  </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_SignupResponse xmlns="http://www.securefreedom.com/">
      <GetInventory_SignupResult>
        <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_SignupResult>
    </GetInventory_SignupResponse>
  </soap12:Body>
</soap12:Envelope>