Build Version:

GET categorynodes

Gets a list of category nodes.

Request Information

» Expands

Name	Description	Usage
catalog	This will retrieve the related catalog.	GET categorynodes?expand=catalog
category	This will retrieve the related category.	GET categorynodes?expand=category

» Filters

Name	Description	Usage
beginDate	This will filter the request by begin date.	GET categorynodes?filter=begindate~{operator}~{value}
catalogId	This will filter the request by catalog ID.	GET categorynodes?filter=catalogid~{operator}~{value}
categoryId	This will filter the request by category ID.	GET categorynodes?filter=categoryid~{operator}~{value}
endDate	This will filter the request by end date.	GET categorynodes?filter=enddate~{operator}~{value}
isActive	This will filter the request by the is active flag.	GET categorynodes?filter=isactive~{operator}~{value}
parentCategoryNodeId	This will filter the request by parent category node ID.	GET categorynodes?filter=parentcategorynodeid~{operator}~{value}

» Sorting

Name	Description	Usage
catalogId	This will sort the response by catalog ID.	GET categorynodes?sort=catalogid
categoryId	This will sort the response by category ID.	GET categorynodes?sort=categoryid
categoryNodeId	This will sort the response by category node ID.	GET categorynodes?sort=categorynodeid
displayOrder	This will sort the response by display order.	GET categorynodes?sort=displayorder

» Paging

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

	{
  "CategoryNodes": [
    {
      "Catalog": {
        "CatalogId": 1,
        "ExternalId": null,
        "IsActive": true,
        "Name": "Fine Foods Catalog",
        "PortalId": null,
        "PreserveCategories": false,
        "IsDefault": false,
        "IsFromSitecore": false,
        "ProductIds": null,
        "ProductCount": 0,
        "CategoryCount": 0
      },
      "CatalogId": 1,
      "Category": {
        "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
      },
      "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
    }
  ],
  "PageIndex": null,
  "PageSize": null,
  "TotalPages": null,
  "TotalResults": null,
  "ErrorCode": null,
  "ErrorMessage": null,
  "StackTrace": null,
  "AllowHtmlResponse": false,
  "HasError": false,
  "StringResponse": null
}