OnlineAPI


Click here for a complete list of operations.

GetCountries

This method will return the available countries. This can be used when running international shopping carts as it is possible to have different items available for each country, and Country must be used as defined by this function. Deprecation Note: This API has been deprecated in favor of our REST API: ~/api/Admin/Country.

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

<?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>
    <GetCountries xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
    </GetCountries>
  </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>
    <GetCountriesResponse xmlns="http://www.securefreedom.com/">
      <GetCountriesResult>
        <CountryReturn>
          <ID>int</ID>
          <Description>string</Description>
          <Abbreviation>string</Abbreviation>
          <DefaultCountry>int</DefaultCountry>
          <ISOCode>string</ISOCode>
          <HideOnExtranet>boolean</HideOnExtranet>
        </CountryReturn>
        <CountryReturn>
          <ID>int</ID>
          <Description>string</Description>
          <Abbreviation>string</Abbreviation>
          <DefaultCountry>int</DefaultCountry>
          <ISOCode>string</ISOCode>
          <HideOnExtranet>boolean</HideOnExtranet>
        </CountryReturn>
      </GetCountriesResult>
    </GetCountriesResponse>
  </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>
    <GetCountries xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
    </GetCountries>
  </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>
    <GetCountriesResponse xmlns="http://www.securefreedom.com/">
      <GetCountriesResult>
        <CountryReturn>
          <ID>int</ID>
          <Description>string</Description>
          <Abbreviation>string</Abbreviation>
          <DefaultCountry>int</DefaultCountry>
          <ISOCode>string</ISOCode>
          <HideOnExtranet>boolean</HideOnExtranet>
        </CountryReturn>
        <CountryReturn>
          <ID>int</ID>
          <Description>string</Description>
          <Abbreviation>string</Abbreviation>
          <DefaultCountry>int</DefaultCountry>
          <ISOCode>string</ISOCode>
          <HideOnExtranet>boolean</HideOnExtranet>
        </CountryReturn>
      </GetCountriesResult>
    </GetCountriesResponse>
  </soap12:Body>
</soap12:Envelope>