OnlineAPI


Click here for a complete list of operations.

OnlineOrder_GetShipMethods_v2

This method will return the allowable shipping methods for a specified online order. Note: Because different shipping methods will be available depending upon setup and territory. One should always call this method to return the shipping methods for a specified online order as even the total weight of an online order can change which shipping methods are available.

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_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>
    <OnlineOrder_GetShipMethods_v2 xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <OnlineOrderID>int</OnlineOrderID>
      <LocaleID>int</LocaleID>
    </OnlineOrder_GetShipMethods_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>
    <OnlineOrder_GetShipMethods_v2Response xmlns="http://www.securefreedom.com/">
      <OnlineOrder_GetShipMethods_v2Result>
        <ShipMethods_v2>
          <ShipMethodID>int</ShipMethodID>
          <Description>string</Description>
          <Price>decimal</Price>
          <SortOrder>int</SortOrder>
          <SMTSortOrder>int</SMTSortOrder>
        </ShipMethods_v2>
        <ShipMethods_v2>
          <ShipMethodID>int</ShipMethodID>
          <Description>string</Description>
          <Price>decimal</Price>
          <SortOrder>int</SortOrder>
          <SMTSortOrder>int</SMTSortOrder>
        </ShipMethods_v2>
      </OnlineOrder_GetShipMethods_v2Result>
    </OnlineOrder_GetShipMethods_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>
    <OnlineOrder_GetShipMethods_v2 xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <OnlineOrderID>int</OnlineOrderID>
      <LocaleID>int</LocaleID>
    </OnlineOrder_GetShipMethods_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>
    <OnlineOrder_GetShipMethods_v2Response xmlns="http://www.securefreedom.com/">
      <OnlineOrder_GetShipMethods_v2Result>
        <ShipMethods_v2>
          <ShipMethodID>int</ShipMethodID>
          <Description>string</Description>
          <Price>decimal</Price>
          <SortOrder>int</SortOrder>
          <SMTSortOrder>int</SMTSortOrder>
        </ShipMethods_v2>
        <ShipMethods_v2>
          <ShipMethodID>int</ShipMethodID>
          <Description>string</Description>
          <Price>decimal</Price>
          <SortOrder>int</SortOrder>
          <SMTSortOrder>int</SMTSortOrder>
        </ShipMethods_v2>
      </OnlineOrder_GetShipMethods_v2Result>
    </OnlineOrder_GetShipMethods_v2Response>
  </soap12:Body>
</soap12:Envelope>