search_category

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.

Handler Class:

com.ibm.commerce.rest.search.handler.v2_0.CategoryViewHandler

Method Summary

HTTP Method	Path	Description
GET	/store/{storeId}/categoryview/{categoryIdentifier}	Gets category details based on its identifier (not the id assigned by the database).
GET	/store/{storeId}/categoryview/@top	Gets all top level categories.
GET	/store/{storeId}/categoryview/byId/{categoryId}	Gets category details based on its unique ID assigned by the database.
GET	/store/{storeId}/categoryview/byIds	Gets category details based on its unique ID.
GET	/store/{storeId}/categoryview/byParentCategory/{parentCategoryId}	Gets child categories based on the parent category unique ID.

Method Details

GET /store/{storeId}/categoryview/{categoryIdentifier}

Gets category details based on its identifier (not the id assigned by the database).

Handler Method:

findCategoryByIdentifier

Secure Call Mandatory:

false

Partial Authentication Allowed:

true

Parameters:

Name	Description	Parameter Type	Data Type	Required	Allow Multiple
storeId	The store identifier.	path	string	true	N/A
categoryIdentifier	The category identifier that was configured, not the one assigned by the database.	path	string	true	N/A
catalogId	The catalog identifier. If none is specified, the store default catalog shall be used.	query	string	false	false
checkEntitlement	Option to force an entitlement check.	query	boolean	false	false

HTTP Status Codes:

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.

Response Data Type:

CategoryViewHandler/categoryresult.json

Example

Request:

 /search/resources/store/10001/categoryview/Dresses

HTTP Status Code:

200

Response:

{
	"catalogGroupView": [
		{
			"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/category\/catr_wcl_dresses.png",
			"identifier": "Dresses",
			"name": "Dresses",
			"parentCatalogGroupID": [
				"10001_10003",
				"10052_10003"
			],
			"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10006",
			"shortDescription": "Dresses",
			"storeID": "10001",
			"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/category\/catr_wcl_dresses.png",
			"uniqueID": "10006"
		}
	],
	"recordSetComplete": "true",
	"recordSetCount": 1,
	"recordSetStartNumber": 0,
	"recordSetTotal": 1,
	"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/Dresses",
	"resourceName": "categoryview"
}

GET /store/{storeId}/categoryview/@top

Gets all top level categories.

Handler Method:

findTopCategories

Secure Call Mandatory:

false

Partial Authentication Allowed:

true

Parameters:

Name	Description	Parameter Type	Data Type	Required	Allow Multiple
storeId	The store identifier.	path	string	true	N/A
depthAndLimit	The comma separated list of numbers is to control the depth of sub-categories and limit the number of items returned under each child category level. The first number in this list determines the maximum of categories (first level sub-categories) to be returned under the immediate child category. The second number in the list determines the maximum number of categories to be returned under the first level sub-categories. A value of "-1" implies no limit. In that case, only the first level categories will be returned. For example, "pageSize=4&depthAndLimit=-1,3,0,1" implies that there will be unlimited first level sub-categories under the immediate child categories. Under these categories (up to 4), all sub-categories will be returned and a maximum of 3 second level sub-categories will be returned. There will be no third level or fourth level since the third level limit is 0. Any level after a limit of 0 will be ignored. By default, no sub-category will be returned if this parameter is not specified. When the asterisk "*" is specified, it is considered the same as "-1" but, any subsequent levels will also be treated "-1".	query	string	false	false
orderBy	The field name to use when ordering the results.	query	string	false	false
catalogId	The catalog identifier. If none is specified, the store default catalog shall be used.	query	string	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	string	false	false
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	string	false	false
checkEntitlement	Option to force an entitlement check.	query	boolean	false	false

HTTP Status Codes:

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.

Response Data Type:

CategoryViewHandler/topcategories.json

Example

Request:

 /search/resources/store/10001/categoryview/@top?catalogId=10052&depthAndLimit=11%2C11&responseFormat=json&langId=-1&contractId=10001

HTTP Status Code:

200

Response:

