This class provides RESTful services to get category data for search-based catalog navigation. It performs the services by delegating to the CatalogNavigationView BOD service.
com.ibm.commerce.rest.search.handler.CategoryViewHandler
HTTP Method | Path | Description |
---|---|---|
GET | /store/{storeId}/categoryview/{categoryIdentifier} | Gets category details based on its identifier. |
GET | /store/{storeId}/categoryview/@top | Gets all top level categories. |
GET | /store/{storeId}/categoryview/byId/{categoryId} | Gets category details based on its unique ID. |
GET | /store/{storeId}/categoryview/byParentCategory/{parentCategoryId} | Gets child categories based on the parent category unique ID. |
Gets category details based on its identifier.
findCategoryByIdentifier
false
true
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
categoryIdentifier | Category Identifier. | path | string | true | N/A |
catalogId | The catalog identifier. If none is specified, the store default catalog shall be used. | query | string | false | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
404 | The specified resource couldn't be found. |
500 | Internal server error. Additional details will be contained on the server logs. |
GET /wcs/resources/store/10001/categoryview/Apparel
200
{ "CatalogGroupView": [ { "fullImage": "images\/catalog\/apparel\/women\/category\/catr_wcl_pants.png", "fullImageAltDescription": "Image for Apparel from Aurora", "identifier": "Apparel", "metaDescription": "The latest styles for the entire family.", "metaKeyword": "family apparel, cloths, shirt, pants, tops, bottoms, dresses, dress", "name": "Apparel", "productsURL": "http:\/\/localhost:80\/wcs\/resources\/store\/10001\/productview\/byCategory\/10001", "resourceId": "http:\/\/localhost:80\/wcs\/resources\/store\/10001\/categoryview\/byId\/10001", "shortDescription": "The latest styles for the entire family.", "thumbnail": "images\/catalog\/apparel\/women\/category\/catr_wcl_pants.png", "title": "Apparel | Aurora", "uniqueID": "10001" } ], "MetaData": [ { "metaData": "1", "metaKey": "price" } ], "recordSetComplete": "true", "recordSetCount": "1", "recordSetStartNumber": "0", "recordSetTotal": "1", "resourceId": "http:\/\/localhost:80\/wcs\/resources\/store\/10001\/categoryview\/Apparel", "resourceName": "categoryview" }
Gets all top level categories.
findTopCategories
false
true
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
catalogId | The catalog identifier. If none is specified, the store default catalog shall be used. | query | string | false | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
404 | The specified resource couldn't be found. |
500 | Internal server error. Additional details will be contained on the server logs. |
Gets category details based on its unique ID.
findCategoryByUniqueId
false
true
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
categoryId | Category ID. | path | string | true | N/A |
catalogId | The catalog identifier. If none is specified, the store default catalog shall be used. | query | string | false | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
404 | The specified resource couldn't be found. |
500 | Internal server error. Additional details will be contained on the server logs. |
Gets child categories based on the parent category unique ID.
findSubCategories
false
true
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
parentCategoryId | The parent category unique ID. | path | string | true | N/A |
pageNumber | Page number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work. | query | integer | false | false |
pageSize | Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The "pageNumber" must be specified for paging to work. | query | integer | false | false |
catalogId | The catalog identifier. If none is specified, the store default catalog shall be used. | query | string | false | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
201 | The requested resource has been created. |
204 | The requested completed successfully. No content is returned in the response. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
404 | The specified resource couldn't be found. |
500 | Internal server error. Additional details will be contained on the server logs. |
GET /wcs/resources/store/10001/categoryview/byParentCategory/10001
200
{ "CatalogGroupView": [ { "identifier": "Girls", "name": "Girls", "parentCatalogGroupID": [ "10001" ], "productsURL": "https:\/\/localhost:443\/wcs\/resources\/store\/10001\/productview\/byCategory\/10005", "resourceId": "https:\/\/localhost:443\/wcs\/resources\/store\/10001\/categoryview\/byId\/10005", "shortDescription": "Girls", "thumbnail": "images\/catalog\/apparel\/girls\/category\/catr_app_girls.png", "uniqueID": "10005" }, { "identifier": "Boys", "name": "Boys", "parentCatalogGroupID": [ "10001" ], "productsURL": "https:\/\/localhost:443\/wcs\/resources\/store\/10001\/productview\/byCategory\/10004", "resourceId": "https:\/\/localhost:443\/wcs\/resources\/store\/10001\/categoryview\/byId\/10004", "shortDescription": "boys", "thumbnail": "images\/catalog\/apparel\/boys\/category\/catr_app_boys.png", "uniqueID": "10004" }, { "identifier": "Women", "name": "Women", "parentCatalogGroupID": [ "10001" ], "productsURL": "https:\/\/localhost:443\/wcs\/resources\/store\/10001\/productview\/byCategory\/10003", "resourceId": "https:\/\/localhost:443\/wcs\/resources\/store\/10001\/categoryview\/byId\/10003", "shortDescription": "Women", "thumbnail": "images\/catalog\/apparel\/women\/category\/catr_app_women.png", "uniqueID": "10003" }, { "identifier": "Men", "name": "Men", "parentCatalogGroupID": [ "10001" ], "productsURL": "https:\/\/localhost:443\/wcs\/resources\/store\/10001\/productview\/byCategory\/10002", "resourceId": "https:\/\/localhost:443\/wcs\/resources\/store\/10001\/categoryview\/byId\/10002", "shortDescription": "Men", "thumbnail": "images\/catalog\/apparel\/men\/category\/catr_app_men.png", "uniqueID": "10002" } ], "MetaData": [ { "metaData": "1", "metaKey": "price" } ], "recordSetComplete": "true", "recordSetCount": "4", "recordSetStartNumber": "0", "recordSetTotal": "4", "resourceId": "https:\/\/localhost:443\/wcs\/resources\/store\/10001\/categoryview\/byParentCategory\/10001", "resourceName": "categoryview" }
Name | Data Type | Required |
---|---|---|
indexStatus | string | false |
userDataField | categoryview-categoryDetails.userDataField array | false |
SuggestionView | categoryview-categoryDetails.SuggestionView array | false |
WebContentView | categoryview-categoryDetails.WebContentView array | false |
recordSetComplete | string | false |
CatalogGroupView | categoryview-categoryDetails.CatalogGroupView array | false |
MetaData | categoryview-categoryDetails.MetaData array | false |
finalQuery | string | false |
recordSetTotal | string | false |
BreadCrumbTrailEntryView | categoryview-categoryDetails.BreadCrumbTrailEntryView array | false |
report | string array | false |
recordSetStartNumber | string | false |
FacetView | categoryview-categoryDetails.FacetView array | false |
recordSetCount | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
label | string | false |
type | string | false |
Name | Data Type | Required |
---|---|---|
longDescription | string | false |
shortDescription | string | false |
metaKeyword | string | false |
userDataField | categoryview-categoryDetails.CatalogGroupView.userDataField array | false |
identifier | string | false |
parentCatalogGroupID | string array | false |
name | string | false |
thumbnail | string | false |
fullImage | string | false |
uniqueID | string | false |
MetaData | categoryview-categoryDetails.CatalogGroupView.MetaData array | false |
fullPath | string | false |
metaDescription | string | false |
title | string | false |
fullImageAltDescription | string | false |
Name | Data Type | Required |
---|---|---|
metaKey | string | true |
metaData | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
value | string | false |
Entry | categoryview-categoryDetails.FacetView.Entry array | false |
name | string | false |
Name | Data Type | Required |
---|---|---|
label | string | false |
image | string | false |
count | string | false |
entryValue | string | false |
Name | Data Type | Required |
---|---|---|
metaKey | string | true |
metaData | string | false |
Name | Data Type | Required |
---|---|---|
Entry | categoryview-categoryDetails.SuggestionView.Entry array | false |
label | string | false |
identifier | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
userDataField | categoryview-categoryDetails.SuggestionView.Entry.userDataField array | false |
image | string | false |
name | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
userDataField | categoryview-categoryDetails.WebContentView.userDataField array | false |
name | string | false |
uniqueID | string | false |
URL | string | true |
MetaData | categoryview-categoryDetails.WebContentView.MetaData array | false |
Name | Data Type | Required |
---|---|---|
metaData | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
indexStatus | string | false |
userDataField | categoryview-categorySummary.userDataField array | false |
SuggestionView | categoryview-categorySummary.SuggestionView array | false |
WebContentView | categoryview-categorySummary.WebContentView array | false |
recordSetComplete | string | false |
CatalogGroupView | categoryview-categorySummary.CatalogGroupView array | false |
MetaData | categoryview-categorySummary.MetaData array | false |
finalQuery | string | false |
recordSetTotal | string | false |
BreadCrumbTrailEntryView | categoryview-categorySummary.BreadCrumbTrailEntryView array | false |
report | string array | false |
recordSetStartNumber | string | false |
FacetView | categoryview-categorySummary.FacetView array | false |
recordSetCount | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
label | string | false |
type | string | false |
Name | Data Type | Required |
---|---|---|
shortDescription | string | false |
identifier | string | false |
name | string | false |
parentCatalogGroupID | string array | false |
thumbnail | string | false |
uniqueID | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
Entry | categoryview-categorySummary.FacetView.Entry array | false |
name | string | false |
Name | Data Type | Required |
---|---|---|
label | string | false |
image | string | false |
count | string | false |
entryValue | string | false |
Name | Data Type | Required |
---|---|---|
metaKey | string | true |
metaData | string | false |
Name | Data Type | Required |
---|---|---|
Entry | categoryview-categorySummary.SuggestionView.Entry array | false |
label | string | false |
identifier | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
userDataField | categoryview-categorySummary.SuggestionView.Entry.userDataField array | false |
name | string | false |
image | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
userDataField | categoryview-categorySummary.WebContentView.userDataField array | false |
name | string | false |
uniqueID | string | false |
URL | string | true |
MetaData | categoryview-categorySummary.WebContentView.MetaData array | false |
Name | Data Type | Required |
---|---|---|
metaData | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |