Znode

GET categories/{categoryId}

Gets a category.

Request Information

» Parameters

Name Description Additional information
categoryId The ID of the category.

Define this parameter in the request URI.

» Expands

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

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:
	{
  "Category": {
    "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,
        "LabelCategoryBannerLongDescription": null,
        "LabelCategoryBannerLongDescriptionIsVisible": false,
        "LabelCategoryAdditionalContent1": null,
        "LabelCategoryAdditionalContent1IsVisible": false,
        "LabelCategoryAdditionalContent2": null,
        "LabelCategoryAdditionalContent2IsVisible": false,
        "LabelCategoryAdditionalContent3": null,
        "LabelCategoryAdditionalContent3IsVisible": false,
        "LabelCategoryAdditionalContent4": null,
        "LabelCategoryAdditionalContent4IsVisible": false,
        "LabelCategoryAdditionalContent5": null,
        "LabelCategoryAdditionalContent5IsVisible": false,
        "LabelCategoryAdditionalContent6": null,
        "LabelCategoryAdditionalContent6IsVisible": false,
        "LabelCategoryAdditionalContent7": null,
        "LabelCategoryAdditionalContent7IsVisible": false,
        "LabelCategoryAdditionalContent8": null,
        "LabelCategoryAdditionalContent8IsVisible": false
      }
    ],
    "SubcategoryGridIsVisible": true,
    "IsAssociate": false,
    "Title": "Fruit",
    "UpdateDate": "2013-07-31T23:59:59.999",
    "CategoryBanner": "",
    "PortalID": null,
    "ProductId": 0,
    "CategoryIds": null,
    "UserName": null,
    "LabelCategoryBannerLongDescription": null,
    "LabelCategoryBannerLongDescriptionIsVisible": false,
    "LabelCategoryAdditionalContent1": null,
    "LabelCategoryAdditionalContent1IsVisible": false,
    "LabelCategoryAdditionalContent2": null,
    "LabelCategoryAdditionalContent2IsVisible": false,
    "LabelCategoryAdditionalContent3": null,
    "LabelCategoryAdditionalContent3IsVisible": false,
    "LabelCategoryAdditionalContent4": null,
    "LabelCategoryAdditionalContent4IsVisible": false,
    "LabelCategoryAdditionalContent5": null,
    "LabelCategoryAdditionalContent5IsVisible": false,
    "LabelCategoryAdditionalContent6": null,
    "LabelCategoryAdditionalContent6IsVisible": false,
    "LabelCategoryAdditionalContent7": null,
    "LabelCategoryAdditionalContent7IsVisible": false,
    "LabelCategoryAdditionalContent8": null,
    "LabelCategoryAdditionalContent8IsVisible": false
  },
  "ErrorCode": null,
  "ErrorMessage": null,
  "HasError": false
}