OnlineAPI Web Service

OnlineAPI

Click here for a complete list of operations.

OnlineOrder_GetItems

This will return the list of items that have been added to an online order id. This is how one can retrieve volume and other prices (compare/etc.)

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

<?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>
    <OnlineOrder_GetItems xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <OnlineOrderID>int</OnlineOrderID>
    </OnlineOrder_GetItems>
  </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>
    <OnlineOrder_GetItemsResponse xmlns="http://www.securefreedom.com/">
      <OnlineOrder_GetItemsResult>
        <OrderItems>
          <OnlineOrderDetailID>int</OnlineOrderDetailID>
          <ProductID>string</ProductID>
          <PriceID>int</PriceID>
          <Quantity>int</Quantity>
          <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>
        </OrderItems>
        <OrderItems>
          <OnlineOrderDetailID>int</OnlineOrderDetailID>
          <ProductID>string</ProductID>
          <PriceID>int</PriceID>
          <Quantity>int</Quantity>
          <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>
        </OrderItems>
      </OnlineOrder_GetItemsResult>
    </OnlineOrder_GetItemsResponse>
  </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>
    <OnlineOrder_GetItems xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <OnlineOrderID>int</OnlineOrderID>
    </OnlineOrder_GetItems>
  </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>
    <OnlineOrder_GetItemsResponse xmlns="http://www.securefreedom.com/">
      <OnlineOrder_GetItemsResult>
        <OrderItems>
          <OnlineOrderDetailID>int</OnlineOrderDetailID>
          <ProductID>string</ProductID>
          <PriceID>int</PriceID>
          <Quantity>int</Quantity>
          <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>
        </OrderItems>
        <OrderItems>
          <OnlineOrderDetailID>int</OnlineOrderDetailID>
          <ProductID>string</ProductID>
          <PriceID>int</PriceID>
          <Quantity>int</Quantity>
          <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>
        </OrderItems>
      </OnlineOrder_GetItemsResult>
    </OnlineOrder_GetItemsResponse>
  </soap12:Body>
</soap12:Envelope>