CatalystEcommerceWebservice Web Service

CatalystEcommerceWebservice

Click here for a complete list of operations.

Product_Retrieve

Retrieve the details of a given product.

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/Product_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>
    <Product_Retrieve xmlns="http://tempuri.org/CatalystDeveloperService/CatalystEcommerceWebservice">
      <username>string</username>
      <password>string</password>
      <siteId>int</siteId>
      <productCode>string</productCode>
    </Product_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>
    <Product_RetrieveResponse xmlns="http://tempuri.org/CatalystDeveloperService/CatalystEcommerceWebservice">
      <Product_RetrieveResult>
        <productId>int</productId>
        <productCode>string</productCode>
        <productName>string</productName>
        <description>string</description>
        <smallImage>string</smallImage>
        <largeImage>string</largeImage>
        <cataloguesArray>
          <string>string</string>
          <string>string</string>
        </cataloguesArray>
        <pricesSaleArray>
          <string>string</string>
          <string>string</string>
        </pricesSaleArray>
        <pricesRetailArray>
          <string>string</string>
          <string>string</string>
        </pricesRetailArray>
        <pricesWholesaleArray>
          <string>string</string>
          <string>string</string>
        </pricesWholesaleArray>
        <wholesaleTaxCodeArray>
          <string>string</string>
          <string>string</string>
        </wholesaleTaxCodeArray>
        <taxCodeArray>
          <string>string</string>
          <string>string</string>
        </taxCodeArray>
        <groupProducts>
          <string>string</string>
          <string>string</string>
        </groupProducts>
        <groupProductsDescriptions>
          <string>string</string>
          <string>string</string>
        </groupProductsDescriptions>
        <supplierEntityId>int</supplierEntityId>
        <supplierCommission>double</supplierCommission>
        <weight>int</weight>
        <relatedProducts>
          <string>string</string>
          <string>string</string>
        </relatedProducts>
        <tags>string</tags>
        <unitType>string</unitType>
        <minUnits>int</minUnits>
        <maxUnits>int</maxUnits>
        <inStock>int</inStock>
        <onOrder>int</onOrder>
        <reOrder>int</reOrder>
        <inventoryControl>boolean</inventoryControl>
        <canPreOrder>boolean</canPreOrder>
        <custom1>string</custom1>
        <custom2>string</custom2>
        <custom3>string</custom3>
        <custom4>string</custom4>
        <popletImages>string</popletImages>
        <enabled>boolean</enabled>
        <deleted>boolean</deleted>
        <captureDetails>boolean</captureDetails>
        <downloadLimitCount>int</downloadLimitCount>
        <limitDownloadsToIP>int</limitDownloadsToIP>
        <isOnSale>boolean</isOnSale>
        <hideIfNoStock>boolean</hideIfNoStock>
        <productAttributes>string</productAttributes>
        <isGiftVoucher>boolean</isGiftVoucher>
        <enableDropShipping>boolean</enableDropShipping>
        <productWeight>double</productWeight>
        <productWidth>double</productWidth>
        <productHeight>double</productHeight>
        <productDepth>double</productDepth>
        <excludeFromSearch>boolean</excludeFromSearch>
        <productTitle>string</productTitle>
        <cycletypeId>int</cycletypeId>
        <cycletypeCount>int</cycletypeCount>
        <slug>string</slug>
      </Product_RetrieveResult>
    </Product_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>
    <Product_Retrieve xmlns="http://tempuri.org/CatalystDeveloperService/CatalystEcommerceWebservice">
      <username>string</username>
      <password>string</password>
      <siteId>int</siteId>
      <productCode>string</productCode>
    </Product_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>
    <Product_RetrieveResponse xmlns="http://tempuri.org/CatalystDeveloperService/CatalystEcommerceWebservice">
      <Product_RetrieveResult>
        <productId>int</productId>
        <productCode>string</productCode>
        <productName>string</productName>
        <description>string</description>
        <smallImage>string</smallImage>
        <largeImage>string</largeImage>
        <cataloguesArray>
          <string>string</string>
          <string>string</string>
        </cataloguesArray>
        <pricesSaleArray>
          <string>string</string>
          <string>string</string>
        </pricesSaleArray>
        <pricesRetailArray>
          <string>string</string>
          <string>string</string>
        </pricesRetailArray>
        <pricesWholesaleArray>
          <string>string</string>
          <string>string</string>
        </pricesWholesaleArray>
        <wholesaleTaxCodeArray>
          <string>string</string>
          <string>string</string>
        </wholesaleTaxCodeArray>
        <taxCodeArray>
          <string>string</string>
          <string>string</string>
        </taxCodeArray>
        <groupProducts>
          <string>string</string>
          <string>string</string>
        </groupProducts>
        <groupProductsDescriptions>
          <string>string</string>
          <string>string</string>
        </groupProductsDescriptions>
        <supplierEntityId>int</supplierEntityId>
        <supplierCommission>double</supplierCommission>
        <weight>int</weight>
        <relatedProducts>
          <string>string</string>
          <string>string</string>
        </relatedProducts>
        <tags>string</tags>
        <unitType>string</unitType>
        <minUnits>int</minUnits>
        <maxUnits>int</maxUnits>
        <inStock>int</inStock>
        <onOrder>int</onOrder>
        <reOrder>int</reOrder>
        <inventoryControl>boolean</inventoryControl>
        <canPreOrder>boolean</canPreOrder>
        <custom1>string</custom1>
        <custom2>string</custom2>
        <custom3>string</custom3>
        <custom4>string</custom4>
        <popletImages>string</popletImages>
        <enabled>boolean</enabled>
        <deleted>boolean</deleted>
        <captureDetails>boolean</captureDetails>
        <downloadLimitCount>int</downloadLimitCount>
        <limitDownloadsToIP>int</limitDownloadsToIP>
        <isOnSale>boolean</isOnSale>
        <hideIfNoStock>boolean</hideIfNoStock>
        <productAttributes>string</productAttributes>
        <isGiftVoucher>boolean</isGiftVoucher>
        <enableDropShipping>boolean</enableDropShipping>
        <productWeight>double</productWeight>
        <productWidth>double</productWidth>
        <productHeight>double</productHeight>
        <productDepth>double</productDepth>
        <excludeFromSearch>boolean</excludeFromSearch>
        <productTitle>string</productTitle>
        <cycletypeId>int</cycletypeId>
        <cycletypeCount>int</cycletypeCount>
        <slug>string</slug>
      </Product_RetrieveResult>
    </Product_RetrieveResponse>
  </soap12:Body>
</soap12:Envelope>