Build Version:

GET categories/catalog/{catalogId}

Gets a list of categories for a specific catalog.

Request Information

» Parameters

Name	Description	Additional information
catalogId	The ID of the catalog.	Define this parameter in the request URI.

» Expands

Name	Description	Usage
categoryNodes	This will retrieve the related list of category nodes.	GET categories/catalog/{catalogId}?expand=categorynodes
productIds	This will retrieve the related list of product IDs.	GET categories/catalog/{catalogId}?expand=productids
subcategories	This will retrieve the related list of subcategories.	GET categories/catalog/{catalogId}?expand=subcategories

» Filters

Name	Description	Usage
externalId	This will filter the request by external ID.	GET categories/catalog/{catalogId}?filter=externalid~{operator}~{value}
isVisible	This will filter the request by the is visible flag.	GET categories/catalog/{catalogId}?filter=isvisible~{operator}~{value}
name	This will filter the request by name.	GET categories/catalog/{catalogId}?filter=name~{operator}~{value}
portalId	This will filter the request by portal ID.	GET categories/catalog/{catalogId}?filter=portalid~{operator}~{value}
title	This will filter the request by title.	GET categories/catalog/{catalogId}?filter=title~{operator}~{value}

» Sorting

Name	Description	Usage
categoryId	This will sort the response by category ID.	GET categories/catalog/{catalogId}?sort=categoryid
displayOrder	This will sort the response by display order.	GET categories/catalog/{catalogId}?sort=displayorder
name	This will sort the response by name.	GET categories/catalog/{catalogId}?sort=name
title	This will sort the response by title.	GET categories/catalog/{catalogId}?sort=title

» Paging

Name	Description	Usage
index	The index to retrieve when requesting paged results.	GET categories/catalog/{catalogId}?page=index~{value}
size	The size of the page when retrieving paged results.	GET categories/catalog/{catalogId}?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:

	{
  "Categories": [
    {
      "AlternateDescription": "",
      "CategoryId": 85,
      "CategoryNodes": [
        {
          "Catalog": null,
          "CatalogId": 1,
          "Category": null,
          "CategoryId": 89,
          "CategoryNodeId": 7,
          "BeginDate": null,
          "CssId": null,
          "DisplayOrder": 5,
          "EndDate": null,
          "IsActive": true,
          "MasterPageId": null,
          "ParentCategoryNodeId": 1,
          "ThemeId": null,
          "ErrorMessage": null,
          "Name": null,
          "Title": null,
          "VisibleInd": null,
          "IsCategoryAssociated": false
        }
      ],
      "CategoryProfiles": [],
      "CategoryUrl": "~/category/Fruits/85",
      "CreateDate": "2013-07-01T00:00:00",
      "Custom1": "",
      "Custom2": "",
      "Custom3": "",
      "Description": "",
      "DisplayOrder": 5,
      "ExternalId": null,
      "ImageAltTag": "Flowers",
      "ImageFile": "Poppy.jpg",
      "ImageLargePath": "~/data/default/images/catalog/450/Poppy.jpg",
      "ImageMediumPath": "~/data/default/images/catalog/250/Poppy.jpg",
      "ImageSmallPath": "~/data/default/images/catalog/100/Poppy.jpg",
      "ImageSmallThumbnailPath": "~/data/default/images/catalog/37/Poppy.jpg",
      "ImageThumbnailPath": "~/data/default/images/catalog/50/Poppy.jpg",
      "IsVisible": true,
      "Name": "Fruit",
      "ProductIds": "302,303,304,305,306,307",
      "SeoDescription": "Fruits",
      "SeoKeywords": "Fruits",
      "SeoTitle": "Fruits",
      "SeoUrl": "Fruits",
      "ShortDescription": "",
      "RedirectUrlInd": false,
      "Subcategories": [
        {
          "AlternateDescription": "",
          "CategoryId": 85,
          "CategoryNodes": [],
          "CategoryProfiles": [],
          "CategoryUrl": "~/category/Fruits/85",
          "CreateDate": "2013-07-01T00:00:00",
          "Custom1": "",
          "Custom2": "",
          "Custom3": "",
          "Description": "",
          "DisplayOrder": 5,
          "ExternalId": null,
          "ImageAltTag": "Flowers",
          "ImageFile": "Poppy.jpg",
          "ImageLargePath": "~/data/default/images/catalog/450/Poppy.jpg",
          "ImageMediumPath": "~/data/default/images/catalog/250/Poppy.jpg",
          "ImageSmallPath": "~/data/default/images/catalog/100/Poppy.jpg",
          "ImageSmallThumbnailPath": "~/data/default/images/catalog/37/Poppy.jpg",
          "ImageThumbnailPath": "~/data/default/images/catalog/50/Poppy.jpg",
          "IsVisible": true,
          "Name": "Fruit",
          "ProductIds": "302,303,304,305,306,307",
          "SeoDescription": "Fruits",
          "SeoKeywords": "Fruits",
          "SeoTitle": "Fruits",
          "SeoUrl": "Fruits",
          "ShortDescription": "",
          "RedirectUrlInd": false,
          "Subcategories": [],
          "SubcategoryGridIsVisible": true,
          "IsAssociate": false,
          "Title": "Fruit",
          "UpdateDate": "2013-07-31T23:59:59.999",
          "CategoryBanner": "",
          "PortalID": null,
          "ProductId": 0,
          "CategoryIds": null,
          "UserName": null,
          "IsFromSitecore": false,
          "ProductCount": 0,
          "ParentCategoryNodeId": 0,
          "IsActive": false,
          "ActiveProductCount": 0,
          "FacetsGroups": [],
          "Properties": {
            "IsFeatured": false
          },
          "CatalogCount": 0
        }
      ],
      "SubcategoryGridIsVisible": true,
      "IsAssociate": false,
      "Title": "Fruit",
      "UpdateDate": "2013-07-31T23:59:59.999",
      "CategoryBanner": "",
      "PortalID": null,
      "ProductId": 0,
      "CategoryIds": null,
      "UserName": null,
      "IsFromSitecore": false,
      "ProductCount": 0,
      "ParentCategoryNodeId": 0,
      "IsActive": false,
      "ActiveProductCount": 0,
      "FacetsGroups": [],
      "Properties": {
        "IsFeatured": false
      },
      "CatalogCount": 0
    }
  ],
  "CatalogAssociatedCategories": null,
  "CategoryList": null,
  "PageIndex": null,
  "PageSize": null,
  "TotalPages": null,
  "TotalResults": null,
  "ErrorCode": null,
  "ErrorMessage": null,
  "StackTrace": null,
  "AllowHtmlResponse": false,
  "HasError": false,
  "StringResponse": null
}