OnlineAPI Web Service

OnlineAPI

Click here for a complete list of operations.

CreateOnlineOrder_V2

This method is the starting block of the order creation process. This will essentially create a temporary order that allows one to add items for calculating total cost, shipping, and etc. One will need to create a temporary order prior to persisting the order. In order to create a finished order, create an online order, enter and add items and then use the CreateOrder method. This v2 not only validates the value entered to each parameters and return success or fail result but also show the reason for failure.

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/CreateOnlineOrder_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>
    <CreateOnlineOrder_V2 xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <OnlineOrderRecord>
        <RepNumber>string</RepNumber>
        <OnlineSignupID>int</OnlineSignupID>
        <OnlineCustomerID>string</OnlineCustomerID>
        <CustomerNumber>string</CustomerNumber>
        <BillFirstname>string</BillFirstname>
        <BillLastname>string</BillLastname>
        <BillCompany>string</BillCompany>
        <BillStreet1>string</BillStreet1>
        <BillStreet2>string</BillStreet2>
        <BillCity>string</BillCity>
        <BillState>string</BillState>
        <BillPostalCode>string</BillPostalCode>
        <BillCounty>string</BillCounty>
        <BillCountry>string</BillCountry>
        <BillPhone>string</BillPhone>
        <ShipFirstname>string</ShipFirstname>
        <ShipLastname>string</ShipLastname>
        <ShipCompany>string</ShipCompany>
        <ShipStreet1>string</ShipStreet1>
        <ShipStreet2>string</ShipStreet2>
        <ShipCity>string</ShipCity>
        <ShipState>string</ShipState>
        <ShipPostalCode>string</ShipPostalCode>
        <ShipCounty>string</ShipCounty>
        <ShipCountry>string</ShipCountry>
        <ShipPhone>string</ShipPhone>
        <ContactEmail>string</ContactEmail>
        <InvoiceNotes>string</InvoiceNotes>
        <IPAddress>string</IPAddress>
        <MarketShowID>int</MarketShowID>
      </OnlineOrderRecord>
    </CreateOnlineOrder_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>
    <CreateOnlineOrder_V2Response xmlns="http://www.securefreedom.com/">
      <CreateOnlineOrder_V2Result>
        <OnlineOrderID>int</OnlineOrderID>
      </CreateOnlineOrder_V2Result>
    </CreateOnlineOrder_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>
    <CreateOnlineOrder_V2 xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <OnlineOrderRecord>
        <RepNumber>string</RepNumber>
        <OnlineSignupID>int</OnlineSignupID>
        <OnlineCustomerID>string</OnlineCustomerID>
        <CustomerNumber>string</CustomerNumber>
        <BillFirstname>string</BillFirstname>
        <BillLastname>string</BillLastname>
        <BillCompany>string</BillCompany>
        <BillStreet1>string</BillStreet1>
        <BillStreet2>string</BillStreet2>
        <BillCity>string</BillCity>
        <BillState>string</BillState>
        <BillPostalCode>string</BillPostalCode>
        <BillCounty>string</BillCounty>
        <BillCountry>string</BillCountry>
        <BillPhone>string</BillPhone>
        <ShipFirstname>string</ShipFirstname>
        <ShipLastname>string</ShipLastname>
        <ShipCompany>string</ShipCompany>
        <ShipStreet1>string</ShipStreet1>
        <ShipStreet2>string</ShipStreet2>
        <ShipCity>string</ShipCity>
        <ShipState>string</ShipState>
        <ShipPostalCode>string</ShipPostalCode>
        <ShipCounty>string</ShipCounty>
        <ShipCountry>string</ShipCountry>
        <ShipPhone>string</ShipPhone>
        <ContactEmail>string</ContactEmail>
        <InvoiceNotes>string</InvoiceNotes>
        <IPAddress>string</IPAddress>
        <MarketShowID>int</MarketShowID>
      </OnlineOrderRecord>
    </CreateOnlineOrder_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>
    <CreateOnlineOrder_V2Response xmlns="http://www.securefreedom.com/">
      <CreateOnlineOrder_V2Result>
        <OnlineOrderID>int</OnlineOrderID>
      </CreateOnlineOrder_V2Result>
    </CreateOnlineOrder_V2Response>
  </soap12:Body>
</soap12:Envelope>