CatalystEcommerceWebservice


Click here for a complete list of operations.

DiscountCode_Retrieve

Retrieves details of a discount code.

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 /catalystwebservice/catalystecommercewebservice.asmx HTTP/1.1
Host: businesscatalyst.com.au
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/CatalystDeveloperService/CatalystEcommerceWebservice/DiscountCode_Retrieve"

<?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>
    <DiscountCode_Retrieve xmlns="http://tempuri.org/CatalystDeveloperService/CatalystEcommerceWebservice">
      <username>string</username>
      <password>string</password>
      <siteId>int</siteId>
      <discountcodeId>int</discountcodeId>
    </DiscountCode_Retrieve>
  </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>
    <DiscountCode_RetrieveResponse xmlns="http://tempuri.org/CatalystDeveloperService/CatalystEcommerceWebservice">
      <DiscountCode_RetrieveResult>
        <discountcodeId>int</discountcodeId>
        <discountcode>string</discountcode>
        <description>string</description>
        <discountPercentage>double</discountPercentage>
        <releaseDate>string</releaseDate>
        <expiryDate>string</expiryDate>
        <enabled>boolean</enabled>
      </DiscountCode_RetrieveResult>
    </DiscountCode_RetrieveResponse>
  </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 /catalystwebservice/catalystecommercewebservice.asmx HTTP/1.1
Host: businesscatalyst.com.au
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>
    <DiscountCode_Retrieve xmlns="http://tempuri.org/CatalystDeveloperService/CatalystEcommerceWebservice">
      <username>string</username>
      <password>string</password>
      <siteId>int</siteId>
      <discountcodeId>int</discountcodeId>
    </DiscountCode_Retrieve>
  </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>
    <DiscountCode_RetrieveResponse xmlns="http://tempuri.org/CatalystDeveloperService/CatalystEcommerceWebservice">
      <DiscountCode_RetrieveResult>
        <discountcodeId>int</discountcodeId>
        <discountcode>string</discountcode>
        <description>string</description>
        <discountPercentage>double</discountPercentage>
        <releaseDate>string</releaseDate>
        <expiryDate>string</expiryDate>
        <enabled>boolean</enabled>
      </DiscountCode_RetrieveResult>
    </DiscountCode_RetrieveResponse>
  </soap12:Body>
</soap12:Envelope>