OnlineAPI Web Service

OnlineAPI

Click here for a complete list of operations.

OnlineOrder_Autoship_AddItem_V3

This method works exactly like OnlineOrder_Autoship_AddItem_V2 except that one may also specify a particular shipping method to be used for the AutoShip Orders to be generated.

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

<?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_Autoship_AddItem_V3 xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <OnlineOrderID>int</OnlineOrderID>
      <ProductID>string</ProductID>
      <Quantity>int</Quantity>
      <DateNextShipment>string</DateNextShipment>
      <ShipMethodID>int</ShipMethodID>
    </OnlineOrder_Autoship_AddItem_V3>
  </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_Autoship_AddItem_V3Response xmlns="http://www.securefreedom.com/">
      <OnlineOrder_Autoship_AddItem_V3Result>
        <OnlineAutoshipID>int</OnlineAutoshipID>
      </OnlineOrder_Autoship_AddItem_V3Result>
    </OnlineOrder_Autoship_AddItem_V3Response>
  </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>
    <OnlineOrder_Autoship_AddItem_V3 xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <OnlineOrderID>int</OnlineOrderID>
      <ProductID>string</ProductID>
      <Quantity>int</Quantity>
      <DateNextShipment>string</DateNextShipment>
      <ShipMethodID>int</ShipMethodID>
    </OnlineOrder_Autoship_AddItem_V3>
  </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_Autoship_AddItem_V3Response xmlns="http://www.securefreedom.com/">
      <OnlineOrder_Autoship_AddItem_V3Result>
        <OnlineAutoshipID>int</OnlineAutoshipID>
      </OnlineOrder_Autoship_AddItem_V3Result>
    </OnlineOrder_Autoship_AddItem_V3Response>
  </soap12:Body>
</soap12:Envelope>