Build Version:

GET catalogs

Gets a list of catalogs.

Request Information

» Expands

Name	Description	Usage
categories	This will retrieve the related list of categories.	GET catalogs?expand=categories
productIds	This will retrieve the related list of product IDs.	GET catalogs?expand=productids

» Filters

Name	Description	Usage
externalId	This will filter the request by external ID.	GET catalogs?filter=externalid~{operator}~{value}
isActive	This will filter the request by the is active flag.	GET catalogs?filter=isactive~{operator}~{value}
name	This will filter the request by name.	GET catalogs?filter=name~{operator}~{value}
portalId	This will filter the request by portal ID.	GET catalogs?filter=portalid~{operator}~{value}

» Paging

Name	Description	Usage
index	The index to retrieve when requesting paged results.	GET catalogs?page=index~{value}
size	The size of the page when retrieving paged results.	GET catalogs?page=size~{value}

Response Information

» Response Body Formats

If this endpoint supports expands, they will be included in the sample response body below. However, please note that expands are NOT included in the response body by default. Expands are only included in the response body if they came through as part of the request.

application/json

Sample:

	{
  "Catalogs": [
    {
      "CatalogId": 1,
      "ExternalId": null,
      "IsActive": true,
      "Name": "Fine Foods Catalog",
      "PortalId": null,
      "PreserveCategories": false,
      "IsDefault": false,
      "IsFromSitecore": false,
      "ProductIds": null,
      "ProductCount": 0,
      "CategoryCount": 0
    }
  ],
  "PageIndex": null,
  "PageSize": null,
  "TotalPages": null,
  "TotalResults": null,
  "ErrorCode": null,
  "ErrorMessage": null,
  "StackTrace": null,
  "AllowHtmlResponse": false,
  "HasError": false,
  "StringResponse": null
}