OnlineAPI


Click here for a complete list of operations.

OnlineOrder_GetShipMethods

This method will return the list of available shipping methods for a given State, Country, Weight, and POBOX. However, it is strongly suggested to use the second version of this method along with an Online Order ID as it will be easier and allow for fewer errors between systems.

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

<?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_GetShipMethods xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <ShipState>string</ShipState>
      <ShipCountry>string</ShipCountry>
      <Weight>double</Weight>
      <POBox>int</POBox>
    </OnlineOrder_GetShipMethods>
  </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_GetShipMethodsResponse xmlns="http://www.securefreedom.com/">
      <OnlineOrder_GetShipMethodsResult>
        <ShipMethods>
          <ShipMethodID>int</ShipMethodID>
          <Description>string</Description>
          <SortOrder>int</SortOrder>
        </ShipMethods>
        <ShipMethods>
          <ShipMethodID>int</ShipMethodID>
          <Description>string</Description>
          <SortOrder>int</SortOrder>
        </ShipMethods>
      </OnlineOrder_GetShipMethodsResult>
    </OnlineOrder_GetShipMethodsResponse>
  </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_GetShipMethods xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <ShipState>string</ShipState>
      <ShipCountry>string</ShipCountry>
      <Weight>double</Weight>
      <POBox>int</POBox>
    </OnlineOrder_GetShipMethods>
  </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_GetShipMethodsResponse xmlns="http://www.securefreedom.com/">
      <OnlineOrder_GetShipMethodsResult>
        <ShipMethods>
          <ShipMethodID>int</ShipMethodID>
          <Description>string</Description>
          <SortOrder>int</SortOrder>
        </ShipMethods>
        <ShipMethods>
          <ShipMethodID>int</ShipMethodID>
          <Description>string</Description>
          <SortOrder>int</SortOrder>
        </ShipMethods>
      </OnlineOrder_GetShipMethodsResult>
    </OnlineOrder_GetShipMethodsResponse>
  </soap12:Body>
</soap12:Envelope>