Znode

GET categorynodes/{categoryNodeId}

Gets a category node.

Request Information

» Parameters

Name Description Additional information
categoryNodeId The ID of the category node.

Define this parameter in the request URI.

» Expands

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

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.

Sample:
	{
  "CategoryNode": {
    "Catalog": {
      "CatalogId": 1,
      "ExternalId": null,
      "IsActive": true,
      "Name": "Fine Foods Catalog",
      "PortalId": null,
      "PreserveCategories": false,
      "IsDefault": false,
      "IsFromSitecore": false
    },
    "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
    },
    "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
  },
  "ErrorCode": null,
  "ErrorMessage": null,
  "HasError": false
}