{
	"catalogGroupView": [
		{
			"catalogGroupView": [
				{
					"catalogGroupView": [
						{
							"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/girls\/category\/catr_gsh_shoes.png",
							"identifier": "Girls Shoes",
							"name": "Shoes",
							"parentCatalogGroupID": [
								"10001_10005",
								"10052_10005"
							],
							"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10020",
							"shortDescription": "Shoes",
							"storeID": "10001",
							"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/girls\/category\/catr_gsh_shoes.png",
							"uniqueID": "10020"
						},
						{
							"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/girls\/category\/catr_gcl_pants.png",
							"identifier": "Girls Pants",
							"name": "Pants",
							"parentCatalogGroupID": [
								"10001_10005",
								"10052_10005"
							],
							"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10021",
							"shortDescription": "Pants",
							"storeID": "10001",
							"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/girls\/category\/catr_gcl_pants.png",
							"uniqueID": "10021"
						},
						{
							"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/girls\/category\/catr_gcl_skirts.png",
							"identifier": "Girls Dresses Skirts",
							"name": "Skirts",
							"parentCatalogGroupID": [
								"10001_10005",
								"10052_10005"
							],
							"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10022",
							"shortDescription": "Skirts",
							"storeID": "10001",
							"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/girls\/category\/catr_gcl_skirts.png",
							"uniqueID": "10022"
						},
						{
							"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/girls\/category\/catr_gcl_tops.png",
							"identifier": "Girls Tops",
							"name": "Tops",
							"parentCatalogGroupID": [
								"10001_10005",
								"10052_10005"
							],
							"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10023",
							"shortDescription": "Tops",
							"storeID": "10001",
							"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/girls\/category\/catr_gcl_tops.png",
							"uniqueID": "10023"
						}
					],
					"childCatalogGroupID": [
						"10001_10020",
						"10001_10021",
						"10001_10022",
						"10001_10023",
						"10052_10020",
						"10052_10021",
						"10052_10022",
						"10052_10023"
					],
					"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/girls\/category\/catr_app_girls.png",
					"identifier": "Girls",
					"name": "Girls",
					"parentCatalogGroupID": [
						"10001_10001",
						"10052_10001"
					],
					"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10005",
					"shortDescription": "Girls",
					"storeID": "10001",
					"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/girls\/category\/catr_app_girls.png",
					"uniqueID": "10005"
				},
				{
					"catalogGroupView": [
						{
							"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/boys\/category\/catr_bcl_pants.png",
							"identifier": "Boys Pants",
							"name": "Pants",
							"parentCatalogGroupID": [
								"10001_10004",
								"10052_10004"
							],
							"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10024",
							"shortDescription": "Pants",
							"storeID": "10001",
							"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/boys\/category\/catr_bcl_pants.png",
							"uniqueID": "10024"
						},
						{
							"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/boys\/category\/catr_bcl_tops.png",
							"identifier": "Boys Tops",
							"name": "Tops",
							"parentCatalogGroupID": [
								"10001_10004",
								"10052_10004"
							],
							"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10025",
							"shortDescription": "Tops",
							"storeID": "10001",
							"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/boys\/category\/catr_bcl_tops.png",
							"uniqueID": "10025"
						},
						{
							"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/boys\/category\/catr_bsh_shoes.png",
							"identifier": "Boys Shoes",
							"name": "Shoes",
							"parentCatalogGroupID": [
								"10001_10004",
								"10052_10004"
							],
							"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10026",
							"shortDescription": "Shoes",
							"storeID": "10001",
							"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/boys\/category\/catr_bsh_shoes.png",
							"uniqueID": "10026"
						}
					],
					"childCatalogGroupID": [
						"10001_10024",
						"10001_10025",
						"10001_10026",
						"10052_10024",
						"10052_10025",
						"10052_10026"
					],
					"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/boys\/category\/catr_app_boys.png",
					"identifier": "Boys",
					"name": "Boys",
					"parentCatalogGroupID": [
						"10001_10001",
						"10052_10001"
					],
					"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10004",
					"shortDescription": "boys",
					"storeID": "10001",
					"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/boys\/category\/catr_app_boys.png",
					"uniqueID": "10004"
				},
				{
					"catalogGroupView": [
						{
							"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/category\/catr_wcl_dresses.png",
							"identifier": "Dresses",
							"name": "Dresses",
							"parentCatalogGroupID": [
								"10001_10003",
								"10052_10003"
							],
							"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10006",
							"shortDescription": "Dresses",
							"storeID": "10001",
							"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/category\/catr_wcl_dresses.png",
							"uniqueID": "10006"
						},
						{
							"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/category\/catr_wcl_blouses.png",
							"identifier": "Women Shirts Blouses",
							"name": "Blouses",
							"parentCatalogGroupID": [
								"10001_10003",
								"10052_10003"
							],
							"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10007",
							"shortDescription": "Blouses",
							"storeID": "10001",
							"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/category\/catr_wcl_blouses.png",
							"uniqueID": "10007"
						},
						{
							"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/category\/catr_wcl_sweaters.png",
							"identifier": "Women Sweaters",
							"name": "Sweaters",
							"parentCatalogGroupID": [
								"10001_10003",
								"10052_10003"
							],
							"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10008",
							"shortDescription": "Sweaters",
							"storeID": "10001",
							"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/category\/catr_wcl_sweaters.png",
							"uniqueID": "10008"
						},
						{
							"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/category\/catr_wcl_skirts.png",
							"identifier": "Women Skirts",
							"name": "Skirts",
							"parentCatalogGroupID": [
								"10001_10003",
								"10052_10003"
							],
							"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10009",
							"shortDescription": "Skirts",
							"storeID": "10001",
							"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/category\/catr_wcl_skirts.png",
							"uniqueID": "10009"
						},
						{
							"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/category\/catr_wcl_pants.png",
							"identifier": "Women Pants",
							"name": "Pants",
							"parentCatalogGroupID": [
								"10001_10003",
								"10052_10003"
							],
							"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10010",
							"shortDescription": "Pants",
							"storeID": "10001",
							"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/category\/catr_wcl_pants.png",
							"uniqueID": "10010"
						},
						{
							"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/category\/catr_wsh_shoes.png",
							"identifier": "Women Shoes",
							"name": "Shoes",
							"parentCatalogGroupID": [
								"10001_10003",
								"10052_10003"
							],
							"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10011",
							"shortDescription": "Shoes",
							"storeID": "10001",
							"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/category\/catr_wsh_shoes.png",
							"uniqueID": "10011"
						},
						{
							"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/category\/catr_wbg_handbags.png",
							"identifier": "Women Handbags",
							"name": "Handbags",
							"parentCatalogGroupID": [
								"10001_10003",
								"10052_10003"
							],
							"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10012",
							"shortDescription": "Handbags",
							"storeID": "10001",
							"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/category\/catr_wbg_handbags.png",
							"uniqueID": "10012"
						},
						{
							"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/category\/catr_wac_accessories.png",
							"identifier": "Women Accessories",
							"name": "Accessories",
							"parentCatalogGroupID": [
								"10001_10003",
								"10052_10003"
							],
							"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10013",
							"shortDescription": "Accessories",
							"storeID": "10001",
							"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/category\/catr_wac_accessories.png",
							"uniqueID": "10013"
						}
					],
					"childCatalogGroupID": [
						"10001_10006",
						"10001_10007",
						"10001_10008",
						"10001_10009",
						"10001_10010",
						"10001_10011",
						"10001_10012",
						"10001_10013",
						"10052_10006",
						"10052_10007",
						"10052_10008",
						"10052_10009",
						"10052_10010",
						"10052_10011",
						"10052_10012",
						"10052_10013"
					],
					"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/category\/catr_app_women.png",
					"identifier": "Women",
					"name": "Women",
					"parentCatalogGroupID": [
						"10001_10001",
						"10052_10001"
					],
					"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10003",
					"shortDescription": "Women",
					"storeID": "10001",
					"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/category\/catr_app_women.png",
					"uniqueID": "10003"
				},
				{
					"catalogGroupView": [
						{
							"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/men\/category\/catr_mcl_jackets.png",
							"identifier": "Men Jackets",
							"name": "Jackets",
							"parentCatalogGroupID": [
								"10001_10002",
								"10052_10002"
							],
							"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10014",
							"shortDescription": "Jackets",
							"storeID": "10001",
							"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/men\/category\/catr_mcl_jackets.png",
							"uniqueID": "10014"
						},
						{
							"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/men\/category\/catr_mcl_shirts.png",
							"identifier": "Men Shirts",
							"name": "Shirts",
							"parentCatalogGroupID": [
								"10001_10002",
								"10052_10002"
							],
							"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10015",
							"shortDescription": "Shirts",
							"storeID": "10001",
							"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/men\/category\/catr_mcl_shirts.png",
							"uniqueID": "10015"
						},
						{
							"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/men\/category\/catr_mcl_suits.png",
							"identifier": "Men Suits",
							"name": "Suits",
							"parentCatalogGroupID": [
								"10001_10002",
								"10052_10002"
							],
							"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10016",
							"shortDescription": "Suits",
							"storeID": "10001",
							"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/men\/category\/catr_mcl_suits.png",
							"uniqueID": "10016"
						},
						{
							"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/men\/category\/catr_mcl_pants.png",
							"identifier": "Men Pants",
							"name": "Pants",
							"parentCatalogGroupID": [
								"10001_10002",
								"10052_10002"
							],
							"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10017",
							"shortDescription": "Pants",
							"storeID": "10001",
							"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/men\/category\/catr_mcl_pants.png",
							"uniqueID": "10017"
						},
						{
							"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/men\/category\/catr_mac_accessories.png",
							"identifier": "Men Accessories",
							"name": "Accessories",
							"parentCatalogGroupID": [
								"10001_10002",
								"10052_10002"
							],
							"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10018",
							"shortDescription": "Accessories",
							"storeID": "10001",
							"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/men\/category\/catr_mac_accessories.png",
							"uniqueID": "10018"
						},
						{
							"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/men\/category\/catr_msh_shoes.png",
							"identifier": "Men Shoes",
							"name": "Shoes",
							"parentCatalogGroupID": [
								"10001_10002",
								"10052_10002"
							],
							"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10019",
							"shortDescription": "Shoes",
							"storeID": "10001",
							"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/men\/category\/catr_msh_shoes.png",
							"uniqueID": "10019"
						}
					],
					"childCatalogGroupID": [
						"10001_10014",
						"10001_10015",
						"10001_10016",
						"10001_10017",
						"10001_10018",
						"10001_10019",
						"10052_10014",
						"10052_10015",
						"10052_10016",
						"10052_10017",
						"10052_10018",
						"10052_10019"
					],
					"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/men\/category\/catr_app_men.png",
					"identifier": "Men",
					"name": "Men",
					"parentCatalogGroupID": [
						"10001_10001",
						"10052_10001"
					],
					"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10002",
					"shortDescription": "Men",
					"storeID": "10001",
					"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/men\/category\/catr_app_men.png",
					"uniqueID": "10002"
				}
			],
			"childCatalogGroupID": [
				"10001_10005",
				"10001_10004",
				"10001_10003",
				"10001_10002",
				"10052_10005",
				"10052_10004",
				"10052_10003",
				"10052_10002"
			],
			"identifier": "Apparel",
			"name": "Apparel",
			"parentCatalogGroupID": [
				"10001_-1",
				"10052_-1"
			],
			"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10001",
			"shortDescription": "The latest styles for the entire family.",
			"storeID": "10001",
			"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/category\/catr_wcl_pants.png",
			"uniqueID": "10001"
		},
		{
			"catalogGroupView": [
				{
					"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/electronics\/category\/catr_cac_accessories.png",
					"identifier": "Computers Accessories",
					"name": "Accessories",
					"parentCatalogGroupID": [
						"10001_10027",
						"10052_10027"
					],
					"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10028",
					"shortDescription": "Accessories",
					"storeID": "10001",
					"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/electronics\/category\/catr_cac_accessories.png",
					"uniqueID": "10028"
				},
				{
					"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/electronics\/category\/catr_cta_tablets.png",
					"identifier": "Computers Tablets",
					"name": "Tablets",
					"parentCatalogGroupID": [
						"10001_10027",
						"10052_10027"
					],
					"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10029",
					"shortDescription": "Tablets",
					"storeID": "10001",
					"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/electronics\/category\/catr_cta_tablets.png",
					"uniqueID": "10029"
				},
				{
					"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/electronics\/category\/catr_cla_laptops.png",
					"identifier": "Computers Laptops",
					"name": "Laptops",
					"parentCatalogGroupID": [
						"10001_10027",
						"10052_10027"
					],
					"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10030",
					"shortDescription": "Laptops",
					"storeID": "10001",
					"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/electronics\/category\/catr_cla_laptops.png",
					"uniqueID": "10030"
				},
				{
					"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/electronics\/category\/catr_cde_desktops.png",
					"identifier": "Computers Desktops",
					"name": "Desktops",
					"parentCatalogGroupID": [
						"10001_10027",
						"10052_10027"
					],
					"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10031",
					"shortDescription": "Desktops",
					"storeID": "10001",
					"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/electronics\/category\/catr_cde_desktops.png",
					"uniqueID": "10031"
				},
				{
					"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/electronics\/category\/catr_ccm_components.png",
					"identifier": "Computers Components",
					"name": "Components",
					"parentCatalogGroupID": [
						"10001_10027",
						"10052_10027"
					],
					"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10032",
					"shortDescription": "Components",
					"storeID": "10001",
					"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/electronics\/category\/catr_ccm_components.png",
					"uniqueID": "10032"
				}
			],
			"childCatalogGroupID": [
				"10001_10028",
				"10001_10029",
				"10001_10030",
				"10001_10031",
				"10001_10032",
				"10052_10028",
				"10052_10029",
				"10052_10030",
				"10052_10031",
				"10052_10032"
			],
			"identifier": "Electronics",
			"name": "Electronics",
			"parentCatalogGroupID": [
				"10001_-1",
				"10052_-1"
			],
			"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10027",
			"shortDescription": "Electronics",
			"storeID": "10001",
			"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/electronics\/category\/catr_cta_tablets.png",
			"uniqueID": "10027"
		},
		{
			"catalogGroupView": [
				{
					"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/grocery\/category\/catr_gda_dairy.png",
					"identifier": "Dairy",
					"name": "Dairy",
					"parentCatalogGroupID": [
						"10001_10033",
						"10052_10033"
					],
					"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10034",
					"shortDescription": "Dairy",
					"storeID": "10001",
					"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/grocery\/category\/catr_gda_dairy.png",
					"uniqueID": "10034"
				},
				{
					"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/grocery\/category\/catr_gfr_fruit.png",
					"identifier": "Fruit",
					"name": "Fruit",
					"parentCatalogGroupID": [
						"10001_10033",
						"10052_10033"
					],
					"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10035",
					"shortDescription": "Fruit",
					"storeID": "10001",
					"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/grocery\/category\/catr_gfr_fruit.png",
					"uniqueID": "10035"
				},
				{
					"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/grocery\/category\/catr_gme_meat.png",
					"identifier": "Meat",
					"name": "Meat",
					"parentCatalogGroupID": [
						"10001_10033",
						"10052_10033"
					],
					"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10036",
					"shortDescription": "Meat",
					"storeID": "10001",
					"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/grocery\/category\/catr_gme_meat.png",
					"uniqueID": "10036"
				},
				{
					"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/grocery\/category\/catr_gve_vegetables.png",
					"identifier": "Vegetables",
					"name": "Vegetables",
					"parentCatalogGroupID": [
						"10001_10033",
						"10052_10033"
					],
					"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10037",
					"shortDescription": "Vegetables",
					"storeID": "10001",
					"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/grocery\/category\/catr_gve_vegetables.png",
					"uniqueID": "10037"
				}
			],
			"childCatalogGroupID": [
				"10001_10034",
				"10001_10035",
				"10001_10036",
				"10001_10037",
				"10052_10034",
				"10052_10035",
				"10052_10036",
				"10052_10037"
			],
			"identifier": "Grocery",
			"name": "Grocery",
			"parentCatalogGroupID": [
				"10001_-1",
				"10052_-1"
			],
			"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10033",
			"shortDescription": "Grocery",
			"storeID": "10001",
			"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/grocery\/category\/catr_gda_dairy.png",
			"uniqueID": "10033"
		},
		{
			"catalogGroupView": [
				{
					"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/health\/category\/catr_hme_medicine.png",
					"identifier": "Medicine",
					"name": "Medicine",
					"parentCatalogGroupID": [
						"10001_10038",
						"10052_10038"
					],
					"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10039",
					"shortDescription": "Medicine",
					"storeID": "10001",
					"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/health\/category\/catr_hme_medicine.png",
					"uniqueID": "10039"
				},
				{
					"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/health\/category\/catr_hvt_vitamins.png",
					"identifier": "Vitamins",
					"name": "Vitamins",
					"parentCatalogGroupID": [
						"10001_10038",
						"10052_10038"
					],
					"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10040",
					"shortDescription": "Vitamins",
					"storeID": "10001",
					"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/health\/category\/catr_hvt_vitamins.png",
					"uniqueID": "10040"
				}
			],
			"childCatalogGroupID": [
				"10001_10039",
				"10001_10040",
				"10052_10039",
				"10052_10040"
			],
			"identifier": "Health",
			"name": "Health",
			"parentCatalogGroupID": [
				"10001_-1",
				"10052_-1"
			],
			"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10038",
			"shortDescription": "Health",
			"storeID": "10001",
			"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/health\/category\/catr_hme_medicine.png",
			"uniqueID": "10038"
		},
		{
			"catalogGroupView": [
				{
					"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/category\/catr_hba_bath.png",
					"identifier": "Bath Accessories",
					"name": "Bath Accessories",
					"parentCatalogGroupID": [
						"10001_10041",
						"10052_10041"
					],
					"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10042",
					"shortDescription": "Bath Accessories",
					"storeID": "10001",
					"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/category\/catr_hba_bath.png",
					"uniqueID": "10042"
				},
				{
					"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/category\/catr_hfu_furniture.png",
					"identifier": "Furniture",
					"name": "Furniture",
					"parentCatalogGroupID": [
						"10001_10041",
						"10052_10041"
					],
					"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10043",
					"shortDescription": "Furniture",
					"storeID": "10001",
					"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/category\/catr_hfu_furniture.png",
					"uniqueID": "10043"
				},
				{
					"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/category\/catr_hkt_kitchenware.png",
					"identifier": "Kitchenware",
					"name": "Kitchenware",
					"parentCatalogGroupID": [
						"10001_10041",
						"10052_10041"
					],
					"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10044",
					"shortDescription": "Kitchenware",
					"storeID": "10001",
					"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/category\/catr_hkt_kitchenware.png",
					"uniqueID": "10044"
				},
				{
					"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/category\/catr_hlg_lighting.png",
					"identifier": "Lighting",
					"name": "Lighting",
					"parentCatalogGroupID": [
						"10001_10041",
						"10052_10041"
					],
					"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10045",
					"shortDescription": "Lighting",
					"storeID": "10001",
					"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/category\/catr_hlg_lighting.png",
					"uniqueID": "10045"
				},
				{
					"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/category\/catr_hta_tableware.png",
					"identifier": "Tableware",
					"name": "Tableware",
					"parentCatalogGroupID": [
						"10001_10041",
						"10052_10041"
					],
					"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10046",
					"shortDescription": "Tableware",
					"storeID": "10001",
					"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/category\/catr_hta_tableware.png",
					"uniqueID": "10046"
				},
				{
					"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/category\/catr_hap_appliances.png",
					"identifier": "Appliances",
					"name": "Appliances",
					"parentCatalogGroupID": [
						"10001_10041",
						"10052_10041"
					],
					"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10047",
					"shortDescription": "Appliances",
					"storeID": "10001",
					"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/category\/catr_hap_appliances.png",
					"uniqueID": "10047"
				}
			],
			"childCatalogGroupID": [
				"10001_10042",
				"10001_10043",
				"10001_10044",
				"10001_10045",
				"10001_10046",
				"10001_10047",
				"10052_10042",
				"10052_10043",
				"10052_10044",
				"10052_10045",
				"10052_10046",
				"10052_10047"
			],
			"identifier": "Home Furnishings",
			"name": "Home & Furnishing",
			"parentCatalogGroupID": [
				"10001_-1",
				"10052_-1"
			],
			"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10041",
			"shortDescription": "Home & Furnishing",
			"storeID": "10001",
			"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/category\/catr_hap_appliances.png",
			"uniqueID": "10041"
		},
		{
			"catalogGroupView": [
				{
					"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/newslettersmagazines\/category\/catr_nma_magazines.png",
					"identifier": "Magazines",
					"name": "Magazines",
					"parentCatalogGroupID": [
						"10001_10048",
						"10052_10048"
					],
					"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10049",
					"shortDescription": "Magazines",
					"storeID": "10001",
					"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/newslettersmagazines\/category\/catr_nma_magazines.png",
					"uniqueID": "10049"
				},
				{
					"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/newslettersmagazines\/category\/catr_nne_newsletters.png",
					"identifier": "Newsletters",
					"name": "Newsletters",
					"parentCatalogGroupID": [
						"10001_10048",
						"10052_10048"
					],
					"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10050",
					"shortDescription": "Newsletters",
					"storeID": "10001",
					"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/newslettersmagazines\/category\/catr_nne_newsletters.png",
					"uniqueID": "10050"
				}
			],
			"childCatalogGroupID": [
				"10001_10049",
				"10001_10050",
				"10052_10049",
				"10052_10050"
			],
			"identifier": "NewslettersAndMagazines",
			"name": "Newsletters & Magazines",
			"parentCatalogGroupID": [
				"10001_-1",
				"10052_-1"
			],
			"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10048",
			"shortDescription": "Newsletters & Magazines",
			"storeID": "10001",
			"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/newslettersmagazines\/category\/catr_nma_magazines.png",
			"uniqueID": "10048"
		}
	],
	"recordSetComplete": "true",
	"recordSetCount": 50,
	"recordSetStartNumber": 0,
	"recordSetTotal": 50,
	"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/@top?catalogId=10052&depthAndLimit=11%2C11&responseFormat=json&langId=-1&contractId=10001",
	"resourceName": "categoryview"
}

