getCollection
get
/ccagent/v1/collections/{id}
Get Collection. Get a collection by ID. Unlike the Admin/Store endpoints, this can generate category's dimension id and expand child categories. Takes X-CCAgentContext header which is a JSON object with 'shopperProfileId' as a property. If 'shopperProfileId' is not provided, it is considered as an anonymous profile.Additonally takes x-ccsite header to return the data specific to the site
Request
Supported Media Types
- application/json
Path Parameters
- id
-
Type:
stringRequired:trueID of collection.
Query Parameters
- catalogId
-
Type:
stringID of catalog. If a catalogId is not passed, the catalog associated with the shopperProfileId passed in the X-CCAgentContext header is used. If no shopperProfileId is passed in the header, default catalog associated with the site is used.- depth
Type:stringDepth of search, either 'max' or 'min'.- disableActiveProdCheck
Type:booleanFalse indicates category details are not returned if there are no active products under the category. True indicates category details are returned irrespective of the active products availability.- expand
Type:stringIf set to childCategories, then child categories will be expanded to include details, if there are any active products under it. disableActiveProdCheck can be set to true in case the category details are needed irrespective of active products are available.- maxLevel
Type:stringMaximum level of depth for child categories.- op
Type:stringIf set to selectedCategoryDetails, then the details of the requested category and its dimension ID are returned.Header Parameters- x-ccsite
-
Type:
stringthe site id on which the orders is laced
Response
Supported Media Types- application/json
200 ResponseFollowing model is returned when operation succeeds.BodyRoot Schema : getCollection_response- ancestorCategories
-
Type:
arrayancestorCategoriesArray of category objects. - categoryImages
-
Type:
arraycategoryImagesArray of category image objects. - childCategories
-
Type:
arraychildCategoriesArray of child category objects. - childProducts
-
Type:
arraychildProductsArray of child products. - description
-
Type:
stringDescription of the category. - displayName
-
Type:
stringDisplay Name of the category. - fixedChildCategories
-
Type:
arrayfixedChildCategoriesArray of category objects. - fixedChildProducts
-
Type:
arrayfixedChildProductsArray of fixed child products. - fixedParentCategories
-
Type:
arrayfixedParentCategoriesArray of fixed child category objects. - id
-
Type:
stringCategory ID. - keywords
-
Type:
arraykeywordsArray of keywords. - longDescription
-
Type:
stringLong description of the category. - name
-
Type:
stringName of the category. - repositoryId
-
Type:
stringRepository ID. - route
-
Type:
stringRoute of the category.
Nested Schema : categoryImagesNested Schema : childCategoriesNested Schema : fixedChildCategoriesNested Schema : fixedChildProductsNested Schema : fixedParentCategoriesNested Schema : itemsType:object- repositoryId
-
Type:
stringRepository id of ancestor child category.
Nested Schema : itemsType:objectNested Schema : itemsType:object- displayName
-
Type:
stringDisplay name of the child category. - id
-
Type:
stringID of the child category. - longDescription
-
Type:
stringLong description of the child category. - route
-
Type:
stringRoute of the child category.
Nested Schema : itemsType:object- repositoryId
-
Type:
stringRepository id of child product.
Nested Schema : itemsType:object- categoryImages
-
Type:
arraycategoryImagesArray of category image objects. - childCategories
-
Type:
arraychildCategoriesArray of child category objects. - description
-
Type:
stringDescription of fixed child category. - displayName
-
Type:
stringDisplay name of fixed child category. - fixedParentCategories
-
Type:
arrayfixedParentCategoriesArray of category objects. - id
-
Type:
stringID of fixed child category. - name
-
Type:
stringName of fixed child category. - repositoryId
-
Type:
stringrepository ID of fixed child category. - route
-
Type:
stringRoute category of fixed child category.
Nested Schema : categoryImagesNested Schema : childCategoriesNested Schema : fixedParentCategoriesNested Schema : itemsType:objectNested Schema : itemsType:object- repositoryId
-
Type:
stringRepository ID of child category.
Nested Schema : itemsType:object- repositoryId
-
Type:
stringRepository ID of fixed parent category.
Nested Schema : itemsType:objectNested Schema : itemsType:object- repositoryId
-
Type:
stringRepository ID of parent category.
Nested Schema : itemsType:objectExample application/json
{ "longDescription":"Commerce Cloud Root Category", "childProducts":null, "keywords":[ ], "categoryImages":[ ], "displayName":"Storefront Navigation", "fixedChildCategories":[ { "longDescription":null, "childProducts":null, "keywords":[ ], "categoryImages":[ ], "displayName":"Movie Store Root", "fixedChildCategories":[ { "repositoryId":"cat40014" }, { "repositoryId":"cat40015" }, { "repositoryId":"cat40016" }, { "repositoryId":"cat40017" }, { "repositoryId":"cat40018" }, { "repositoryId":"cat60020" } ], "description":null, "childCategories":[ { "repositoryId":"cat40014" }, { "repositoryId":"cat40015" }, { "repositoryId":"cat40016" }, { "repositoryId":"cat40017" }, { "repositoryId":"cat40018" }, { "repositoryId":"cat60020" } ], "fixedChildProducts":[ ], "fixedParentCategories":[ { "repositoryId":"rootCategory" } ], "route":"/category/cat40013", "repositoryId":"cat40013", "name":"cat40013", "ancestorCategories":[ ], "id":"cat40013" }, { "longDescription":null, "childProducts":null, "keywords":[ ], "categoryImages":[ ], "displayName":"Video Game Store Root Category", "fixedChildCategories":[ { "repositoryId":"cat60034" }, { "repositoryId":"cat60035" }, { "repositoryId":"cat60044" }, { "repositoryId":"cat80048" } ], "description":null, "childCategories":[ { "repositoryId":"cat60034" }, { "repositoryId":"cat60035" }, { "repositoryId":"cat60044" }, { "repositoryId":"cat80048" } ], "fixedChildProducts":[ ], "fixedParentCategories":[ { "repositoryId":"rootCategory" } ], "route":"/category/cat60023", "repositoryId":"cat60023", "name":"cat60023", "ancestorCategories":[ ], "id":"cat60023" }, { "longDescription":null, "childProducts":null, "keywords":[ ], "categoryImages":[ ], "displayName":"Cloud Lake Outdoor temporary cat", "fixedChildCategories":[ ], "description":null, "childCategories":null, "fixedChildProducts":[ ], "fixedParentCategories":[ { "repositoryId":"rootCategory" } ], "route":"/category/catOutdoor", "repositoryId":"catOutdoor", "name":"catOutdoor", "ancestorCategories":[ ], "id":"catOutdoor" }, { "longDescription":null, "childProducts":null, "keywords":[ ], "categoryImages":[ ], "displayName":"Clearance Movies", "fixedChildCategories":[ { "repositoryId":"cat70001" }, { "repositoryId":"cat70002" }, { "repositoryId":"cat70003" }, { "repositoryId":"cat70004" } ], "description":null, "childCategories":[ { "repositoryId":"cat70001" }, { "repositoryId":"cat70002" }, { "repositoryId":"cat70003" }, { "repositoryId":"cat70004" } ], "fixedChildProducts":[ ], "fixedParentCategories":[ { "repositoryId":"rootCategory" } ], "route":"/category/clearanceCat", "repositoryId":"clearanceCat", "name":"clearanceCat", "ancestorCategories":[ ], "id":"clearanceCat" }, { "longDescription":null, "childProducts":[ { "repositoryId":"Product_27Fxyzi" }, { "repositoryId":"Product_27Fxyzii" }, { "repositoryId":"Product_14Cxy" }, { "repositoryId":"Product_36Exy" }, { "repositoryId":"Product_2D" }, { "repositoryId":"Product_35Fxy" }, { "repositoryId":"Product_24C" }, { "repositoryId":"Product_17Cyii" }, { "repositoryId":"Product_10C" }, { "repositoryId":"Product_16Cxy" }, { "repositoryId":"Product_23Cxyi" }, { "repositoryId":"Product_17Cxi" }, { "repositoryId":"Product_23Cxyii" }, { "repositoryId":"Product_23Cxyiii" }, { "repositoryId":"Product_6Dxyi" }, { "repositoryId":"Product_9E" }, { "repositoryId":"Product_12Cxy" }, { "repositoryId":"Product_5Dxy" }, { "repositoryId":"Product_1Cii" } ], "keywords":[ ], "categoryImages":[ ], "displayName":"Blockbuster", "fixedChildCategories":[ ], "description":null, "childCategories":null, "fixedChildProducts":[ { "repositoryId":"Product_27Fxyzi" }, { "repositoryId":"Product_27Fxyzii" }, { "repositoryId":"Product_14Cxy" }, { "repositoryId":"Product_36Exy" }, { "repositoryId":"Product_2D" }, { "repositoryId":"Product_35Fxy" }, { "repositoryId":"Product_24C" }, { "repositoryId":"Product_17Cyii" }, { "repositoryId":"Product_10C" }, { "repositoryId":"Product_16Cxy" }, { "repositoryId":"Product_23Cxyi" }, { "repositoryId":"Product_17Cxi" }, { "repositoryId":"Product_23Cxyii" }, { "repositoryId":"Product_23Cxyiii" }, { "repositoryId":"Product_6Dxyi" }, { "repositoryId":"Product_9E" }, { "repositoryId":"Product_12Cxy" }, { "repositoryId":"Product_5Dxy" }, { "repositoryId":"Product_1Cii" } ], "fixedParentCategories":[ { "repositoryId":"rootCategory" }, { "repositoryId":"dummyRootCategory" } ], "route":"/category/topLeaf", "repositoryId":"topLeaf", "name":"topLeaf", "ancestorCategories":[ ], "id":"topLeaf" }, { "longDescription":null, "childProducts":[ { "repositoryId":"camera_1" }, { "repositoryId":"camcorder_1" }, { "repositoryId":"Camera_1001" }, { "repositoryId":"Camera_1002" }, { "repositoryId":"Camera_1003" }, { "repositoryId":"Camera_1004" }, { "repositoryId":"Camera_1005" } ], "keywords":[ ], "categoryImages":[ ], "displayName":"Cameras and Camcorders", "fixedChildCategories":[ ], "description":null, "childCategories":null, "fixedChildProducts":[ { "repositoryId":"camera_1" }, { "repositoryId":"camcorder_1" }, { "repositoryId":"Camera_1001" }, { "repositoryId":"Camera_1002" }, { "repositoryId":"Camera_1003" }, { "repositoryId":"Camera_1004" }, { "repositoryId":"Camera_1005" } ], "fixedParentCategories":[ { "repositoryId":"rootCategory" } ], "route":"/category/cameracat", "repositoryId":"cameracat", "name":"Cameras and Camcorders", "ancestorCategories":[ ], "id":"cameracat" }, { "longDescription":null, "childProducts":[ { "repositoryId":"Product_15CD" }, { "repositoryId":"Product_18Cxi" }, { "repositoryId":"Product_18Cyii" }, { "repositoryId":"Product_13C" }, { "repositoryId":"Product_13CD" }, { "repositoryId":"Product_11D" }, { "repositoryId":"Product_29E" }, { "repositoryId":"prod10002" }, { "repositoryId":"prod10021" }, { "repositoryId":"prod10038" }, { "repositoryId":"prod10037" }, { "repositoryId":"prod10020" }, { "repositoryId":"prod10031" }, { "repositoryId":"prod10011" }, { "repositoryId":"prod10012" }, { "repositoryId":"prod20002" }, { "repositoryId":"prod10030" }, { "repositoryId":"prod10017" }, { "repositoryId":"prod10024" }, { "repositoryId":"prod10025" }, { "repositoryId":"Product_6Cx" }, { "repositoryId":"Product_3Di" }, { "repositoryId":"Product_4C" }, { "repositoryId":"Product_4D" }, { "repositoryId":"Product_34Ei" }, { "repositoryId":"Product_20Cxy" }, { "repositoryId":"Product_33E" }, { "repositoryId":"Product_25Dxy" }, { "repositoryId":"Product_8Dxi" }, { "repositoryId":"Product_8Dyii" }, { "repositoryId":"Product_19Cxy" }, { "repositoryId":"Product_27Fxyzi" }, { "repositoryId":"Product_6Dxyi" }, { "repositoryId":"Product_9E" }, { "repositoryId":"prod10043" }, { "repositoryId":"prod10032" }, { "repositoryId":"Product_12Cxy" }, { "repositoryId":"prod10026" }, { "repositoryId":"Product_2D" }, { "repositoryId":"prod10027" }, { "repositoryId":"Product_5Cx" }, { "repositoryId":"Product_21Cxi" }, { "repositoryId":"prod10041" }, { "repositoryId":"prod10042" }, { "repositoryId":"prod10044" }, { "repositoryId":"prod10035" }, { "repositoryId":"prod10003" }, { "repositoryId":"Product_35Fxy" }, { "repositoryId":"prod10028" }, { "repositoryId":"Product_22Cxyi" }, { "repositoryId":"Product_22Cxyii" }, { "repositoryId":"Product_3Dii" }, { "repositoryId":"Product_32Dxy" }, { "repositoryId":"Product_31Dxy" }, { "repositoryId":"Product_6Dxyii" }, { "repositoryId":"Product_1Ci" }, { "repositoryId":"Product_17Cxi" }, { "repositoryId":"prod10036" }, { "repositoryId":"prod10006" }, { "repositoryId":"prod10004" }, { "repositoryId":"Product_7D" }, { "repositoryId":"prod10016" }, { "repositoryId":"prod10023" }, { "repositoryId":"prod10013" }, { "repositoryId":"prod10014" }, { "repositoryId":"prod10018" }, { "repositoryId":"prod10015" }, { "repositoryId":"prod10019" }, { "repositoryId":"Product_24C" }, { "repositoryId":"Product_16Cxy" }, { "repositoryId":"prod10034" }, { "repositoryId":"prod10045" }, { "repositoryId":"Product_1Cii" }, { "repositoryId":"Product_21Cyii" }, { "repositoryId":"Product_17Cyii" }, { "repositoryId":"Product_27Fxyzii" }, { "repositoryId":"Product_23Cxyi" }, { "repositoryId":"Product_23Cxyii" }, { "repositoryId":"Product_23Cxyiii" }, { "repositoryId":"prod10039" }, { "repositoryId":"prod10005" }, { "repositoryId":"prod10022" }, { "repositoryId":"prod10040" }, { "repositoryId":"Product_14Cxy" }, { "repositoryId":"Product_5Dxy" }, { "repositoryId":"Product_36Exy" }, { "repositoryId":"Product_10C" }, { "repositoryId":"Product_26Fxy" } ], "keywords":[ ], "categoryImages":[ ], "displayName":"All Products", "fixedChildCategories":[ ], "description":null, "childCategories":null, "fixedChildProducts":[ { "repositoryId":"Product_15CD" }, { "repositoryId":"Product_18Cxi" }, { "repositoryId":"Product_18Cyii" }, { "repositoryId":"Product_13C" }, { "repositoryId":"Product_13CD" }, { "repositoryId":"Product_11D" }, { "repositoryId":"Product_29E" }, { "repositoryId":"prod10002" }, { "repositoryId":"prod10021" }, { "repositoryId":"prod10038" }, { "repositoryId":"prod10037" }, { "repositoryId":"prod10020" }, { "repositoryId":"prod10031" }, { "repositoryId":"prod10011" }, { "repositoryId":"prod10012" }, { "repositoryId":"prod20002" }, { "repositoryId":"prod10030" }, { "repositoryId":"prod10017" }, { "repositoryId":"prod10024" }, { "repositoryId":"prod10025" }, { "repositoryId":"Product_6Cx" }, { "repositoryId":"Product_3Di" }, { "repositoryId":"Product_4C" }, { "repositoryId":"Product_4D" }, { "repositoryId":"Product_34Ei" }, { "repositoryId":"Product_20Cxy" }, { "repositoryId":"Product_33E" }, { "repositoryId":"Product_25Dxy" }, { "repositoryId":"Product_8Dxi" }, { "repositoryId":"Product_8Dyii" }, { "repositoryId":"Product_19Cxy" }, { "repositoryId":"Product_27Fxyzi" }, { "repositoryId":"Product_6Dxyi" }, { "repositoryId":"Product_9E" }, { "repositoryId":"prod10043" }, { "repositoryId":"prod10032" }, { "repositoryId":"Product_12Cxy" }, { "repositoryId":"prod10026" }, { "repositoryId":"Product_2D" }, { "repositoryId":"prod10027" }, { "repositoryId":"Product_5Cx" }, { "repositoryId":"Product_21Cxi" }, { "repositoryId":"prod10041" }, { "repositoryId":"prod10042" }, { "repositoryId":"prod10044" }, { "repositoryId":"prod10035" }, { "repositoryId":"prod10003" }, { "repositoryId":"Product_35Fxy" }, { "repositoryId":"prod10028" }, { "repositoryId":"Product_22Cxyi" }, { "repositoryId":"Product_22Cxyii" }, { "repositoryId":"Product_3Dii" }, { "repositoryId":"Product_32Dxy" }, { "repositoryId":"Product_31Dxy" }, { "repositoryId":"Product_6Dxyii" }, { "repositoryId":"Product_1Ci" }, { "repositoryId":"Product_17Cxi" }, { "repositoryId":"prod10036" }, { "repositoryId":"prod10006" }, { "repositoryId":"prod10004" }, { "repositoryId":"Product_7D" }, { "repositoryId":"prod10016" }, { "repositoryId":"prod10023" }, { "repositoryId":"prod10013" }, { "repositoryId":"prod10014" }, { "repositoryId":"prod10018" }, { "repositoryId":"prod10015" }, { "repositoryId":"prod10019" }, { "repositoryId":"Product_24C" }, { "repositoryId":"Product_16Cxy" }, { "repositoryId":"prod10034" }, { "repositoryId":"prod10045" }, { "repositoryId":"Product_1Cii" }, { "repositoryId":"Product_21Cyii" }, { "repositoryId":"Product_17Cyii" }, { "repositoryId":"Product_27Fxyzii" }, { "repositoryId":"Product_23Cxyi" }, { "repositoryId":"Product_23Cxyii" }, { "repositoryId":"Product_23Cxyiii" }, { "repositoryId":"prod10039" }, { "repositoryId":"prod10005" }, { "repositoryId":"prod10022" }, { "repositoryId":"prod10040" }, { "repositoryId":"Product_14Cxy" }, { "repositoryId":"Product_5Dxy" }, { "repositoryId":"Product_36Exy" }, { "repositoryId":"Product_10C" }, { "repositoryId":"Product_26Fxy" } ], "fixedParentCategories":[ { "repositoryId":"rootCategory" } ], "route":"/category/AllProdPagination", "repositoryId":"AllProdPagination", "name":"AllProdPagination", "ancestorCategories":[ ], "id":"AllProdPagination" } ], "description":null, "childCategories":[ { "longDescription":null, "route":"/category/cat40013", "displayName":"Movie Store Root", "childCategories":[ { "longDescription":null, "route":"/category/cat40014", "displayName":"Action", "childCategories":[ { "longDescription":null, "route":"/category/Category_14Bxi", "displayName":"Psychological Thrillers", "id":"Category_14Bxi" }, { "longDescription":null, "route":"/category/Category_35Exy", "displayName":"Fan Favorites", "id":"Category_35Exy" }, { "longDescription":null, "route":"/category/Category_16Byii", "displayName":"Video Game Adaptations", "id":"Category_16Byii" }, { "longDescription":null, "route":"/category/cat40009", "displayName":"Fantasy", "id":"cat40009" } ], "id":"cat40014" }, { "longDescription":null, "route":"/category/cat40015", "displayName":"Drama", "childCategories":[ { "longDescription":null, "route":"/category/cat40011", "displayName":"Award Winners", "id":"cat40011" }, { "longDescription":null, "route":"/category/cat40010", "displayName":"Sports", "id":"cat40010" } ], "id":"cat40015" }, { "longDescription":null, "route":"/category/cat40016", "displayName":"TV", "childCategories":[ { "longDescription":null, "route":"/category/cat40007", "displayName":"Kids", "id":"cat40007" }, { "longDescription":null, "route":"/category/cat40006", "displayName":"TV Drama", "id":"cat40006" }, { "longDescription":null, "route":"/category/cat40008", "displayName":"TV Comedy", "id":"cat40008" } ], "id":"cat40016" }, { "longDescription":null, "route":"/category/cat40017", "displayName":"Comedy", "childCategories":[ { "longDescription":null, "route":"/category/cat40004", "displayName":"Classics", "id":"cat40004" }, { "longDescription":null, "route":"/category/cat40005", "displayName":"Romantic Comedies", "id":"cat40005" } ], "id":"cat40017" }, { "longDescription":null, "route":"/category/cat40018", "displayName":"Eclectic", "childCategories":[ { "longDescription":null, "route":"/category/cat40012", "displayName":"Popular", "id":"cat40012" } ], "id":"cat40018" }, { "longDescription":null, "route":"/category/cat60020", "displayName":"Seasonal Sale", "childCategories":[ { "longDescription":null, "route":"/category/cat60021", "displayName":"Holiday", "id":"cat60021" }, { "longDescription":null, "route":"/category/cat60022", "displayName":"Summer", "id":"cat60022" } ], "id":"cat60020" } ], "id":"cat40013" }, { "longDescription":null, "route":"/category/cat60023", "displayName":"Video Game Store Root Category", "childCategories":[ { "longDescription":null, "route":"/category/cat60034", "displayName":"Consoles", "childCategories":[ { "longDescription":null, "route":"/category/cat60036", "displayName":"Nintendo", "id":"cat60036" }, { "longDescription":null, "route":"/category/cat60037", "displayName":"Sony", "id":"cat60037" }, { "longDescription":null, "route":"/category/cat60039", "displayName":"Microsoft", "id":"cat60039" } ], "id":"cat60034" }, { "longDescription":null, "route":"/category/cat60035", "displayName":"Accessories", "childCategories":[ { "longDescription":null, "route":"/category/cat60041", "displayName":"Controllers", "id":"cat60041" }, { "longDescription":null, "route":"/category/cat60042", "displayName":"Multiplayer", "id":"cat60042" }, { "longDescription":null, "route":"/category/cat60043", "displayName":"A / V", "id":"cat60043" } ], "id":"cat60035" }, { "longDescription":null, "route":"/category/cat60044", "displayName":"Games", "childCategories":[ { "longDescription":null, "route":"/category/cat60027", "displayName":"XBOX 360", "id":"cat60027" }, { "longDescription":null, "route":"/category/cat60028", "displayName":"PS3", "id":"cat60028" }, { "longDescription":null, "route":"/category/cat60029", "displayName":"Wii", "id":"cat60029" } ], "id":"cat60044" }, { "longDescription":null, "route":"/category/cat80048", "displayName":"On Sale", "childCategories":[ { "longDescription":null, "route":"/category/cat80050", "displayName":"Movies", "id":"cat80050" }, { "longDescription":null, "route":"/category/cat80051", "displayName":"Video Games", "id":"cat80051" } ], "id":"cat80048" } ], "id":"cat60023" }, { "longDescription":null, "route":"/category/clearanceCat", "displayName":"Clearance Movies", "childCategories":[ { "longDescription":null, "route":"/category/cat70001", "displayName":"Action-clearance", "childCategories":[ { "longDescription":null, "route":"/category/cat70011", "displayName":"Thrillers-Clearance", "id":"cat70011" }, { "longDescription":null, "route":"/category/cat70012", "displayName":"Fan Favorites-Clearance", "id":"cat70012" }, { "longDescription":null, "route":"/category/cat70013", "displayName":"Fantasy-Clearance", "id":"cat70013" } ], "id":"cat70001" }, { "longDescription":null, "route":"/category/cat70002", "displayName":"Drama-clearance", "id":"cat70002" }, { "longDescription":null, "route":"/category/cat70004", "displayName":"Comedy-clearance", "childCategories":[ { "longDescription":null, "route":"/category/cat70014", "displayName":"Classics-Clearance", "id":"cat70014" }, { "longDescription":null, "route":"/category/cat70015", "displayName":"Romantics-Clearance", "id":"cat70015" } ], "id":"cat70004" } ], "id":"clearanceCat" }, { "longDescription":null, "route":"/category/topLeaf", "displayName":"Blockbuster", "id":"topLeaf" }, { "longDescription":null, "route":"/category/cameracat", "displayName":"Cameras and Camcorders", "id":"cameracat" }, { "longDescription":null, "route":"/category/AllProdPagination", "displayName":"All Products", "id":"AllProdPagination" } ], "fixedChildProducts":[ ], "fixedParentCategories":[ ], "route":"/category/rootCategory", "repositoryId":"rootCategory", "name":"Root Category", "links":[ { "rel":"self", "href":"http://localhost:9080/ccagent/v1/collections/rootCategory?depth=min&maxLevel=1000&expand=childCategories" } ], "ancestorCategories":[ ], "id":"rootCategory" }Default ResponseThe error responseBodyRoot Schema : errorModelType:object- devMessage
-
Type:
stringAn optional non-localized message containing technical information for developers - errorCode
-
Type:
stringThe numerical code identifying the error - errors
-
Type:
arrayerrorsAn optional list of errors if multiple errors were encountered - message
-
Type:
stringThe localized message describing the error - moreInfo
-
Type:
stringAn optional non-localized message with more information - o:errorPath
-
Type:
stringAn optional machine readable description of where the error occurred - status
-
Type:
stringThe HTTP status code - type
-
Type:
stringThe URI to the HTTP state code definition
Nested Schema : errorsNested Schema : itemsType:object- devMessage
-
Type:
stringAn optional non-localized message containing technical information for developers - errorCode
-
Type:
stringThe numerical code identifying the error - message
-
Type:
stringThe localized message describing the error - moreInfo
-
Type:
stringAn optional non-localized message with more information - o:errorPath
-
Type:
stringAn optional machine readable description of where the error occurred - status
-
Type:
stringThe HTTP status code
Examples
Sample Response Payload returned by endpoint:
{ "longDescription": "Commerce Cloud Root Category", "childProducts": null, "keywords": [], "categoryImages": [], "displayName": "Storefront Navigation", "fixedChildCategories": [ { "longDescription": null, "childProducts": null, "keywords": [], "categoryImages": [], "displayName": "Movie Store Root", "fixedChildCategories": [ {"repositoryId": "cat40014"}, {"repositoryId": "cat40015"}, {"repositoryId": "cat40016"}, {"repositoryId": "cat40017"}, {"repositoryId": "cat40018"}, {"repositoryId": "cat60020"} ], "description": null, "childCategories": [ {"repositoryId": "cat40014"}, {"repositoryId": "cat40015"}, {"repositoryId": "cat40016"}, {"repositoryId": "cat40017"}, {"repositoryId": "cat40018"}, {"repositoryId": "cat60020"} ], "fixedChildProducts": [], "fixedParentCategories": [{"repositoryId": "rootCategory"}], "route": "/category/cat40013", "repositoryId": "cat40013", "name": "cat40013", "ancestorCategories": [], "id": "cat40013" }, { "longDescription": null, "childProducts": null, "keywords": [], "categoryImages": [], "displayName": "Video Game Store Root Category", "fixedChildCategories": [ {"repositoryId": "cat60034"}, {"repositoryId": "cat60035"}, {"repositoryId": "cat60044"}, {"repositoryId": "cat80048"} ], "description": null, "childCategories": [ {"repositoryId": "cat60034"}, {"repositoryId": "cat60035"}, {"repositoryId": "cat60044"}, {"repositoryId": "cat80048"} ], "fixedChildProducts": [], "fixedParentCategories": [{"repositoryId": "rootCategory"}], "route": "/category/cat60023", "repositoryId": "cat60023", "name": "cat60023", "ancestorCategories": [], "id": "cat60023" }, { "longDescription": null, "childProducts": null, "keywords": [], "categoryImages": [], "displayName": "Cloud Lake Outdoor temporary cat", "fixedChildCategories": [], "description": null, "childCategories": null, "fixedChildProducts": [], "fixedParentCategories": [{"repositoryId": "rootCategory"}], "route": "/category/catOutdoor", "repositoryId": "catOutdoor", "name": "catOutdoor", "ancestorCategories": [], "id": "catOutdoor" }, { "longDescription": null, "childProducts": null, "keywords": [], "categoryImages": [], "displayName": "Clearance Movies", "fixedChildCategories": [ {"repositoryId": "cat70001"}, {"repositoryId": "cat70002"}, {"repositoryId": "cat70003"}, {"repositoryId": "cat70004"} ], "description": null, "childCategories": [ {"repositoryId": "cat70001"}, {"repositoryId": "cat70002"}, {"repositoryId": "cat70003"}, {"repositoryId": "cat70004"} ], "fixedChildProducts": [], "fixedParentCategories": [{"repositoryId": "rootCategory"}], "route": "/category/clearanceCat", "repositoryId": "clearanceCat", "name": "clearanceCat", "ancestorCategories": [], "id": "clearanceCat" }, { "longDescription": null, "childProducts": [ {"repositoryId": "Product_27Fxyzi"}, {"repositoryId": "Product_27Fxyzii"}, {"repositoryId": "Product_14Cxy"}, {"repositoryId": "Product_36Exy"}, {"repositoryId": "Product_2D"}, {"repositoryId": "Product_35Fxy"}, {"repositoryId": "Product_24C"}, {"repositoryId": "Product_17Cyii"}, {"repositoryId": "Product_10C"}, {"repositoryId": "Product_16Cxy"}, {"repositoryId": "Product_23Cxyi"}, {"repositoryId": "Product_17Cxi"}, {"repositoryId": "Product_23Cxyii"}, {"repositoryId": "Product_23Cxyiii"}, {"repositoryId": "Product_6Dxyi"}, {"repositoryId": "Product_9E"}, {"repositoryId": "Product_12Cxy"}, {"repositoryId": "Product_5Dxy"}, {"repositoryId": "Product_1Cii"} ], "keywords": [], "categoryImages": [], "displayName": "Blockbuster", "fixedChildCategories": [], "description": null, "childCategories": null, "fixedChildProducts": [ {"repositoryId": "Product_27Fxyzi"}, {"repositoryId": "Product_27Fxyzii"}, {"repositoryId": "Product_14Cxy"}, {"repositoryId": "Product_36Exy"}, {"repositoryId": "Product_2D"}, {"repositoryId": "Product_35Fxy"}, {"repositoryId": "Product_24C"}, {"repositoryId": "Product_17Cyii"}, {"repositoryId": "Product_10C"}, {"repositoryId": "Product_16Cxy"}, {"repositoryId": "Product_23Cxyi"}, {"repositoryId": "Product_17Cxi"}, {"repositoryId": "Product_23Cxyii"}, {"repositoryId": "Product_23Cxyiii"}, {"repositoryId": "Product_6Dxyi"}, {"repositoryId": "Product_9E"}, {"repositoryId": "Product_12Cxy"}, {"repositoryId": "Product_5Dxy"}, {"repositoryId": "Product_1Cii"} ], "fixedParentCategories": [ {"repositoryId": "rootCategory"}, {"repositoryId": "dummyRootCategory"} ], "route": "/category/topLeaf", "repositoryId": "topLeaf", "name": "topLeaf", "ancestorCategories": [], "id": "topLeaf" }, { "longDescription": null, "childProducts": [ {"repositoryId": "camera_1"}, {"repositoryId": "camcorder_1"}, {"repositoryId": "Camera_1001"}, {"repositoryId": "Camera_1002"}, {"repositoryId": "Camera_1003"}, {"repositoryId": "Camera_1004"}, {"repositoryId": "Camera_1005"} ], "keywords": [], "categoryImages": [], "displayName": "Cameras and Camcorders", "fixedChildCategories": [], "description": null, "childCategories": null, "fixedChildProducts": [ {"repositoryId": "camera_1"}, {"repositoryId": "camcorder_1"}, {"repositoryId": "Camera_1001"}, {"repositoryId": "Camera_1002"}, {"repositoryId": "Camera_1003"}, {"repositoryId": "Camera_1004"}, {"repositoryId": "Camera_1005"} ], "fixedParentCategories": [{"repositoryId": "rootCategory"}], "route": "/category/cameracat", "repositoryId": "cameracat", "name": "Cameras and Camcorders", "ancestorCategories": [], "id": "cameracat" }, { "longDescription": null, "childProducts": [ {"repositoryId": "Product_15CD"}, {"repositoryId": "Product_18Cxi"}, {"repositoryId": "Product_18Cyii"}, {"repositoryId": "Product_13C"}, {"repositoryId": "Product_13CD"}, {"repositoryId": "Product_11D"}, {"repositoryId": "Product_29E"}, {"repositoryId": "prod10002"}, {"repositoryId": "prod10021"}, {"repositoryId": "prod10038"}, {"repositoryId": "prod10037"}, {"repositoryId": "prod10020"}, {"repositoryId": "prod10031"}, {"repositoryId": "prod10011"}, {"repositoryId": "prod10012"}, {"repositoryId": "prod20002"}, {"repositoryId": "prod10030"}, {"repositoryId": "prod10017"}, {"repositoryId": "prod10024"}, {"repositoryId": "prod10025"}, {"repositoryId": "Product_6Cx"}, {"repositoryId": "Product_3Di"}, {"repositoryId": "Product_4C"}, {"repositoryId": "Product_4D"}, {"repositoryId": "Product_34Ei"}, {"repositoryId": "Product_20Cxy"}, {"repositoryId": "Product_33E"}, {"repositoryId": "Product_25Dxy"}, {"repositoryId": "Product_8Dxi"}, {"repositoryId": "Product_8Dyii"}, {"repositoryId": "Product_19Cxy"}, {"repositoryId": "Product_27Fxyzi"}, {"repositoryId": "Product_6Dxyi"}, {"repositoryId": "Product_9E"}, {"repositoryId": "prod10043"}, {"repositoryId": "prod10032"}, {"repositoryId": "Product_12Cxy"}, {"repositoryId": "prod10026"}, {"repositoryId": "Product_2D"}, {"repositoryId": "prod10027"}, {"repositoryId": "Product_5Cx"}, {"repositoryId": "Product_21Cxi"}, {"repositoryId": "prod10041"}, {"repositoryId": "prod10042"}, {"repositoryId": "prod10044"}, {"repositoryId": "prod10035"}, {"repositoryId": "prod10003"}, {"repositoryId": "Product_35Fxy"}, {"repositoryId": "prod10028"}, {"repositoryId": "Product_22Cxyi"}, {"repositoryId": "Product_22Cxyii"}, {"repositoryId": "Product_3Dii"}, {"repositoryId": "Product_32Dxy"}, {"repositoryId": "Product_31Dxy"}, {"repositoryId": "Product_6Dxyii"}, {"repositoryId": "Product_1Ci"}, {"repositoryId": "Product_17Cxi"}, {"repositoryId": "prod10036"}, {"repositoryId": "prod10006"}, {"repositoryId": "prod10004"}, {"repositoryId": "Product_7D"}, {"repositoryId": "prod10016"}, {"repositoryId": "prod10023"}, {"repositoryId": "prod10013"}, {"repositoryId": "prod10014"}, {"repositoryId": "prod10018"}, {"repositoryId": "prod10015"}, {"repositoryId": "prod10019"}, {"repositoryId": "Product_24C"}, {"repositoryId": "Product_16Cxy"}, {"repositoryId": "prod10034"}, {"repositoryId": "prod10045"}, {"repositoryId": "Product_1Cii"}, {"repositoryId": "Product_21Cyii"}, {"repositoryId": "Product_17Cyii"}, {"repositoryId": "Product_27Fxyzii"}, {"repositoryId": "Product_23Cxyi"}, {"repositoryId": "Product_23Cxyii"}, {"repositoryId": "Product_23Cxyiii"}, {"repositoryId": "prod10039"}, {"repositoryId": "prod10005"}, {"repositoryId": "prod10022"}, {"repositoryId": "prod10040"}, {"repositoryId": "Product_14Cxy"}, {"repositoryId": "Product_5Dxy"}, {"repositoryId": "Product_36Exy"}, {"repositoryId": "Product_10C"}, {"repositoryId": "Product_26Fxy"} ], "keywords": [], "categoryImages": [], "displayName": "All Products", "fixedChildCategories": [], "description": null, "childCategories": null, "fixedChildProducts": [ {"repositoryId": "Product_15CD"}, {"repositoryId": "Product_18Cxi"}, {"repositoryId": "Product_18Cyii"}, {"repositoryId": "Product_13C"}, {"repositoryId": "Product_13CD"}, {"repositoryId": "Product_11D"}, {"repositoryId": "Product_29E"}, {"repositoryId": "prod10002"}, {"repositoryId": "prod10021"}, {"repositoryId": "prod10038"}, {"repositoryId": "prod10037"}, {"repositoryId": "prod10020"}, {"repositoryId": "prod10031"}, {"repositoryId": "prod10011"}, {"repositoryId": "prod10012"}, {"repositoryId": "prod20002"}, {"repositoryId": "prod10030"}, {"repositoryId": "prod10017"}, {"repositoryId": "prod10024"}, {"repositoryId": "prod10025"}, {"repositoryId": "Product_6Cx"}, {"repositoryId": "Product_3Di"}, {"repositoryId": "Product_4C"}, {"repositoryId": "Product_4D"}, {"repositoryId": "Product_34Ei"}, {"repositoryId": "Product_20Cxy"}, {"repositoryId": "Product_33E"}, {"repositoryId": "Product_25Dxy"}, {"repositoryId": "Product_8Dxi"}, {"repositoryId": "Product_8Dyii"}, {"repositoryId": "Product_19Cxy"}, {"repositoryId": "Product_27Fxyzi"}, {"repositoryId": "Product_6Dxyi"}, {"repositoryId": "Product_9E"}, {"repositoryId": "prod10043"}, {"repositoryId": "prod10032"}, {"repositoryId": "Product_12Cxy"}, {"repositoryId": "prod10026"}, {"repositoryId": "Product_2D"}, {"repositoryId": "prod10027"}, {"repositoryId": "Product_5Cx"}, {"repositoryId": "Product_21Cxi"}, {"repositoryId": "prod10041"}, {"repositoryId": "prod10042"}, {"repositoryId": "prod10044"}, {"repositoryId": "prod10035"}, {"repositoryId": "prod10003"}, {"repositoryId": "Product_35Fxy"}, {"repositoryId": "prod10028"}, {"repositoryId": "Product_22Cxyi"}, {"repositoryId": "Product_22Cxyii"}, {"repositoryId": "Product_3Dii"}, {"repositoryId": "Product_32Dxy"}, {"repositoryId": "Product_31Dxy"}, {"repositoryId": "Product_6Dxyii"}, {"repositoryId": "Product_1Ci"}, {"repositoryId": "Product_17Cxi"}, {"repositoryId": "prod10036"}, {"repositoryId": "prod10006"}, {"repositoryId": "prod10004"}, {"repositoryId": "Product_7D"}, {"repositoryId": "prod10016"}, {"repositoryId": "prod10023"}, {"repositoryId": "prod10013"}, {"repositoryId": "prod10014"}, {"repositoryId": "prod10018"}, {"repositoryId": "prod10015"}, {"repositoryId": "prod10019"}, {"repositoryId": "Product_24C"}, {"repositoryId": "Product_16Cxy"}, {"repositoryId": "prod10034"}, {"repositoryId": "prod10045"}, {"repositoryId": "Product_1Cii"}, {"repositoryId": "Product_21Cyii"}, {"repositoryId": "Product_17Cyii"}, {"repositoryId": "Product_27Fxyzii"}, {"repositoryId": "Product_23Cxyi"}, {"repositoryId": "Product_23Cxyii"}, {"repositoryId": "Product_23Cxyiii"}, {"repositoryId": "prod10039"}, {"repositoryId": "prod10005"}, {"repositoryId": "prod10022"}, {"repositoryId": "prod10040"}, {"repositoryId": "Product_14Cxy"}, {"repositoryId": "Product_5Dxy"}, {"repositoryId": "Product_36Exy"}, {"repositoryId": "Product_10C"}, {"repositoryId": "Product_26Fxy"} ], "fixedParentCategories": [{"repositoryId": "rootCategory"}], "route": "/category/AllProdPagination", "repositoryId": "AllProdPagination", "name": "AllProdPagination", "ancestorCategories": [], "id": "AllProdPagination" } ], "description": null, "childCategories": [ { "longDescription": null, "route": "/category/cat40013", "displayName": "Movie Store Root", "childCategories": [ { "longDescription": null, "route": "/category/cat40014", "displayName": "Action", "childCategories": [ { "longDescription": null, "route": "/category/Category_14Bxi", "displayName": "Psychological Thrillers", "id": "Category_14Bxi" }, { "longDescription": null, "route": "/category/Category_35Exy", "displayName": "Fan Favorites", "id": "Category_35Exy" }, { "longDescription": null, "route": "/category/Category_16Byii", "displayName": "Video Game Adaptations", "id": "Category_16Byii" }, { "longDescription": null, "route": "/category/cat40009", "displayName": "Fantasy", "id": "cat40009" } ], "id": "cat40014" }, { "longDescription": null, "route": "/category/cat40015", "displayName": "Drama", "childCategories": [ { "longDescription": null, "route": "/category/cat40011", "displayName": "Award Winners", "id": "cat40011" }, { "longDescription": null, "route": "/category/cat40010", "displayName": "Sports", "id": "cat40010" } ], "id": "cat40015" }, { "longDescription": null, "route": "/category/cat40016", "displayName": "TV", "childCategories": [ { "longDescription": null, "route": "/category/cat40007", "displayName": "Kids", "id": "cat40007" }, { "longDescription": null, "route": "/category/cat40006", "displayName": "TV Drama", "id": "cat40006" }, { "longDescription": null, "route": "/category/cat40008", "displayName": "TV Comedy", "id": "cat40008" } ], "id": "cat40016" }, { "longDescription": null, "route": "/category/cat40017", "displayName": "Comedy", "childCategories": [ { "longDescription": null, "route": "/category/cat40004", "displayName": "Classics", "id": "cat40004" }, { "longDescription": null, "route": "/category/cat40005", "displayName": "Romantic Comedies", "id": "cat40005" } ], "id": "cat40017" }, { "longDescription": null, "route": "/category/cat40018", "displayName": "Eclectic", "childCategories": [{ "longDescription": null, "route": "/category/cat40012", "displayName": "Popular", "id": "cat40012" }], "id": "cat40018" }, { "longDescription": null, "route": "/category/cat60020", "displayName": "Seasonal Sale", "childCategories": [ { "longDescription": null, "route": "/category/cat60021", "displayName": "Holiday", "id": "cat60021" }, { "longDescription": null, "route": "/category/cat60022", "displayName": "Summer", "id": "cat60022" } ], "id": "cat60020" } ], "id": "cat40013" }, { "longDescription": null, "route": "/category/cat60023", "displayName": "Video Game Store Root Category", "childCategories": [ { "longDescription": null, "route": "/category/cat60034", "displayName": "Consoles", "childCategories": [ { "longDescription": null, "route": "/category/cat60036", "displayName": "Nintendo", "id": "cat60036" }, { "longDescription": null, "route": "/category/cat60037", "displayName": "Sony", "id": "cat60037" }, { "longDescription": null, "route": "/category/cat60039", "displayName": "Microsoft", "id": "cat60039" } ], "id": "cat60034" }, { "longDescription": null, "route": "/category/cat60035", "displayName": "Accessories", "childCategories": [ { "longDescription": null, "route": "/category/cat60041", "displayName": "Controllers", "id": "cat60041" }, { "longDescription": null, "route": "/category/cat60042", "displayName": "Multiplayer", "id": "cat60042" }, { "longDescription": null, "route": "/category/cat60043", "displayName": "A / V", "id": "cat60043" } ], "id": "cat60035" }, { "longDescription": null, "route": "/category/cat60044", "displayName": "Games", "childCategories": [ { "longDescription": null, "route": "/category/cat60027", "displayName": "XBOX 360", "id": "cat60027" }, { "longDescription": null, "route": "/category/cat60028", "displayName": "PS3", "id": "cat60028" }, { "longDescription": null, "route": "/category/cat60029", "displayName": "Wii", "id": "cat60029" } ], "id": "cat60044" }, { "longDescription": null, "route": "/category/cat80048", "displayName": "On Sale", "childCategories": [ { "longDescription": null, "route": "/category/cat80050", "displayName": "Movies", "id": "cat80050" }, { "longDescription": null, "route": "/category/cat80051", "displayName": "Video Games", "id": "cat80051" } ], "id": "cat80048" } ], "id": "cat60023" }, { "longDescription": null, "route": "/category/clearanceCat", "displayName": "Clearance Movies", "childCategories": [ { "longDescription": null, "route": "/category/cat70001", "displayName": "Action-clearance", "childCategories": [ { "longDescription": null, "route": "/category/cat70011", "displayName": "Thrillers-Clearance", "id": "cat70011" }, { "longDescription": null, "route": "/category/cat70012", "displayName": "Fan Favorites-Clearance", "id": "cat70012" }, { "longDescription": null, "route": "/category/cat70013", "displayName": "Fantasy-Clearance", "id": "cat70013" } ], "id": "cat70001" }, { "longDescription": null, "route": "/category/cat70002", "displayName": "Drama-clearance", "id": "cat70002" }, { "longDescription": null, "route": "/category/cat70004", "displayName": "Comedy-clearance", "childCategories": [ { "longDescription": null, "route": "/category/cat70014", "displayName": "Classics-Clearance", "id": "cat70014" }, { "longDescription": null, "route": "/category/cat70015", "displayName": "Romantics-Clearance", "id": "cat70015" } ], "id": "cat70004" } ], "id": "clearanceCat" }, { "longDescription": null, "route": "/category/topLeaf", "displayName": "Blockbuster", "id": "topLeaf" }, { "longDescription": null, "route": "/category/cameracat", "displayName": "Cameras and Camcorders", "id": "cameracat" }, { "longDescription": null, "route": "/category/AllProdPagination", "displayName": "All Products", "id": "AllProdPagination" } ], "fixedChildProducts": [], "fixedParentCategories": [], "route": "/category/rootCategory", "repositoryId": "rootCategory", "name": "Root Category", "links": [{ "rel": "self", "href": "http://localhost:9080/ccagent/v1/collections/rootCategory?depth=min&maxLevel=1000&expand=childCategories" }], "ancestorCategories": [], "id": "rootCategory" }