CatalystEcommerceWebservice Web Service

CatalystEcommerceWebservice

Click here for a complete list of operations.

Catalogue_ListRetrieve

Retrieve the details of a given catalogue.

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

<?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>
    <Catalogue_ListRetrieve xmlns="http://tempuri.org/CatalystDeveloperService/CatalystEcommerceWebservice">
      <Username>string</Username>
      <Password>string</Password>
      <SiteId>int</SiteId>
      <ParentCatalogueId>int</ParentCatalogueId>
    </Catalogue_ListRetrieve>
  </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>
    <Catalogue_ListRetrieveResponse xmlns="http://tempuri.org/CatalystDeveloperService/CatalystEcommerceWebservice">
      <Catalogue_ListRetrieveResult>
        <Catalogue>
          <Id>int</Id>
          <SiteId>int</SiteId>
          <ParentId>int</ParentId>
          <TemplateId>int</TemplateId>
          <RoleId>int</RoleId>
          <Weight>int</Weight>
          <DisplayTypeId>int</DisplayTypeId>
          <Name>string</Name>
          <Title>string</Title>
          <Description>string</Description>
          <Image>string</Image>
          <ReleaseDate>dateTime</ReleaseDate>
          <ExpiryDate>dateTime</ExpiryDate>
          <Notify>string</Notify>
          <CreateBy>int</CreateBy>
          <CreateDate>dateTime</CreateDate>
          <LastUpdateBy>int</LastUpdateBy>
          <LastUpdateDate>dateTime</LastUpdateDate>
          <UseFriendlyUrl>boolean</UseFriendlyUrl>
          <ExcludeFromFeed>boolean</ExcludeFromFeed>
          <Enabled>boolean</Enabled>
          <Deleted>boolean</Deleted>
          <MinPrice>double</MinPrice>
          <MaxPrice>double</MaxPrice>
          <PriceSlots>int</PriceSlots>
          <ProductsStatsXml>string</ProductsStatsXml>
          <ReIndex>boolean</ReIndex>
          <Url>string</Url>
          <Slug>string</Slug>
          <Parent>
            <Id>int</Id>
            <SiteId>int</SiteId>
            <ParentId>int</ParentId>
            <TemplateId>int</TemplateId>
            <RoleId>int</RoleId>
            <Weight>int</Weight>
            <DisplayTypeId>int</DisplayTypeId>
            <Name>string</Name>
            <Title>string</Title>
            <Description>string</Description>
            <Image>string</Image>
            <ReleaseDate>dateTime</ReleaseDate>
            <ExpiryDate>dateTime</ExpiryDate>
            <Notify>string</Notify>
            <CreateBy>int</CreateBy>
            <CreateDate>dateTime</CreateDate>
            <LastUpdateBy>int</LastUpdateBy>
            <LastUpdateDate>dateTime</LastUpdateDate>
            <UseFriendlyUrl>boolean</UseFriendlyUrl>
            <ExcludeFromFeed>boolean</ExcludeFromFeed>
            <Enabled>boolean</Enabled>
            <Deleted>boolean</Deleted>
            <MinPrice>double</MinPrice>
            <MaxPrice>double</MaxPrice>
            <PriceSlots>int</PriceSlots>
            <ProductsStatsXml>string</ProductsStatsXml>
            <ReIndex>boolean</ReIndex>
            <Url>string</Url>
            <Slug>string</Slug>
            <Parent xsi:nil="true" />
          </Parent>
        </Catalogue>
        <Catalogue>
          <Id>int</Id>
          <SiteId>int</SiteId>
          <ParentId>int</ParentId>
          <TemplateId>int</TemplateId>
          <RoleId>int</RoleId>
          <Weight>int</Weight>
          <DisplayTypeId>int</DisplayTypeId>
          <Name>string</Name>
          <Title>string</Title>
          <Description>string</Description>
          <Image>string</Image>
          <ReleaseDate>dateTime</ReleaseDate>
          <ExpiryDate>dateTime</ExpiryDate>
          <Notify>string</Notify>
          <CreateBy>int</CreateBy>
          <CreateDate>dateTime</CreateDate>
          <LastUpdateBy>int</LastUpdateBy>
          <LastUpdateDate>dateTime</LastUpdateDate>
          <UseFriendlyUrl>boolean</UseFriendlyUrl>
          <ExcludeFromFeed>boolean</ExcludeFromFeed>
          <Enabled>boolean</Enabled>
          <Deleted>boolean</Deleted>
          <MinPrice>double</MinPrice>
          <MaxPrice>double</MaxPrice>
          <PriceSlots>int</PriceSlots>
          <ProductsStatsXml>string</ProductsStatsXml>
          <ReIndex>boolean</ReIndex>
          <Url>string</Url>
          <Slug>string</Slug>
          <Parent>
            <Id>int</Id>
            <SiteId>int</SiteId>
            <ParentId>int</ParentId>
            <TemplateId>int</TemplateId>
            <RoleId>int</RoleId>
            <Weight>int</Weight>
            <DisplayTypeId>int</DisplayTypeId>
            <Name>string</Name>
            <Title>string</Title>
            <Description>string</Description>
            <Image>string</Image>
            <ReleaseDate>dateTime</ReleaseDate>
            <ExpiryDate>dateTime</ExpiryDate>
            <Notify>string</Notify>
            <CreateBy>int</CreateBy>
            <CreateDate>dateTime</CreateDate>
            <LastUpdateBy>int</LastUpdateBy>
            <LastUpdateDate>dateTime</LastUpdateDate>
            <UseFriendlyUrl>boolean</UseFriendlyUrl>
            <ExcludeFromFeed>boolean</ExcludeFromFeed>
            <Enabled>boolean</Enabled>
            <Deleted>boolean</Deleted>
            <MinPrice>double</MinPrice>
            <MaxPrice>double</MaxPrice>
            <PriceSlots>int</PriceSlots>
            <ProductsStatsXml>string</ProductsStatsXml>
            <ReIndex>boolean</ReIndex>
            <Url>string</Url>
            <Slug>string</Slug>
            <Parent xsi:nil="true" />
          </Parent>
        </Catalogue>
      </Catalogue_ListRetrieveResult>
    </Catalogue_ListRetrieveResponse>
  </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>
    <Catalogue_ListRetrieve xmlns="http://tempuri.org/CatalystDeveloperService/CatalystEcommerceWebservice">
      <Username>string</Username>
      <Password>string</Password>
      <SiteId>int</SiteId>
      <ParentCatalogueId>int</ParentCatalogueId>
    </Catalogue_ListRetrieve>
  </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>
    <Catalogue_ListRetrieveResponse xmlns="http://tempuri.org/CatalystDeveloperService/CatalystEcommerceWebservice">
      <Catalogue_ListRetrieveResult>
        <Catalogue>
          <Id>int</Id>
          <SiteId>int</SiteId>
          <ParentId>int</ParentId>
          <TemplateId>int</TemplateId>
          <RoleId>int</RoleId>
          <Weight>int</Weight>
          <DisplayTypeId>int</DisplayTypeId>
          <Name>string</Name>
          <Title>string</Title>
          <Description>string</Description>
          <Image>string</Image>
          <ReleaseDate>dateTime</ReleaseDate>
          <ExpiryDate>dateTime</ExpiryDate>
          <Notify>string</Notify>
          <CreateBy>int</CreateBy>
          <CreateDate>dateTime</CreateDate>
          <LastUpdateBy>int</LastUpdateBy>
          <LastUpdateDate>dateTime</LastUpdateDate>
          <UseFriendlyUrl>boolean</UseFriendlyUrl>
          <ExcludeFromFeed>boolean</ExcludeFromFeed>
          <Enabled>boolean</Enabled>
          <Deleted>boolean</Deleted>
          <MinPrice>double</MinPrice>
          <MaxPrice>double</MaxPrice>
          <PriceSlots>int</PriceSlots>
          <ProductsStatsXml>string</ProductsStatsXml>
          <ReIndex>boolean</ReIndex>
          <Url>string</Url>
          <Slug>string</Slug>
          <Parent>
            <Id>int</Id>
            <SiteId>int</SiteId>
            <ParentId>int</ParentId>
            <TemplateId>int</TemplateId>
            <RoleId>int</RoleId>
            <Weight>int</Weight>
            <DisplayTypeId>int</DisplayTypeId>
            <Name>string</Name>
            <Title>string</Title>
            <Description>string</Description>
            <Image>string</Image>
            <ReleaseDate>dateTime</ReleaseDate>
            <ExpiryDate>dateTime</ExpiryDate>
            <Notify>string</Notify>
            <CreateBy>int</CreateBy>
            <CreateDate>dateTime</CreateDate>
            <LastUpdateBy>int</LastUpdateBy>
            <LastUpdateDate>dateTime</LastUpdateDate>
            <UseFriendlyUrl>boolean</UseFriendlyUrl>
            <ExcludeFromFeed>boolean</ExcludeFromFeed>
            <Enabled>boolean</Enabled>
            <Deleted>boolean</Deleted>
            <MinPrice>double</MinPrice>
            <MaxPrice>double</MaxPrice>
            <PriceSlots>int</PriceSlots>
            <ProductsStatsXml>string</ProductsStatsXml>
            <ReIndex>boolean</ReIndex>
            <Url>string</Url>
            <Slug>string</Slug>
            <Parent xsi:nil="true" />
          </Parent>
        </Catalogue>
        <Catalogue>
          <Id>int</Id>
          <SiteId>int</SiteId>
          <ParentId>int</ParentId>
          <TemplateId>int</TemplateId>
          <RoleId>int</RoleId>
          <Weight>int</Weight>
          <DisplayTypeId>int</DisplayTypeId>
          <Name>string</Name>
          <Title>string</Title>
          <Description>string</Description>
          <Image>string</Image>
          <ReleaseDate>dateTime</ReleaseDate>
          <ExpiryDate>dateTime</ExpiryDate>
          <Notify>string</Notify>
          <CreateBy>int</CreateBy>
          <CreateDate>dateTime</CreateDate>
          <LastUpdateBy>int</LastUpdateBy>
          <LastUpdateDate>dateTime</LastUpdateDate>
          <UseFriendlyUrl>boolean</UseFriendlyUrl>
          <ExcludeFromFeed>boolean</ExcludeFromFeed>
          <Enabled>boolean</Enabled>
          <Deleted>boolean</Deleted>
          <MinPrice>double</MinPrice>
          <MaxPrice>double</MaxPrice>
          <PriceSlots>int</PriceSlots>
          <ProductsStatsXml>string</ProductsStatsXml>
          <ReIndex>boolean</ReIndex>
          <Url>string</Url>
          <Slug>string</Slug>
          <Parent>
            <Id>int</Id>
            <SiteId>int</SiteId>
            <ParentId>int</ParentId>
            <TemplateId>int</TemplateId>
            <RoleId>int</RoleId>
            <Weight>int</Weight>
            <DisplayTypeId>int</DisplayTypeId>
            <Name>string</Name>
            <Title>string</Title>
            <Description>string</Description>
            <Image>string</Image>
            <ReleaseDate>dateTime</ReleaseDate>
            <ExpiryDate>dateTime</ExpiryDate>
            <Notify>string</Notify>
            <CreateBy>int</CreateBy>
            <CreateDate>dateTime</CreateDate>
            <LastUpdateBy>int</LastUpdateBy>
            <LastUpdateDate>dateTime</LastUpdateDate>
            <UseFriendlyUrl>boolean</UseFriendlyUrl>
            <ExcludeFromFeed>boolean</ExcludeFromFeed>
            <Enabled>boolean</Enabled>
            <Deleted>boolean</Deleted>
            <MinPrice>double</MinPrice>
            <MaxPrice>double</MaxPrice>
            <PriceSlots>int</PriceSlots>
            <ProductsStatsXml>string</ProductsStatsXml>
            <ReIndex>boolean</ReIndex>
            <Url>string</Url>
            <Slug>string</Slug>
            <Parent xsi:nil="true" />
          </Parent>
        </Catalogue>
      </Catalogue_ListRetrieveResult>
    </Catalogue_ListRetrieveResponse>
  </soap12:Body>
</soap12:Envelope>