GET /store/{storeId}/categoryview/byId/{categoryId}

Gets category details based on its unique ID assigned by the database.

Handler Method:

findCategoryByUniqueId

Secure Call Mandatory:

false

Partial Authentication Allowed:

true

Parameters:

Name	Description	Parameter Type	Data Type	Required	Allow Multiple
storeId	The store identifier.	path	string	true	N/A
categoryId	The category identifier that was assigned by the database.	path	string	true	N/A
catalogId	The catalog identifier. If none is specified, the store default catalog shall be used.	query	string	false	false
checkEntitlement	Option to force an entitlement check.	query	boolean	false	false

HTTP Status Codes:

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.

Response Data Type:

CategoryViewHandler/categoryresult.json

Example

Request:

 /search/resources/store/10001/categoryview/byId/10043?currency=USD&catalogId=10052&responseFormat=json&langId=-1&contractId=10001

HTTP Status Code:

200

Response:

{
	"catalogGroupView": [
		{
			"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/category\/catr_hfu_furniture.png",
			"identifier": "Furniture",
			"name": "Furniture",
			"parentCatalogGroupID": [
				"10001_10041",
				"10052_10041"
			],
			"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10043",
			"shortDescription": "Furniture",
			"storeID": "10001",
			"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/category\/catr_hfu_furniture.png",
			"uniqueID": "10043"
		}
	],
	"recordSetComplete": "true",
	"recordSetCount": 1,
	"recordSetStartNumber": 0,
	"recordSetTotal": 1,
	"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10043?currency=USD&catalogId=10052&responseFormat=json&langId=-1&contractId=10001",
	"resourceName": "categoryview"
}

