Build Version:

GET productcategories/{productCategoryId}

Gets a product category.

Request Information

» Parameters

Name	Description	Additional information
productCategoryId	The ID of the product category.	Define this parameter in the request URI.

» Expands

Name	Description	Usage
category	This will retrieve the related category.	GET productcategories/{productCategoryId}?expand=category
product	This will retrieve the related product.	GET productcategories/{productCategoryId}?expand=product

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:

	{
  "ProductCategory": {
    "BeginDate": null,
    "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": 81,
    "CssId": null,
    "DisplayOrder": 5,
    "EndDate": null,
    "IsActive": true,
    "MasterPageId": null,
    "Product": {
      "AccountId": 33,
      "AdditionalInfo": "",
      "AdditionalInfoLink": "",
      "AdditionalInfoLinkLabel": "",
      "AddOns": [],
      "AffiliateUrl": "",
      "AllowBackOrder": true,
      "AllowDropShip": true,
      "AllowFreeShipping": true,
      "AllowRecurringBilling": false,
      "AllowRecurringBillingInstallment": false,
      "Attributes": [],
      "BackOrderMessage": "",
      "BeginActiveDate": null,
      "BundledProductIds": null,
      "BundledProductExternalIds": null,
      "CallForPricing": false,
      "Categories": [],
      "ProductCategories": [],
      "CreateDate": "2013-04-29T10:49:32.657",
      "CrossSells": [],
      "Custom1": "",
      "Custom2": "",
      "Custom3": "",
      "Description": "Product description",
      "DisplayOrder": 10,
      "DownloadLink": "",
      "DropShipEmailAddress": "",
      "EndActiveDate": null,
      "ExpirationFrequency": null,
      "ExpirationPeriod": null,
      "ExternalId": "",
      "FeaturesDescription": "Features description",
      "FrequentlyBoughtTogether": [],
      "Height": 1.0,
      "Highlights": [],
      "ImageAltTag": "Apple",
      "ImageFile": "apple.jpg",
      "ImageLargePath": "~/data/default/images/catalog/450/apple.jpg",
      "ImageMediumPath": "~/data/default/images/catalog/250/apple.jpg",
      "ImageSmallPath": "~/data/default/images/catalog/100/apple.jpg",
      "ImageSmallThumbnailPath": "~/data/default/images/catalog/37/apple.jpg",
      "ImageThumbnailPath": "~/data/default/images/catalog/50/apple.jpg",
      "Images": [],
      "InStockMessage": "This item is in stock",
      "InventoryDisplay": 0,
      "IsActive": true,
      "IsCategorySpecial": false,
      "IsFeatured": false,
      "IsFranchisable": true,
      "IsHomepageSpecial": false,
      "IsMustLoginToView": false,
      "CalculateAddOnsOnlyOnceInTotal": false,
      "IsNewProduct": false,
      "IsShippable": true,
      "Keywords": "",
      "Length": 1.0,
      "Manufacturer": null,
      "ManufacturerId": 3,
      "MaxSelectableQuantity": 10.0,
      "MinSelectableQuantity": 0.0,
      "QuantityIncrement": null,
      "EnableFileUploads": false,
      "ProductSetting": {
        "ProductSettingId": 0,
        "ProductNumDifferent": false,
        "ProductId": 0,
        "EnableFileUploads": false,
        "ShipAttributeDifferent": false,
        "ShipWidth": null,
        "ShipHeight": null,
        "ShipLength": null,
        "ShipWeight": null,
        "IsCustom": false,
        "IsCustomReq": false,
        "DesignerType": null,
        "ImageArrayJSON": null,
        "CCStateID": null,
        "CCProofLocation": null,
        "IsHresPdfDownloadable": false
      },
      "Name": "Apple",
      "OutOfStockMessage": "This item is out of stock",
      "PortalId": 1,
      "ProductId": 302,
      "ProductNumber": "ap231",
      "ProductType": null,
      "ProductTypeId": 8,
      "ProductUrl": "~/product/Apple/302",
      "PromotionMessage": "",
      "PromotionPrice": 0.25,
      "Promotions": [],
      "RecurringBillingFrequency": "",
      "RecurringBillingInitialAmount": 0.0,
      "RecurringBillingPeriod": "",
      "RecurringBillingTotalCycles": 0,
      "RetailPrice": 4.23,
      "Reviews": [],
      "ReviewStateId": 20,
      "SalePrice": 3.50,
      "SelectedSku": null,
      "SeoDescription": "Delicious Apple",
      "SeoKeywords": "apple",
      "SeoTitle": "Delicious Apple",
      "SeoUrl": "Apple",
      "ShipEachItemSeparately": false,
      "ShippingRate": 0.56,
      "ShippingRuleTypeId": 0,
      "ShipSeparately": false,
      "ShortDescription": "Short description",
      "Skus": [],
      "Specifications": "Product specifications",
      "SupplierId": 12,
      "TaxClassId": 1,
      "TieredPrice": 1.50,
      "Tiers": [],
      "TrackInventory": true,
      "UpdateDate": "2013-08-12T07:12:34.407",
      "WebServiceDownloadDate": null,
      "Weight": 1.0,
      "Width": null,
      "WholesalePrice": 2.10,
      "YouMayAlsoLike": [],
      "IsChildProduct": null,
      "IsParentProductId": null,
      "NegotiatedPrice": null,
      "ProductNum": null,
      "Vendor": null,
      "IsGiftCard": false,
      "AttributeCount": 0,
      "ProductAttributes": null,
      "ProductAddOns": null,
      "BundleProductDict": null,
      "UserType": null,
      "UserName": null,
      "ReviewHistoryDescription": null,
      "ProductIds": null,
      "IsFromSitecore": false,
      "YouTubeVideoUrl": "",
      "ArtworkID": null,
      "RequireCustomization": false,
      "ArtworkLowResUri": null,
      "ArtworkThumbnailUri": null,
      "ProductAsset": [],
      "SupplierName": null,
      "SupplierTypeName": null,
      "ManufacturerName": null,
      "ProductTypeName": null,
      "SkuName": null,
      "TaxClassName": null,
      "SkuId": 0,
      "ShippingRule": null,
      "AttributeIds": null,
      "QuantityOnHand": null,
      "ReorderLevel": null,
      "RedirectUrlInd": false,
      "CategoryIds": null,
      "ReviewStateString": null,
      "UOM": null,
      "SizeOfPacket": null,
      "TierDiscountType": null,
      "CategoryCount": 0.0
    },
    "ProductCategoryId": 1,
    "ProductId": 302,
    "ThemeId": null
  },
  "ErrorCode": null,
  "ErrorMessage": null,
  "StackTrace": null,
  "AllowHtmlResponse": false,
  "HasError": false,
  "StringResponse": null
}