GET /store/{storeId}/categoryview/byIds

Gets category details based on its unique ID.

Handler Method:

findCategoryByUniqueIds

Secure Call Mandatory:

false

Partial Authentication Allowed:

true

Parameters:

Name	Description	Parameter Type	Data Type	Required	Allow Multiple
storeId	The store identifier.	path	string	true	N/A
id	The list of category identifier.	query	string	false	true
catalogId	The catalog identifier. If none is specified, the store default catalog shall be used.	query	string	false	false
orderBy	The field name to use when ordering the results.	query	string	false	false
checkEntitlement	Option to force an entitlement check.	query	boolean	false	false

HTTP Status Codes:

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.

Response Data Type:

CategoryViewHandler/categoriesresult.json

Example

Request:

 /search/resources/store/10001/categoryview/byIds?currency=USD&catalogId=10052&responseFormat=json&langId=-1&id=10007&id=10013&id=10016&id=10022&id=10025&contractId=10001

HTTP Status Code:

200

Response:

{
	"catalogGroupView": [
		{
			"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/category\/catr_wcl_blouses.png",
			"identifier": "Women Shirts Blouses",
			"name": "Blouses",
			"parentCatalogGroupID": [
				"10001_10003",
				"10052_10003"
			],
			"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10007",
			"shortDescription": "Blouses",
			"storeID": "10001",
			"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/category\/catr_wcl_blouses.png",
			"uniqueID": "10007"
		},
		{
			"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/category\/catr_wac_accessories.png",
			"identifier": "Women Accessories",
			"name": "Accessories",
			"parentCatalogGroupID": [
				"10001_10003",
				"10052_10003"
			],
			"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10013",
			"shortDescription": "Accessories",
			"storeID": "10001",
			"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/category\/catr_wac_accessories.png",
			"uniqueID": "10013"
		},
		{
			"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/men\/category\/catr_mcl_suits.png",
			"identifier": "Men Suits",
			"name": "Suits",
			"parentCatalogGroupID": [
				"10001_10002",
				"10052_10002"
			],
			"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10016",
			"shortDescription": "Suits",
			"storeID": "10001",
			"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/men\/category\/catr_mcl_suits.png",
			"uniqueID": "10016"
		},
		{
			"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/girls\/category\/catr_gcl_skirts.png",
			"identifier": "Girls Dresses Skirts",
			"name": "Skirts",
			"parentCatalogGroupID": [
				"10001_10005",
				"10052_10005"
			],
			"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10022",
			"shortDescription": "Skirts",
			"storeID": "10001",
			"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/girls\/category\/catr_gcl_skirts.png",
			"uniqueID": "10022"
		},
		{
			"fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/boys\/category\/catr_bcl_tops.png",
			"identifier": "Boys Tops",
			"name": "Tops",
			"parentCatalogGroupID": [
				"10001_10004",
				"10052_10004"
			],
			"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byId\/10025",
			"shortDescription": "Tops",
			"storeID": "10001",
			"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/boys\/category\/catr_bcl_tops.png",
			"uniqueID": "10025"
		}
	],
	"recordSetComplete": "true",
	"recordSetCount": 5,
	"recordSetStartNumber": 0,
	"recordSetTotal": 5,
	"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/categoryview\/byIds?currency=USD&catalogId=10052&responseFormat=json&langId=-1&id=10007&id=10013&id=10016&id=10022&id=10025&contractId=10001",
	"resourceName": "categoryview"
}

GET /store/{storeId}/categoryview/byParentCategory/{parentCategoryId}

Gets child categories based on the parent category unique ID.

Handler Method:

findSubCategories

Secure Call Mandatory:

false

Partial Authentication Allowed:

true

Parameters:

Name	Description	Parameter Type	Data Type	Required	Allow Multiple
storeId	The store identifier.	path	string	true	N/A
parentCategoryId	The parent category id.	path	string	true	N/A
depthAndLimit	The comma separated list of numbers is to control the depth of sub-categories and limit the number of items returned under each child category level. The first number in this list determines the maximum of categories (first level sub-categories) to be returned under the immediate child category. The second number in the list determines the maximum number of categories to be returned under the first level sub-categories. A value of "-1" implies no limit. In that case, only the first level categories will be returned. For example, "pageSize=4&limitSubCategories=-1,3,0,1" implies that there will be unlimited first level sub-categories under the immediate child categories. Under these categories (up to 4), all sub-categories will be returned and a maximum of 3 second level sub-categories will be returned. There will be no third level or fourth level since the third level limit is 0. Any level after a limit of 0 will be ignored. By default, no sub-category will be returned if this parameter is not specified. When the asterisk "*" is specified, it is considered the same as "-1" but, any subsequent levels will also be treated "-1".	query	string	false	false
orderBy	The field name to use when ordering the results.	query	string	false	false
catalogId	The catalog identifier. If none is specified, the store default catalog shall be used.	query	string	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	string	false	false
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	string	false	false
checkEntitlement	Option to force an entitlement check.	query	boolean	false	false

HTTP Status Codes:

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.

Response Data Type:

CategoryViewHandler/categoriesresult.json

Data Type Details

CategoryViewHandler/categoriesresult.json

Properties:

Name	Data Type	Required
recordSetTotal	string	false
resourceId	string	false
resourceName	string	false
recordSetComplete	string	false
recordSetStartNumber	string	false
catalogGroupView	CategoryViewHandler/categoriesresult.json.catalogGroupView array	false
recordSetCount	string	false
metaData	string	false

CategoryViewHandler/categoriesresult.json.catalogGroupView

Properties:

Name	Data Type	Required
shortDescription	string	false
identifier	string	false
resourceId	string	false
name	string	false
parentCatalogGroupID	string	false
productsURL	string	false
fullImage	string	false
storeID	string	false
thumbnail	string	false
uniqueID	string	false
childCatalogGroupID	string array	false

CategoryViewHandler/categoriesresult.json.metaData

Properties:

Name	Data Type	Required
price	string	false

CategoryViewHandler/categoryresult.json

Properties:

Name	Data Type	Required
recordSetTotal	string	false
resourceId	string	false
resourceName	string	false
recordSetComplete	string	false
recordSetStartNumber	string	false
catalogGroupView	CategoryViewHandler/categoryresult.json.catalogGroupView array	false
recordSetCount	string	false
metaData	string	false

CategoryViewHandler/categoryresult.json.catalogGroupView

Properties:

Name	Data Type	Required
shortDescription	string	false
identifier	string	false
resourceId	string	false
name	string	false
parentCatalogGroupID	string	false
productsURL	string	false
fullImage	string	false
storeID	string	false
thumbnail	string	false
uniqueID	string	false
childCatalogGroupID	string array	false

CategoryViewHandler/categoryresult.json.metaData

Properties:

Name	Data Type	Required
price	string	false

CategoryViewHandler/topcategories.json

Properties:

Name	Data Type	Required
recordSetTotal	string	false
resourceId	string	false
resourceName	string	false
recordSetComplete	string	false
recordSetStartNumber	string	false
catalogGroupView	CategoryViewHandler/topcategories.json.catalogGroupView array	false
recordSetCount	string	false
metaData	string	false

CategoryViewHandler/topcategories.json.catalogGroupView

Properties:

Name	Data Type	Required
shortDescription	string	false
identifier	string	false
resourceId	string	false
name	string	false
parentCatalogGroupID	string	false
productsURL	string	false
storeID	string	false
thumbnail	string	false
uniqueID	string	false
childCatalogGroupID	string array	false

CategoryViewHandler/topcategories.json.metaData

Properties:

Name	Data Type	Required
price	string	false