This class provides RESTful services to get resource details for site content.
com.ibm.commerce.rest.search.handler.v2_0.SiteContentHandler
| HTTP Method | Path | Description |
|---|---|---|
| GET | /store/{storeId}/sitecontent/brandSuggestions | Provides suggestions with type-ahead for search result page. |
| GET | /store/{storeId}/sitecontent/categorySuggestions | Provides suggestions with type-ahead for search result page. |
| GET | /store/{storeId}/sitecontent/keywordSuggestionsByTerm/{term} | Provides keyword suggestions with type-ahead for search result page based on a term. |
| GET | /store/{storeId}/sitecontent/productSuggestionsBySearchTerm/{searchTerm} | Provides suggestions with type-ahead for search result page. |
| GET | /store/{storeId}/sitecontent/suggestions | Provides suggestions with type-ahead for search result page. |
| GET | /store/{storeId}/sitecontent/webContentsBySearchTerm/{searchTerm} | Search unstructured content details for search result page based on a search term. |
| GET | /store/{storeId}/sitecontent/webContentSuggestions | Provides suggestions with type-ahead for search result page. |
Provides suggestions with type-ahead for search result page.
findBrandSuggestions
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| limit | Limit. | query | string | false | false |
| count | The number of suggested keywords to be returned. The default value is 4. | query | string | false | false |
| termsSort | The sorting to be used in the returned result, "count" or "index". By default, it is "count". | query | string | 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. |
| 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. |
/search/resources/store/10001/sitecontent/brandSuggestions
200
{
"DocumentList": [
],
"suggestionView": [
{
"entry": [
{
"count": "14",
"name": "Adelee Plus",
"value": "mfName_ntk_cs%3A%22Adelee+Plus%22"
},
{
"count": "471",
"name": "Albini",
"value": "mfName_ntk_cs%3A%22Albini%22"
},
{
"count": "2",
"name": "Alexander Home",
"value": "mfName_ntk_cs%3A%22Alexander+Home%22"
},
{
"count": "2",
"name": "All-In-One",
"value": "mfName_ntk_cs%3A%22All-In-One%22"
},
{
"count": "12",
"name": "Alumina",
"value": "mfName_ntk_cs%3A%22Alumina%22"
},
{
"count": "3",
"name": "Archaeo",
"value": "mfName_ntk_cs%3A%22Archaeo%22"
},
{
"count": "20",
"name": "AromaStar",
"value": "mfName_ntk_cs%3A%22AromaStar%22"
},
{
"count": "2",
"name": "Australia Lamb Co.",
"value": "mfName_ntk_cs%3A%22Australia+Lamb+Co.%22"
},
{
"count": "43",
"name": "Baril",
"value": "mfName_ntk_cs%3A%22Baril%22"
},
{
"count": "2",
"name": "Bender Home Fashions",
"value": "mfName_ntk_cs%3A%22Bender+Home+Fashions%22"
},
{
"count": "2",
"name": "Bluthe Potato Co.",
"value": "mfName_ntk_cs%3A%22Bluthe+Potato+Co.%22"
},
{
"count": "168",
"name": "Borsati",
"value": "mfName_ntk_cs%3A%22Borsati%22"
},
{
"count": "6",
"name": "Burleign",
"value": "mfName_ntk_cs%3A%22Burleign%22"
},
{
"count": "12",
"name": "California Sun",
"value": "mfName_ntk_cs%3A%22California+Sun%22"
},
{
"count": "6",
"name": "Captain Stewarts",
"value": "mfName_ntk_cs%3A%22Captain+Stewarts%22"
},
{
"count": "42",
"name": "Cassetti",
"value": "mfName_ntk_cs%3A%22Cassetti%22"
},
{
"count": "1",
"name": "Cassetti, Borsati",
"value": "mfName_ntk_cs%3A%22Cassetti%2C+Borsati%22"
},
{
"count": "2",
"name": "Classics Home Decor",
"value": "mfName_ntk_cs%3A%22Classics+Home+Decor%22"
},
{
"count": "3",
"name": "Claudet",
"value": "mfName_ntk_cs%3A%22Claudet%22"
},
{
"count": "4",
"name": "Cold-Be-Gone",
"value": "mfName_ntk_cs%3A%22Cold-Be-Gone%22"
},
{
"count": "2",
"name": "Colts Bathroom Accessories",
"value": "mfName_ntk_cs%3A%22Colts+Bathroom+Accessories%22"
},
{
"count": "10",
"name": "Coolers",
"value": "mfName_ntk_cs%3A%22Coolers%22"
},
{
"count": "21",
"name": "Cristie Glassware",
"value": "mfName_ntk_cs%3A%22Cristie+Glassware%22"
},
{
"count": "8",
"name": "Cuisine",
"value": "mfName_ntk_cs%3A%22Cuisine%22"
},
{
"count": "27",
"name": "DVR Technics",
"value": "mfName_ntk_cs%3A%22DVR+Technics%22"
},
{
"count": "3",
"name": "Delish",
"value": "mfName_ntk_cs%3A%22Delish%22"
},
{
"count": "4",
"name": "Delissima",
"value": "mfName_ntk_cs%3A%22Delissima%22"
},
{
"count": "3",
"name": "Digiglee",
"value": "mfName_ntk_cs%3A%22Digiglee%22"
},
{
"count": "3",
"name": "Econo Sense",
"value": "mfName_ntk_cs%3A%22Econo+Sense%22"
},
{
"count": "31",
"name": "Emery",
"value": "mfName_ntk_cs%3A%22Emery%22"
},
{
"count": "14",
"name": "Enzi",
"value": "mfName_ntk_cs%3A%22Enzi%22"
},
{
"count": "20",
"name": "Eye Dee Team",
"value": "mfName_ntk_cs%3A%22Eye+Dee+Team%22"
},
{
"count": "3",
"name": "Fast Financing",
"value": "mfName_ntk_cs%3A%22Fast+Financing%22"
},
{
"count": "8",
"name": "Finit",
"value": "mfName_ntk_cs%3A%22Finit%22"
},
{
"count": "14",
"name": "GECC",
"value": "mfName_ntk_cs%3A%22GECC%22"
},
{
"count": "449",
"name": "Gusso",
"value": "mfName_ntk_cs%3A%22Gusso%22"
},
{
"count": "2",
"name": "Hampton Poultry",
"value": "mfName_ntk_cs%3A%22Hampton+Poultry%22"
},
{
"count": "6",
"name": "Hawthorne Bath Collection",
"value": "mfName_ntk_cs%3A%22Hawthorne+Bath+Collection%22"
},
{
"count": "26",
"name": "Healthy Boost",
"value": "mfName_ntk_cs%3A%22Healthy+Boost%22"
},
{
"count": "11",
"name": "Hermitage",
"value": "mfName_ntk_cs%3A%22Hermitage%22"
},
{
"count": "426",
"name": "Hermitage Collection",
"value": "mfName_ntk_cs%3A%22Hermitage+Collection%22"
},
{
"count": "1",
"name": "Hermitage Collection, Borsati",
"value": "mfName_ntk_cs%3A%22Hermitage+Collection%2C+Borsati%22"
},
{
"count": "3",
"name": "Investing Interests",
"value": "mfName_ntk_cs%3A%22Investing+Interests%22"
},
{
"count": "2",
"name": "Kerry's Glass",
"value": "mfName_ntk_cs%3A%22Kerry%27s+Glass%22"
},
{
"count": "14",
"name": "Kitchen's Best",
"value": "mfName_ntk_cs%3A%22Kitchen%27s+Best%22"
},
{
"count": "36",
"name": "KitchenComfort",
"value": "mfName_ntk_cs%3A%22KitchenComfort%22"
},
{
"count": "24",
"name": "KitchenCraft",
"value": "mfName_ntk_cs%3A%22KitchenCraft%22"
},
{
"count": "1",
"name": "Kitchenel,KitchenComfort",
"value": "mfName_ntk_cs%3A%22Kitchenel%2CKitchenComfort%22"
},
{
"count": "2",
"name": "Klaus Bathroom Collection",
"value": "mfName_ntk_cs%3A%22Klaus+Bathroom+Collection%22"
},
{
"count": "14",
"name": "LUM",
"value": "mfName_ntk_cs%3A%22LUM%22"
},
{
"count": "48",
"name": "Leo",
"value": "mfName_ntk_cs%3A%22Leo%22"
},
{
"count": "4",
"name": "Locken Home Accessories",
"value": "mfName_ntk_cs%3A%22Locken+Home+Accessories%22"
},
{
"count": "399",
"name": "Luigi Valenti",
"value": "mfName_ntk_cs%3A%22Luigi+Valenti%22"
},
{
"count": "16",
"name": "Madisons Choice",
"value": "mfName_ntk_cs%3A%22Madisons+Choice%22"
},
{
"count": "66",
"name": "Mayflower",
"value": "mfName_ntk_cs%3A%22Mayflower%22"
},
{
"count": "42",
"name": "Meso",
"value": "mfName_ntk_cs%3A%22Meso%22"
},
{
"count": "3",
"name": "Modern Finance",
"value": "mfName_ntk_cs%3A%22Modern+Finance%22"
},
{
"count": "12",
"name": "Modern Houseware",
"value": "mfName_ntk_cs%3A%22Modern+Houseware%22"
},
{
"count": "3",
"name": "Money Management",
"value": "mfName_ntk_cs%3A%22Money+Management%22"
},
{
"count": "3",
"name": "Natura",
"value": "mfName_ntk_cs%3A%22Natura%22"
},
{
"count": "18",
"name": "Oxford Orchards",
"value": "mfName_ntk_cs%3A%22Oxford+Orchards%22"
},
{
"count": "6",
"name": "Oxford Organics",
"value": "mfName_ntk_cs%3A%22Oxford+Organics%22"
},
{
"count": "3",
"name": "Photoritz",
"value": "mfName_ntk_cs%3A%22Photoritz%22"
},
{
"count": "2",
"name": "Pierre's Fromage",
"value": "mfName_ntk_cs%3A%22Pierre%27s+Fromage%22"
},
{
"count": "2",
"name": "Regis Bath and Kitchen",
"value": "mfName_ntk_cs%3A%22Regis+Bath+and+Kitchen%22"
},
{
"count": "4",
"name": "Ritect",
"value": "mfName_ntk_cs%3A%22Ritect%22"
},
{
"count": "12",
"name": "Sharpson",
"value": "mfName_ntk_cs%3A%22Sharpson%22"
},
{
"count": "2",
"name": "Signia Towel Racks",
"value": "mfName_ntk_cs%3A%22Signia+Towel+Racks%22"
},
{
"count": "6",
"name": "SleepyHead",
"value": "mfName_ntk_cs%3A%22SleepyHead%22"
},
{
"count": "3",
"name": "Smart Investing",
"value": "mfName_ntk_cs%3A%22Smart+Investing%22"
},
{
"count": "3",
"name": "Society Time",
"value": "mfName_ntk_cs%3A%22Society+Time%22"
},
{
"count": "2",
"name": "Spago Bathroom Designs",
"value": "mfName_ntk_cs%3A%22Spago+Bathroom+Designs%22"
},
{
"count": "3",
"name": "Sportfit",
"value": "mfName_ntk_cs%3A%22Sportfit%22"
},
{
"count": "28",
"name": "Stonehenge",
"value": "mfName_ntk_cs%3A%22Stonehenge%22"
},
{
"count": "28",
"name": "StyleHome",
"value": "mfName_ntk_cs%3A%22StyleHome%22"
},
{
"count": "6",
"name": "Sunshine",
"value": "mfName_ntk_cs%3A%22Sunshine%22"
},
{
"count": "2",
"name": "Sunshine's Bath Design",
"value": "mfName_ntk_cs%3A%22Sunshine%27s+Bath+Design%22"
},
{
"count": "4",
"name": "Supreme",
"value": "mfName_ntk_cs%3A%22Supreme%22"
},
{
"count": "36",
"name": "Synergy",
"value": "mfName_ntk_cs%3A%22Synergy%22"
},
{
"count": "380",
"name": "Versatil",
"value": "mfName_ntk_cs%3A%22Versatil%22"
},
{
"count": "6",
"name": "VitaVerve",
"value": "mfName_ntk_cs%3A%22VitaVerve%22"
},
{
"count": "3",
"name": "Wedding Luxe",
"value": "mfName_ntk_cs%3A%22Wedding+Luxe%22"
}
],
"identifier": "Brand",
"name": "ManufacturerName",
"value": "mfName_ntk_cs"
}
]
}
Provides suggestions with type-ahead for search result page.
findCategorySuggestions
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| limit | Limit. | query | string | false | false |
| count | The number of suggested keywords to be returned. The default value is 4. | query | string | false | false |
| termsSort | The sorting to be used in the returned result, "count" or "index". By default, it is "count". | query | string | 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. |
| 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. |
SiteContentHandler/category.json
/search/resources/store/10001/sitecontent/categorySuggestions
200
{
"suggestionView": [
{
"categorySeparator": " > ",
"entry": [
{
"fullPath": "Apparel",
"image": "images\/catalog\/apparel\/women\/category\/catr_wcl_pants.png",
"name": "Apparel",
"shortDescription": "The latest styles for the entire family.",
"value": "10001"
},
{
"fullPath": "Apparel > Men",
"image": "images\/catalog\/apparel\/men\/category\/catr_app_men.png",
"name": "Men",
"shortDescription": "Men",
"value": "10002"
},
{
"fullPath": "Apparel > Women",
"image": "images\/catalog\/apparel\/women\/category\/catr_app_women.png",
"name": "Women",
"shortDescription": "Women",
"value": "10003"
},
{
"fullPath": "Apparel > Boys",
"image": "images\/catalog\/apparel\/boys\/category\/catr_app_boys.png",
"name": "Boys",
"shortDescription": "boys",
"value": "10004"
},
{
"fullPath": "Apparel > Girls",
"image": "images\/catalog\/apparel\/girls\/category\/catr_app_girls.png",
"name": "Girls",
"shortDescription": "Girls",
"value": "10005"
},
{
"fullPath": "Apparel > Women > Dresses",
"image": "images\/catalog\/apparel\/women\/category\/catr_wcl_dresses.png",
"name": "Dresses",
"shortDescription": "Dresses",
"value": "10006"
},
{
"fullPath": "Apparel > Women > Blouses",
"image": "images\/catalog\/apparel\/women\/category\/catr_wcl_blouses.png",
"name": "Blouses",
"shortDescription": "Blouses",
"value": "10007"
},
{
"fullPath": "Apparel > Women > Sweaters",
"image": "images\/catalog\/apparel\/women\/category\/catr_wcl_sweaters.png",
"name": "Sweaters",
"shortDescription": "Sweaters",
"value": "10008"
},
{
"fullPath": "Apparel > Women > Skirts",
"image": "images\/catalog\/apparel\/women\/category\/catr_wcl_skirts.png",
"name": "Skirts",
"shortDescription": "Skirts",
"value": "10009"
},
{
"fullPath": "Apparel > Women > Pants",
"image": "images\/catalog\/apparel\/women\/category\/catr_wcl_pants.png",
"name": "Pants",
"shortDescription": "Pants",
"value": "10010"
},
{
"fullPath": "Apparel > Women > Shoes",
"image": "images\/catalog\/apparel\/women\/category\/catr_wsh_shoes.png",
"name": "Shoes",
"shortDescription": "Shoes",
"value": "10011"
},
{
"fullPath": "Apparel > Women > Handbags",
"image": "images\/catalog\/apparel\/women\/category\/catr_wbg_handbags.png",
"name": "Handbags",
"shortDescription": "Handbags",
"value": "10012"
},
{
"fullPath": "Apparel > Women > Accessories",
"image": "images\/catalog\/apparel\/women\/category\/catr_wac_accessories.png",
"name": "Accessories",
"shortDescription": "Accessories",
"value": "10013"
},
{
"fullPath": "Apparel > Men > Jackets",
"image": "images\/catalog\/apparel\/men\/category\/catr_mcl_jackets.png",
"name": "Jackets",
"shortDescription": "Jackets",
"value": "10014"
},
{
"fullPath": "Apparel > Men > Shirts",
"image": "images\/catalog\/apparel\/men\/category\/catr_mcl_shirts.png",
"name": "Shirts",
"shortDescription": "Shirts",
"value": "10015"
},
{
"fullPath": "Apparel > Men > Suits",
"image": "images\/catalog\/apparel\/men\/category\/catr_mcl_suits.png",
"name": "Suits",
"shortDescription": "Suits",
"value": "10016"
},
{
"fullPath": "Apparel > Men > Pants",
"image": "images\/catalog\/apparel\/men\/category\/catr_mcl_pants.png",
"name": "Pants",
"shortDescription": "Pants",
"value": "10017"
},
{
"fullPath": "Apparel > Men > Accessories",
"image": "images\/catalog\/apparel\/men\/category\/catr_mac_accessories.png",
"name": "Accessories",
"shortDescription": "Accessories",
"value": "10018"
},
{
"fullPath": "Apparel > Men > Shoes",
"image": "images\/catalog\/apparel\/men\/category\/catr_msh_shoes.png",
"name": "Shoes",
"shortDescription": "Shoes",
"value": "10019"
},
{
"fullPath": "Apparel > Girls > Shoes",
"image": "images\/catalog\/apparel\/girls\/category\/catr_gsh_shoes.png",
"name": "Shoes",
"shortDescription": "Shoes",
"value": "10020"
},
{
"fullPath": "Apparel > Girls > Pants",
"image": "images\/catalog\/apparel\/girls\/category\/catr_gcl_pants.png",
"name": "Pants",
"shortDescription": "Pants",
"value": "10021"
},
{
"fullPath": "Apparel > Girls > Skirts",
"image": "images\/catalog\/apparel\/girls\/category\/catr_gcl_skirts.png",
"name": "Skirts",
"shortDescription": "Skirts",
"value": "10022"
},
{
"fullPath": "Apparel > Girls > Tops",
"image": "images\/catalog\/apparel\/girls\/category\/catr_gcl_tops.png",
"name": "Tops",
"shortDescription": "Tops",
"value": "10023"
},
{
"fullPath": "Apparel > Boys > Pants",
"image": "images\/catalog\/apparel\/boys\/category\/catr_bcl_pants.png",
"name": "Pants",
"shortDescription": "Pants",
"value": "10024"
},
{
"fullPath": "Apparel > Boys > Tops",
"image": "images\/catalog\/apparel\/boys\/category\/catr_bcl_tops.png",
"name": "Tops",
"shortDescription": "Tops",
"value": "10025"
},
{
"fullPath": "Apparel > Boys > Shoes",
"image": "images\/catalog\/apparel\/boys\/category\/catr_bsh_shoes.png",
"name": "Shoes",
"shortDescription": "Shoes",
"value": "10026"
},
{
"fullPath": "Electronics",
"image": "images\/catalog\/electronics\/category\/catr_cta_tablets.png",
"name": "Electronics",
"shortDescription": "Electronics",
"value": "10027"
},
{
"fullPath": "Electronics > Accessories",
"image": "images\/catalog\/electronics\/category\/catr_cac_accessories.png",
"name": "Accessories",
"shortDescription": "Accessories",
"value": "10028"
},
{
"fullPath": "Electronics > Tablets",
"image": "images\/catalog\/electronics\/category\/catr_cta_tablets.png",
"name": "Tablets",
"shortDescription": "Tablets",
"value": "10029"
},
{
"fullPath": "Electronics > Laptops",
"image": "images\/catalog\/electronics\/category\/catr_cla_laptops.png",
"name": "Laptops",
"shortDescription": "Laptops",
"value": "10030"
},
{
"fullPath": "Electronics > Desktops",
"image": "images\/catalog\/electronics\/category\/catr_cde_desktops.png",
"name": "Desktops",
"shortDescription": "Desktops",
"value": "10031"
},
{
"fullPath": "Electronics > Components",
"image": "images\/catalog\/electronics\/category\/catr_ccm_components.png",
"name": "Components",
"shortDescription": "Components",
"value": "10032"
},
{
"fullPath": "Grocery",
"image": "images\/catalog\/grocery\/category\/catr_gda_dairy.png",
"name": "Grocery",
"shortDescription": "Grocery",
"value": "10033"
},
{
"fullPath": "Grocery > Dairy",
"image": "images\/catalog\/grocery\/category\/catr_gda_dairy.png",
"name": "Dairy",
"shortDescription": "Dairy",
"value": "10034"
},
{
"fullPath": "Grocery > Fruit",
"image": "images\/catalog\/grocery\/category\/catr_gfr_fruit.png",
"name": "Fruit",
"shortDescription": "Fruit",
"value": "10035"
},
{
"fullPath": "Grocery > Meat",
"image": "images\/catalog\/grocery\/category\/catr_gme_meat.png",
"name": "Meat",
"shortDescription": "Meat",
"value": "10036"
},
{
"fullPath": "Grocery > Vegetables",
"image": "images\/catalog\/grocery\/category\/catr_gve_vegetables.png",
"name": "Vegetables",
"shortDescription": "Vegetables",
"value": "10037"
},
{
"fullPath": "Health",
"image": "images\/catalog\/health\/category\/catr_hme_medicine.png",
"name": "Health",
"shortDescription": "Health",
"value": "10038"
},
{
"fullPath": "Health > Medicine",
"image": "images\/catalog\/health\/category\/catr_hme_medicine.png",
"name": "Medicine",
"shortDescription": "Medicine",
"value": "10039"
},
{
"fullPath": "Health > Vitamins",
"image": "images\/catalog\/health\/category\/catr_hvt_vitamins.png",
"name": "Vitamins",
"shortDescription": "Vitamins",
"value": "10040"
},
{
"fullPath": "Home & Furnishing",
"image": "images\/catalog\/homefurnishings\/category\/catr_hap_appliances.png",
"name": "Home & Furnishing",
"shortDescription": "Home & Furnishing",
"value": "10041"
},
{
"fullPath": "Home & Furnishing > Bath Accessories",
"image": "images\/catalog\/homefurnishings\/category\/catr_hba_bath.png",
"name": "Bath Accessories",
"shortDescription": "Bath Accessories",
"value": "10042"
},
{
"fullPath": "Home & Furnishing > Furniture",
"image": "images\/catalog\/homefurnishings\/category\/catr_hfu_furniture.png",
"name": "Furniture",
"shortDescription": "Furniture",
"value": "10043"
},
{
"fullPath": "Home & Furnishing > Kitchenware",
"image": "images\/catalog\/homefurnishings\/category\/catr_hkt_kitchenware.png",
"name": "Kitchenware",
"shortDescription": "Kitchenware",
"value": "10044"
},
{
"fullPath": "Home & Furnishing > Lighting",
"image": "images\/catalog\/homefurnishings\/category\/catr_hlg_lighting.png",
"name": "Lighting",
"shortDescription": "Lighting",
"value": "10045"
},
{
"fullPath": "Home & Furnishing > Tableware",
"image": "images\/catalog\/homefurnishings\/category\/catr_hta_tableware.png",
"name": "Tableware",
"shortDescription": "Tableware",
"value": "10046"
},
{
"fullPath": "Home & Furnishing > Appliances",
"image": "images\/catalog\/homefurnishings\/category\/catr_hap_appliances.png",
"name": "Appliances",
"shortDescription": "Appliances",
"value": "10047"
},
{
"fullPath": "Newsletters & Magazines",
"image": "images\/catalog\/newslettersmagazines\/category\/catr_nma_magazines.png",
"name": "Newsletters & Magazines",
"shortDescription": "Newsletters & Magazines",
"value": "10048"
},
{
"fullPath": "Newsletters & Magazines > Magazines",
"image": "images\/catalog\/newslettersmagazines\/category\/catr_nma_magazines.png",
"name": "Magazines",
"shortDescription": "Magazines",
"value": "10049"
},
{
"fullPath": "Newsletters & Magazines > Newsletters",
"image": "images\/catalog\/newslettersmagazines\/category\/catr_nne_newsletters.png",
"name": "Newsletters",
"shortDescription": "Newsletters",
"value": "10050"
}
],
"identifier": "Category"
}
]
}
Provides keyword suggestions with type-ahead for search result page based on a term.
findKeywordSuggestionsByTerm
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| term | The search term. | path | string | true | N/A |
| limit | Limit. | query | string | false | false |
| count | The number of suggested keywords to be returned. The default value is 4. | query | string | false | false |
| termsSort | The sorting to be used in the returned result, "count" or "index". By default, it is "count". | query | string | 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. |
| 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. |
SiteContentHandler/keyword.json
/search/resources/store/10001/sitecontent/keywordSuggestionsByTerm/sofa
200
{
"suggestionView": [
{
"entry": [
{
"frequency": 18,
"term": "sofa"
},
{
"frequency": 4,
"term": "sofa set"
},
{
"frequency": 4,
"term": "sofa."
},
{
"frequency": 4,
"term": "sofas"
}
],
"identifier": "Keyword"
}
]
}
Provides suggestions with type-ahead for search result page.
findProductSuggestionsBySearchTerm
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| searchTerm | The term to search for. | path | string | true | N/A |
| 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 |
| searchType | The search type is a numeric string with controls the query operator: ANY, OR, AND and control what data to be returned. For a detailed list of valid values, see the online documentation on Match type (_wcf.search.type). Known valid values include : 0: ANY (exclude SKU)1: EXACT (exclude SKU), 2: ALL (exclude SKU), 3: NONE (exclude SKU), 10: ANY (include SKU), 11: EXACT (include SKU), 12: ALL (include SKU), 13: NONE (include SKU), 100: ANY (only SKU), 101: EXACT (only SKU), 102: ALL (only SKU), 103: NONE (only SKU), 1000: ANY (include products, kits, bundles, category level SKU) (exclude product level SKU), 1001: EXACT (include products, kits, bundles, category level SKU) (exclude product level SKU), 1002: ALL (include products, kits, bundles, category level SKU) (exclude product level SKU), 1003: NONE (include products, kits, bundles, category level SKU) (exclude product level SKU), 10000: ANY (include category level SKU) (exclude products, kits, bundles, product level SKU), 10001: EXACT (include category level SKU) (exclude products, kits, bundles, product level SKU), 10002: ALL (include category level SKU) (exclude products, kits, bundles, product level SKU), 10003: NONE (include category level SKU) (exclude products, kits, bundles, product level SKU) | query | string | false | false |
| term | The search term. | query | string | false | false |
| termsSort | The sorting to be used in the returned result, "count" or "index". By default, it is "count". | query | string | false | false |
| 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 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. |
SiteContentHandler/product.json
/search/resources/store/10001/sitecontent/productSuggestionsBySearchTerm/sofa
200
{
"recordSetComplete": "true",
"recordSetCount": 9,
"recordSetStartNumber": 0,
"recordSetTotal": 9,
"recordSetTotalMatches": 9,
"resourceId": "https:\/\/localhost\/search\/resources\/store\/10001\/sitecontent\/productSuggestionsBySearchTerm\/sofa",
"resourceName": "sitecontent",
"suggestionView": [
{
"entry": [
{
"hasSingleSKU": true,
"name": "Supreme LoungeStyle Double Sofa",
"partNumber": "HFU032_3206",
"resourceId": "https:\/\/localhost\/search\/resources\/store\/10001\/sitecontent\/productSuggestionsBySearchTerm\/sofa12846",
"shortDescription": "A long cozy double sofa for lounges.",
"singleSKUCatalogEntryID": "12847",
"storeID": "10001",
"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/hfu032_furniture\/200x310\/hfu032_3206.jpg",
"uniqueID": "12846"
},
{
"hasSingleSKU": true,
"name": "StyleHome InOffice Double Sofa",
"partNumber": "HFU032_3203",
"resourceId": "https:\/\/localhost\/search\/resources\/store\/10001\/sitecontent\/productSuggestionsBySearchTerm\/sofa12840",
"shortDescription": "InOffice sofas are made for the typical office environment.",
"singleSKUCatalogEntryID": "12841",
"storeID": "10001",
"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/hfu032_furniture\/200x310\/hfu032_3203.jpg",
"uniqueID": "12840"
},
{
"hasSingleSKU": true,
"name": "StyleHome InOffice Single Sofa",
"partNumber": "HFU032_3204",
"resourceId": "https:\/\/localhost\/search\/resources\/store\/10001\/sitecontent\/productSuggestionsBySearchTerm\/sofa12842",
"shortDescription": "InOffice sofas are made for the typical office environment.",
"singleSKUCatalogEntryID": "12843",
"storeID": "10001",
"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/hfu032_furniture\/200x310\/hfu032_3204.jpg",
"uniqueID": "12842"
},
{
"hasSingleSKU": true,
"name": "StyleHome UltraCozy Single Sofa",
"partNumber": "HFU032_3211",
"resourceId": "https:\/\/localhost\/search\/resources\/store\/10001\/sitecontent\/productSuggestionsBySearchTerm\/sofa12856",
"shortDescription": "Very cozy short design single sofa.",
"singleSKUCatalogEntryID": "12857",
"storeID": "10001",
"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/hfu032_furniture\/200x310\/hfu032_3211.jpg",
"uniqueID": "12856"
},
{
"hasSingleSKU": true,
"name": "StyleHome UltraCozy Large Sofa",
"partNumber": "HFU032_3212",
"resourceId": "https:\/\/localhost\/search\/resources\/store\/10001\/sitecontent\/productSuggestionsBySearchTerm\/sofa12858",
"shortDescription": "Very cozy short design Large sofa.",
"singleSKUCatalogEntryID": "12859",
"storeID": "10001",
"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/hfu032_furniture\/200x310\/hfu032_3212.jpg",
"uniqueID": "12858"
},
{
"hasSingleSKU": true,
"name": "Supreme GiantsCorner Sofa Set",
"partNumber": "HFU032_3205",
"resourceId": "https:\/\/localhost\/search\/resources\/store\/10001\/sitecontent\/productSuggestionsBySearchTerm\/sofa12844",
"shortDescription": "2 piece sofa set with shams for a cozy living room.",
"singleSKUCatalogEntryID": "12845",
"storeID": "10001",
"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/hfu032_furniture\/200x310\/hfu032_3205.jpg",
"uniqueID": "12844"
},
{
"hasSingleSKU": true,
"name": "Stonehenge Modern Steelet Single Sofa",
"partNumber": "HFU032_3209",
"resourceId": "https:\/\/localhost\/search\/resources\/store\/10001\/sitecontent\/productSuggestionsBySearchTerm\/sofa12852",
"shortDescription": "A modern single sofa with leather seat and steel legs.",
"singleSKUCatalogEntryID": "12853",
"storeID": "10001",
"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/hfu032_furniture\/200x310\/hfu032_3209.jpg",
"uniqueID": "12852"
},
{
"hasSingleSKU": true,
"name": "StyleHome Modern Plain Single Large Sofa",
"partNumber": "HFU032_3202",
"resourceId": "https:\/\/localhost\/search\/resources\/store\/10001\/sitecontent\/productSuggestionsBySearchTerm\/sofa12838",
"shortDescription": "Sophisticated modern sofa design.",
"singleSKUCatalogEntryID": "12839",
"storeID": "10001",
"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/hfu032_furniture\/200x310\/hfu032_3202.jpg",
"uniqueID": "12838"
},
{
"hasSingleSKU": true,
"name": "StyleHome Modern Rimmed 3 Piece Sofa Set",
"partNumber": "HFU032_3201",
"resourceId": "https:\/\/localhost\/search\/resources\/store\/10001\/sitecontent\/productSuggestionsBySearchTerm\/sofa12836",
"shortDescription": "3 piece sofa set with a very modern design.",
"singleSKUCatalogEntryID": "12837",
"storeID": "10001",
"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/hfu032_furniture\/200x310\/hfu032_3201.jpg",
"uniqueID": "12836"
}
],
"identifier": "Product"
}
]
}
Provides suggestions with type-ahead for search result page.
findSuggestions
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| suggestType | The suggestion type. Accepted values are "Category", "Brand", "Articles", "Keyword", and "Product". Multiple name-value pairs can be used. | query | string | false | true |
| term | The search term. | query | string | false | false |
| limit | Limit. | query | string | false | false |
| count | The number of suggested keywords to be returned. The default value is 4. | query | string | false | false |
| termsSort | The sorting to be used in the returned result, "count" or "index". By default, it is "count". | query | string | 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. |
| 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. |
SiteContentHandler/webcontent.json
/search/resources/store/10001/sitecontent/suggestions?catalogId=10052&langId=-1&contractId=10001&responseFormat=json
200
{
"suggestionView": [
{
"categorySeparator": " > ",
"entry": [
{
"fullPath": "Apparel",
"image": "images\/catalog\/apparel\/women\/category\/catr_wcl_pants.png",
"name": "Apparel",
"shortDescription": "The latest styles for the entire family.",
"value": "10001"
},
{
"fullPath": "Apparel > Men",
"image": "images\/catalog\/apparel\/men\/category\/catr_app_men.png",
"name": "Men",
"shortDescription": "Men",
"value": "10002"
},
{
"fullPath": "Apparel > Women",
"image": "images\/catalog\/apparel\/women\/category\/catr_app_women.png",
"name": "Women",
"shortDescription": "Women",
"value": "10003"
},
{
"fullPath": "Apparel > Boys",
"image": "images\/catalog\/apparel\/boys\/category\/catr_app_boys.png",
"name": "Boys",
"shortDescription": "boys",
"value": "10004"
},
{
"fullPath": "Apparel > Girls",
"image": "images\/catalog\/apparel\/girls\/category\/catr_app_girls.png",
"name": "Girls",
"shortDescription": "Girls",
"value": "10005"
},
{
"fullPath": "Apparel > Women > Dresses",
"image": "images\/catalog\/apparel\/women\/category\/catr_wcl_dresses.png",
"name": "Dresses",
"shortDescription": "Dresses",
"value": "10006"
},
{
"fullPath": "Apparel > Women > Blouses",
"image": "images\/catalog\/apparel\/women\/category\/catr_wcl_blouses.png",
"name": "Blouses",
"shortDescription": "Blouses",
"value": "10007"
},
{
"fullPath": "Apparel > Women > Sweaters",
"image": "images\/catalog\/apparel\/women\/category\/catr_wcl_sweaters.png",
"name": "Sweaters",
"shortDescription": "Sweaters",
"value": "10008"
},
{
"fullPath": "Apparel > Women > Skirts",
"image": "images\/catalog\/apparel\/women\/category\/catr_wcl_skirts.png",
"name": "Skirts",
"shortDescription": "Skirts",
"value": "10009"
},
{
"fullPath": "Apparel > Women > Pants",
"image": "images\/catalog\/apparel\/women\/category\/catr_wcl_pants.png",
"name": "Pants",
"shortDescription": "Pants",
"value": "10010"
},
{
"fullPath": "Apparel > Women > Shoes",
"image": "images\/catalog\/apparel\/women\/category\/catr_wsh_shoes.png",
"name": "Shoes",
"shortDescription": "Shoes",
"value": "10011"
},
{
"fullPath": "Apparel > Women > Handbags",
"image": "images\/catalog\/apparel\/women\/category\/catr_wbg_handbags.png",
"name": "Handbags",
"shortDescription": "Handbags",
"value": "10012"
},
{
"fullPath": "Apparel > Women > Accessories",
"image": "images\/catalog\/apparel\/women\/category\/catr_wac_accessories.png",
"name": "Accessories",
"shortDescription": "Accessories",
"value": "10013"
},
{
"fullPath": "Apparel > Men > Jackets",
"image": "images\/catalog\/apparel\/men\/category\/catr_mcl_jackets.png",
"name": "Jackets",
"shortDescription": "Jackets",
"value": "10014"
},
{
"fullPath": "Apparel > Men > Shirts",
"image": "images\/catalog\/apparel\/men\/category\/catr_mcl_shirts.png",
"name": "Shirts",
"shortDescription": "Shirts",
"value": "10015"
},
{
"fullPath": "Apparel > Men > Suits",
"image": "images\/catalog\/apparel\/men\/category\/catr_mcl_suits.png",
"name": "Suits",
"shortDescription": "Suits",
"value": "10016"
},
{
"fullPath": "Apparel > Men > Pants",
"image": "images\/catalog\/apparel\/men\/category\/catr_mcl_pants.png",
"name": "Pants",
"shortDescription": "Pants",
"value": "10017"
},
{
"fullPath": "Apparel > Men > Accessories",
"image": "images\/catalog\/apparel\/men\/category\/catr_mac_accessories.png",
"name": "Accessories",
"shortDescription": "Accessories",
"value": "10018"
},
{
"fullPath": "Apparel > Men > Shoes",
"image": "images\/catalog\/apparel\/men\/category\/catr_msh_shoes.png",
"name": "Shoes",
"shortDescription": "Shoes",
"value": "10019"
},
{
"fullPath": "Apparel > Girls > Shoes",
"image": "images\/catalog\/apparel\/girls\/category\/catr_gsh_shoes.png",
"name": "Shoes",
"shortDescription": "Shoes",
"value": "10020"
},
{
"fullPath": "Apparel > Girls > Pants",
"image": "images\/catalog\/apparel\/girls\/category\/catr_gcl_pants.png",
"name": "Pants",
"shortDescription": "Pants",
"value": "10021"
},
{
"fullPath": "Apparel > Girls > Skirts",
"image": "images\/catalog\/apparel\/girls\/category\/catr_gcl_skirts.png",
"name": "Skirts",
"shortDescription": "Skirts",
"value": "10022"
},
{
"fullPath": "Apparel > Girls > Tops",
"image": "images\/catalog\/apparel\/girls\/category\/catr_gcl_tops.png",
"name": "Tops",
"shortDescription": "Tops",
"value": "10023"
},
{
"fullPath": "Apparel > Boys > Pants",
"image": "images\/catalog\/apparel\/boys\/category\/catr_bcl_pants.png",
"name": "Pants",
"shortDescription": "Pants",
"value": "10024"
},
{
"fullPath": "Apparel > Boys > Tops",
"image": "images\/catalog\/apparel\/boys\/category\/catr_bcl_tops.png",
"name": "Tops",
"shortDescription": "Tops",
"value": "10025"
},
{
"fullPath": "Apparel > Boys > Shoes",
"image": "images\/catalog\/apparel\/boys\/category\/catr_bsh_shoes.png",
"name": "Shoes",
"shortDescription": "Shoes",
"value": "10026"
},
{
"fullPath": "Electronics",
"image": "images\/catalog\/electronics\/category\/catr_cta_tablets.png",
"name": "Electronics",
"shortDescription": "Electronics",
"value": "10027"
},
{
"fullPath": "Electronics > Accessories",
"image": "images\/catalog\/electronics\/category\/catr_cac_accessories.png",
"name": "Accessories",
"shortDescription": "Accessories",
"value": "10028"
},
{
"fullPath": "Electronics > Tablets",
"image": "images\/catalog\/electronics\/category\/catr_cta_tablets.png",
"name": "Tablets",
"shortDescription": "Tablets",
"value": "10029"
},
{
"fullPath": "Electronics > Laptops",
"image": "images\/catalog\/electronics\/category\/catr_cla_laptops.png",
"name": "Laptops",
"shortDescription": "Laptops",
"value": "10030"
},
{
"fullPath": "Electronics > Desktops",
"image": "images\/catalog\/electronics\/category\/catr_cde_desktops.png",
"name": "Desktops",
"shortDescription": "Desktops",
"value": "10031"
},
{
"fullPath": "Electronics > Components",
"image": "images\/catalog\/electronics\/category\/catr_ccm_components.png",
"name": "Components",
"shortDescription": "Components",
"value": "10032"
},
{
"fullPath": "Grocery",
"image": "images\/catalog\/grocery\/category\/catr_gda_dairy.png",
"name": "Grocery",
"shortDescription": "Grocery",
"value": "10033"
},
{
"fullPath": "Grocery > Dairy",
"image": "images\/catalog\/grocery\/category\/catr_gda_dairy.png",
"name": "Dairy",
"shortDescription": "Dairy",
"value": "10034"
},
{
"fullPath": "Grocery > Fruit",
"image": "images\/catalog\/grocery\/category\/catr_gfr_fruit.png",
"name": "Fruit",
"shortDescription": "Fruit",
"value": "10035"
},
{
"fullPath": "Grocery > Meat",
"image": "images\/catalog\/grocery\/category\/catr_gme_meat.png",
"name": "Meat",
"shortDescription": "Meat",
"value": "10036"
},
{
"fullPath": "Grocery > Vegetables",
"image": "images\/catalog\/grocery\/category\/catr_gve_vegetables.png",
"name": "Vegetables",
"shortDescription": "Vegetables",
"value": "10037"
},
{
"fullPath": "Health",
"image": "images\/catalog\/health\/category\/catr_hme_medicine.png",
"name": "Health",
"shortDescription": "Health",
"value": "10038"
},
{
"fullPath": "Health > Medicine",
"image": "images\/catalog\/health\/category\/catr_hme_medicine.png",
"name": "Medicine",
"shortDescription": "Medicine",
"value": "10039"
},
{
"fullPath": "Health > Vitamins",
"image": "images\/catalog\/health\/category\/catr_hvt_vitamins.png",
"name": "Vitamins",
"shortDescription": "Vitamins",
"value": "10040"
},
{
"fullPath": "Home & Furnishing",
"image": "images\/catalog\/homefurnishings\/category\/catr_hap_appliances.png",
"name": "Home & Furnishing",
"shortDescription": "Home & Furnishing",
"value": "10041"
},
{
"fullPath": "Home & Furnishing > Bath Accessories",
"image": "images\/catalog\/homefurnishings\/category\/catr_hba_bath.png",
"name": "Bath Accessories",
"shortDescription": "Bath Accessories",
"value": "10042"
},
{
"fullPath": "Home & Furnishing > Furniture",
"image": "images\/catalog\/homefurnishings\/category\/catr_hfu_furniture.png",
"name": "Furniture",
"shortDescription": "Furniture",
"value": "10043"
},
{
"fullPath": "Home & Furnishing > Kitchenware",
"image": "images\/catalog\/homefurnishings\/category\/catr_hkt_kitchenware.png",
"name": "Kitchenware",
"shortDescription": "Kitchenware",
"value": "10044"
},
{
"fullPath": "Home & Furnishing > Lighting",
"image": "images\/catalog\/homefurnishings\/category\/catr_hlg_lighting.png",
"name": "Lighting",
"shortDescription": "Lighting",
"value": "10045"
},
{
"fullPath": "Home & Furnishing > Tableware",
"image": "images\/catalog\/homefurnishings\/category\/catr_hta_tableware.png",
"name": "Tableware",
"shortDescription": "Tableware",
"value": "10046"
},
{
"fullPath": "Home & Furnishing > Appliances",
"image": "images\/catalog\/homefurnishings\/category\/catr_hap_appliances.png",
"name": "Appliances",
"shortDescription": "Appliances",
"value": "10047"
},
{
"fullPath": "Newsletters & Magazines",
"image": "images\/catalog\/newslettersmagazines\/category\/catr_nma_magazines.png",
"name": "Newsletters & Magazines",
"shortDescription": "Newsletters & Magazines",
"value": "10048"
},
{
"fullPath": "Newsletters & Magazines > Magazines",
"image": "images\/catalog\/newslettersmagazines\/category\/catr_nma_magazines.png",
"name": "Magazines",
"shortDescription": "Magazines",
"value": "10049"
},
{
"fullPath": "Newsletters & Magazines > Newsletters",
"image": "images\/catalog\/newslettersmagazines\/category\/catr_nne_newsletters.png",
"name": "Newsletters",
"shortDescription": "Newsletters",
"value": "10050"
}
],
"identifier": "Category"
},
{
"entry": [
{
"count": "14",
"name": "Adelee Plus",
"value": "mfName_ntk_cs%3A%22Adelee+Plus%22"
},
{
"count": "471",
"name": "Albini",
"value": "mfName_ntk_cs%3A%22Albini%22"
},
{
"count": "2",
"name": "Alexander Home",
"value": "mfName_ntk_cs%3A%22Alexander+Home%22"
},
{
"count": "2",
"name": "All-In-One",
"value": "mfName_ntk_cs%3A%22All-In-One%22"
},
{
"count": "12",
"name": "Alumina",
"value": "mfName_ntk_cs%3A%22Alumina%22"
},
{
"count": "3",
"name": "Archaeo",
"value": "mfName_ntk_cs%3A%22Archaeo%22"
},
{
"count": "20",
"name": "AromaStar",
"value": "mfName_ntk_cs%3A%22AromaStar%22"
},
{
"count": "2",
"name": "Australia Lamb Co.",
"value": "mfName_ntk_cs%3A%22Australia+Lamb+Co.%22"
},
{
"count": "43",
"name": "Baril",
"value": "mfName_ntk_cs%3A%22Baril%22"
},
{
"count": "2",
"name": "Bender Home Fashions",
"value": "mfName_ntk_cs%3A%22Bender+Home+Fashions%22"
},
{
"count": "2",
"name": "Bluthe Potato Co.",
"value": "mfName_ntk_cs%3A%22Bluthe+Potato+Co.%22"
},
{
"count": "168",
"name": "Borsati",
"value": "mfName_ntk_cs%3A%22Borsati%22"
},
{
"count": "6",
"name": "Burleign",
"value": "mfName_ntk_cs%3A%22Burleign%22"
},
{
"count": "12",
"name": "California Sun",
"value": "mfName_ntk_cs%3A%22California+Sun%22"
},
{
"count": "6",
"name": "Captain Stewarts",
"value": "mfName_ntk_cs%3A%22Captain+Stewarts%22"
},
{
"count": "42",
"name": "Cassetti",
"value": "mfName_ntk_cs%3A%22Cassetti%22"
},
{
"count": "1",
"name": "Cassetti, Borsati",
"value": "mfName_ntk_cs%3A%22Cassetti%2C+Borsati%22"
},
{
"count": "2",
"name": "Classics Home Decor",
"value": "mfName_ntk_cs%3A%22Classics+Home+Decor%22"
},
{
"count": "3",
"name": "Claudet",
"value": "mfName_ntk_cs%3A%22Claudet%22"
},
{
"count": "4",
"name": "Cold-Be-Gone",
"value": "mfName_ntk_cs%3A%22Cold-Be-Gone%22"
},
{
"count": "2",
"name": "Colts Bathroom Accessories",
"value": "mfName_ntk_cs%3A%22Colts+Bathroom+Accessories%22"
},
{
"count": "10",
"name": "Coolers",
"value": "mfName_ntk_cs%3A%22Coolers%22"
},
{
"count": "21",
"name": "Cristie Glassware",
"value": "mfName_ntk_cs%3A%22Cristie+Glassware%22"
},
{
"count": "8",
"name": "Cuisine",
"value": "mfName_ntk_cs%3A%22Cuisine%22"
},
{
"count": "27",
"name": "DVR Technics",
"value": "mfName_ntk_cs%3A%22DVR+Technics%22"
},
{
"count": "3",
"name": "Delish",
"value": "mfName_ntk_cs%3A%22Delish%22"
},
{
"count": "4",
"name": "Delissima",
"value": "mfName_ntk_cs%3A%22Delissima%22"
},
{
"count": "3",
"name": "Digiglee",
"value": "mfName_ntk_cs%3A%22Digiglee%22"
},
{
"count": "3",
"name": "Econo Sense",
"value": "mfName_ntk_cs%3A%22Econo+Sense%22"
},
{
"count": "31",
"name": "Emery",
"value": "mfName_ntk_cs%3A%22Emery%22"
},
{
"count": "14",
"name": "Enzi",
"value": "mfName_ntk_cs%3A%22Enzi%22"
},
{
"count": "20",
"name": "Eye Dee Team",
"value": "mfName_ntk_cs%3A%22Eye+Dee+Team%22"
},
{
"count": "3",
"name": "Fast Financing",
"value": "mfName_ntk_cs%3A%22Fast+Financing%22"
},
{
"count": "8",
"name": "Finit",
"value": "mfName_ntk_cs%3A%22Finit%22"
},
{
"count": "14",
"name": "GECC",
"value": "mfName_ntk_cs%3A%22GECC%22"
},
{
"count": "449",
"name": "Gusso",
"value": "mfName_ntk_cs%3A%22Gusso%22"
},
{
"count": "2",
"name": "Hampton Poultry",
"value": "mfName_ntk_cs%3A%22Hampton+Poultry%22"
},
{
"count": "6",
"name": "Hawthorne Bath Collection",
"value": "mfName_ntk_cs%3A%22Hawthorne+Bath+Collection%22"
},
{
"count": "26",
"name": "Healthy Boost",
"value": "mfName_ntk_cs%3A%22Healthy+Boost%22"
},
{
"count": "11",
"name": "Hermitage",
"value": "mfName_ntk_cs%3A%22Hermitage%22"
},
{
"count": "426",
"name": "Hermitage Collection",
"value": "mfName_ntk_cs%3A%22Hermitage+Collection%22"
},
{
"count": "1",
"name": "Hermitage Collection, Borsati",
"value": "mfName_ntk_cs%3A%22Hermitage+Collection%2C+Borsati%22"
},
{
"count": "3",
"name": "Investing Interests",
"value": "mfName_ntk_cs%3A%22Investing+Interests%22"
},
{
"count": "2",
"name": "Kerry's Glass",
"value": "mfName_ntk_cs%3A%22Kerry%27s+Glass%22"
},
{
"count": "14",
"name": "Kitchen's Best",
"value": "mfName_ntk_cs%3A%22Kitchen%27s+Best%22"
},
{
"count": "36",
"name": "KitchenComfort",
"value": "mfName_ntk_cs%3A%22KitchenComfort%22"
},
{
"count": "24",
"name": "KitchenCraft",
"value": "mfName_ntk_cs%3A%22KitchenCraft%22"
},
{
"count": "1",
"name": "Kitchenel,KitchenComfort",
"value": "mfName_ntk_cs%3A%22Kitchenel%2CKitchenComfort%22"
},
{
"count": "2",
"name": "Klaus Bathroom Collection",
"value": "mfName_ntk_cs%3A%22Klaus+Bathroom+Collection%22"
},
{
"count": "14",
"name": "LUM",
"value": "mfName_ntk_cs%3A%22LUM%22"
},
{
"count": "48",
"name": "Leo",
"value": "mfName_ntk_cs%3A%22Leo%22"
},
{
"count": "4",
"name": "Locken Home Accessories",
"value": "mfName_ntk_cs%3A%22Locken+Home+Accessories%22"
},
{
"count": "399",
"name": "Luigi Valenti",
"value": "mfName_ntk_cs%3A%22Luigi+Valenti%22"
},
{
"count": "16",
"name": "Madisons Choice",
"value": "mfName_ntk_cs%3A%22Madisons+Choice%22"
},
{
"count": "66",
"name": "Mayflower",
"value": "mfName_ntk_cs%3A%22Mayflower%22"
},
{
"count": "42",
"name": "Meso",
"value": "mfName_ntk_cs%3A%22Meso%22"
},
{
"count": "3",
"name": "Modern Finance",
"value": "mfName_ntk_cs%3A%22Modern+Finance%22"
},
{
"count": "12",
"name": "Modern Houseware",
"value": "mfName_ntk_cs%3A%22Modern+Houseware%22"
},
{
"count": "3",
"name": "Money Management",
"value": "mfName_ntk_cs%3A%22Money+Management%22"
},
{
"count": "3",
"name": "Natura",
"value": "mfName_ntk_cs%3A%22Natura%22"
},
{
"count": "18",
"name": "Oxford Orchards",
"value": "mfName_ntk_cs%3A%22Oxford+Orchards%22"
},
{
"count": "6",
"name": "Oxford Organics",
"value": "mfName_ntk_cs%3A%22Oxford+Organics%22"
},
{
"count": "3",
"name": "Photoritz",
"value": "mfName_ntk_cs%3A%22Photoritz%22"
},
{
"count": "2",
"name": "Pierre's Fromage",
"value": "mfName_ntk_cs%3A%22Pierre%27s+Fromage%22"
},
{
"count": "2",
"name": "Regis Bath and Kitchen",
"value": "mfName_ntk_cs%3A%22Regis+Bath+and+Kitchen%22"
},
{
"count": "4",
"name": "Ritect",
"value": "mfName_ntk_cs%3A%22Ritect%22"
},
{
"count": "12",
"name": "Sharpson",
"value": "mfName_ntk_cs%3A%22Sharpson%22"
},
{
"count": "2",
"name": "Signia Towel Racks",
"value": "mfName_ntk_cs%3A%22Signia+Towel+Racks%22"
},
{
"count": "6",
"name": "SleepyHead",
"value": "mfName_ntk_cs%3A%22SleepyHead%22"
},
{
"count": "3",
"name": "Smart Investing",
"value": "mfName_ntk_cs%3A%22Smart+Investing%22"
},
{
"count": "3",
"name": "Society Time",
"value": "mfName_ntk_cs%3A%22Society+Time%22"
},
{
"count": "2",
"name": "Spago Bathroom Designs",
"value": "mfName_ntk_cs%3A%22Spago+Bathroom+Designs%22"
},
{
"count": "3",
"name": "Sportfit",
"value": "mfName_ntk_cs%3A%22Sportfit%22"
},
{
"count": "28",
"name": "Stonehenge",
"value": "mfName_ntk_cs%3A%22Stonehenge%22"
},
{
"count": "28",
"name": "StyleHome",
"value": "mfName_ntk_cs%3A%22StyleHome%22"
},
{
"count": "6",
"name": "Sunshine",
"value": "mfName_ntk_cs%3A%22Sunshine%22"
},
{
"count": "2",
"name": "Sunshine's Bath Design",
"value": "mfName_ntk_cs%3A%22Sunshine%27s+Bath+Design%22"
},
{
"count": "4",
"name": "Supreme",
"value": "mfName_ntk_cs%3A%22Supreme%22"
},
{
"count": "36",
"name": "Synergy",
"value": "mfName_ntk_cs%3A%22Synergy%22"
},
{
"count": "380",
"name": "Versatil",
"value": "mfName_ntk_cs%3A%22Versatil%22"
},
{
"count": "6",
"name": "VitaVerve",
"value": "mfName_ntk_cs%3A%22VitaVerve%22"
},
{
"count": "3",
"name": "Wedding Luxe",
"value": "mfName_ntk_cs%3A%22Wedding+Luxe%22"
}
],
"identifier": "Brand",
"name": "ManufacturerName",
"value": "mfName_ntk_cs"
},
{
"entry": [
{
"name": "About the Dress Designer",
"path": "GenericStaticContentPageLayoutView?storeId=10001&pageId=1009&urlLangId=-1&urlRequestType=Base&langId=-1&catalogId=10001"
},
{
"name": "Clothing and Dress Style Guide",
"path": "GenericStaticContentPageLayoutView?storeId=10001&pageId=1010&urlLangId=-1&urlRequestType=Base&langId=-1&catalogId=10001"
},
{
"name": "Contact Us for Aurora",
"path": "GenericStaticContentPageLayoutView?storeId=10001&pageId=1002&urlLangId=-1&urlRequestType=Base&langId=-1&catalogId=10001"
},
{
"name": "Corporate Contact Us for Aurora",
"path": "GenericStaticContentPageLayoutView?storeId=10001&pageId=1006&urlLangId=-1&urlRequestType=Base&langId=-1&catalogId=10001"
},
{
"name": "About Us for Aurora",
"path": "GenericStaticContentPageLayoutView?storeId=10001&pageId=1005&urlLangId=-1&urlRequestType=Base&langId=-1&catalogId=10001"
},
{
"name": "Evening Sparkle Dress Collection Video",
"path": "GenericStaticContentPageLayoutView?storeId=10001&pageId=1011&urlLangId=-1&urlRequestType=Base&langId=-1&catalogId=10001"
},
{
"name": "Help at Aurora",
"path": "GenericStaticContentPageLayoutView?storeId=10001&pageId=1001&urlLangId=-1&urlRequestType=Base&langId=-1&catalogId=10001"
},
{
"name": "Website Privacy Policy for Aurora",
"path": "GenericStaticContentPageLayoutView?storeId=10001&pageId=1004&urlLangId=-1&urlRequestType=Base&langId=-1&catalogId=10001"
},
{
"name": "Return Policy for Aurora",
"path": "GenericStaticContentPageLayoutView?storeId=10001&pageId=1003&urlLangId=-1&urlRequestType=Base&langId=-1&catalogId=10001"
},
{
"name": "Site Map for Aurora",
"path": "GenericStaticContentPageLayoutView?storeId=10001&pageId=1007&urlLangId=-1&urlRequestType=Base&langId=-1&catalogId=10001"
}
],
"identifier": "Articles"
}
]
}
Search unstructured content details for search result page based on a search term.
findWebContentsBySearchTerm
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| searchTerm | The term to search for. | path | string | true | N/A |
| facet | The selected facets. | query | string | false | false |
| facetLimit | The multiple name-value pairs of facet limit defining the maximum number of items to be returned under each facet. The sequence of limits honored alongside with the sequence of facet name-value pairs. | 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 |
| 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. |
SiteContentHandler/webcontent.json
/search/resources/store/10001/sitecontent/webContentsBySearchTerm/dress
200
{
"recordSetComplete": "true",
"recordSetCount": 4,
"recordSetStartNumber": 0,
"recordSetTotal": 4,
"resourceId": "https:\/\/localhost\/search\/resources\/store\/10001\/sitecontent\/webContentsBySearchTerm\/dress",
"resourceName": "sitecontent",
"webContentView": [
{
"identifier": "c878d441-9bcf-4fcb-85b0-279578468698.html",
"longDescription": "About the Dress Designer for Aurora",
"mimetype": "text\/html; charset=utf-8",
"name": "About the Dress Designer",
"shortDescription": "About the Dress Designer for Aurora",
"uniqueID": "HTML_10001_GenericStaticContentPageLayoutView?storeId=10001&pageId=1009&urlLangId=-1&urlRequestType=Base&langId=-1&catalogId=10001",
"url": "GenericStaticContentPageLayoutView?storeId=10001&pageId=1009&urlLangId=-1&urlRequestType=Base&langId=-1&catalogId=10001"
},
{
"identifier": "da52474c-4df6-4b24-9b06-673c30e53cf2.html",
"longDescription": "Clothing and Dress Style Guide for Aurora",
"mimetype": "text\/html; charset=utf-8",
"name": "Clothing and Dress Style Guide",
"shortDescription": "Clothing and Dress Style Guide for Aurora",
"uniqueID": "HTML_10001_GenericStaticContentPageLayoutView?storeId=10001&pageId=1010&urlLangId=-1&urlRequestType=Base&langId=-1&catalogId=10001",
"url": "GenericStaticContentPageLayoutView?storeId=10001&pageId=1010&urlLangId=-1&urlRequestType=Base&langId=-1&catalogId=10001"
},
{
"identifier": "9b688a6b-0b48-4afa-a8d1-b009350e8efc.html",
"longDescription": "Evening Sparkle Dress Collection Video for Aurora",
"mimetype": "text\/html; charset=utf-8",
"name": "Evening Sparkle Dress Collection Video",
"shortDescription": "Evening Sparkle Dress Collection Video for Aurora",
"uniqueID": "HTML_10001_GenericStaticContentPageLayoutView?storeId=10001&pageId=1011&urlLangId=-1&urlRequestType=Base&langId=-1&catalogId=10001",
"url": "GenericStaticContentPageLayoutView?storeId=10001&pageId=1011&urlLangId=-1&urlRequestType=Base&langId=-1&catalogId=10001"
},
{
"identifier": "58404f52-8dd1-4fb3-ba94-2592a8a88695.html",
"longDescription": "Site Map for Aurora",
"mimetype": "text\/html; charset=utf-8",
"name": "Site Map for Aurora",
"shortDescription": "Site Map for Aurora",
"uniqueID": "HTML_10001_GenericStaticContentPageLayoutView?storeId=10001&pageId=1007&urlLangId=-1&urlRequestType=Base&langId=-1&catalogId=10001",
"url": "GenericStaticContentPageLayoutView?storeId=10001&pageId=1007&urlLangId=-1&urlRequestType=Base&langId=-1&catalogId=10001"
}
]
}
Provides suggestions with type-ahead for search result page.
findWebContentSuggestions
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| limit | Limit. | query | string | false | false |
| count | The number of suggested keywords to be returned. The default value is 4. | query | string | false | false |
| termsSort | The sorting to be used in the returned result, "count" or "index". By default, it is "count". | query | string | 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. |
| 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. |
SiteContentHandler/webcontent.json
/search/resources/store/10001/sitecontent/webContentSuggestions
200
{
"suggestionView": [
{
"entry": [
{
"name": "About the Dress Designer",
"path": "GenericStaticContentPageLayoutView?storeId=10001&pageId=1009&urlLangId=-1&urlRequestType=Base&langId=-1&catalogId=10001"
},
{
"name": "Clothing and Dress Style Guide",
"path": "GenericStaticContentPageLayoutView?storeId=10001&pageId=1010&urlLangId=-1&urlRequestType=Base&langId=-1&catalogId=10001"
},
{
"name": "Contact Us for Aurora",
"path": "GenericStaticContentPageLayoutView?storeId=10001&pageId=1002&urlLangId=-1&urlRequestType=Base&langId=-1&catalogId=10001"
},
{
"name": "Corporate Contact Us for Aurora",
"path": "GenericStaticContentPageLayoutView?storeId=10001&pageId=1006&urlLangId=-1&urlRequestType=Base&langId=-1&catalogId=10001"
},
{
"name": "About Us for Aurora",
"path": "GenericStaticContentPageLayoutView?storeId=10001&pageId=1005&urlLangId=-1&urlRequestType=Base&langId=-1&catalogId=10001"
},
{
"name": "Evening Sparkle Dress Collection Video",
"path": "GenericStaticContentPageLayoutView?storeId=10001&pageId=1011&urlLangId=-1&urlRequestType=Base&langId=-1&catalogId=10001"
},
{
"name": "Help at Aurora",
"path": "GenericStaticContentPageLayoutView?storeId=10001&pageId=1001&urlLangId=-1&urlRequestType=Base&langId=-1&catalogId=10001"
},
{
"name": "Website Privacy Policy for Aurora",
"path": "GenericStaticContentPageLayoutView?storeId=10001&pageId=1004&urlLangId=-1&urlRequestType=Base&langId=-1&catalogId=10001"
},
{
"name": "Return Policy for Aurora",
"path": "GenericStaticContentPageLayoutView?storeId=10001&pageId=1003&urlLangId=-1&urlRequestType=Base&langId=-1&catalogId=10001"
},
{
"name": "Site Map for Aurora",
"path": "GenericStaticContentPageLayoutView?storeId=10001&pageId=1007&urlLangId=-1&urlRequestType=Base&langId=-1&catalogId=10001"
}
],
"identifier": "Articles"
}
]
}
| Name | Data Type | Required |
|---|---|---|
| suggestionView | SiteContentHandler/brand.json.suggestionView array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| entry | SiteContentHandler/brand.json.suggestionView.entry array | false |
| identifier | string | false |
| name | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| name | string | false |
| count | string | false |
| Name | Data Type | Required |
|---|---|---|
| suggestionView | SiteContentHandler/category.json.suggestionView array | false |
| Name | Data Type | Required |
|---|---|---|
| entry | SiteContentHandler/category.json.suggestionView.entry array | false |
| categorySeparator | string | false |
| identifier | string | false |
| Name | Data Type | Required |
|---|---|---|
| shortDescription | string | false |
| value | string | false |
| fullPath | string | false |
| image | string | false |
| name | string | false |
| Name | Data Type | Required |
|---|---|---|
| suggestionView | SiteContentHandler/keyword.json.suggestionView array | false |
| Name | Data Type | Required |
|---|---|---|
| entry | SiteContentHandler/keyword.json.suggestionView.entry array | false |
| identifier | string | false |
| Name | Data Type | Required |
|---|---|---|
| frequency | string | false |
| term | string | false |
| Name | Data Type | Required |
|---|---|---|
| suggestionView | SiteContentHandler/webcontent.json.suggestionView array | false |
| Name | Data Type | Required |
|---|---|---|
| entry | SiteContentHandler/webcontent.json.suggestionView.entry array | false |
| identifier | string | false |
| Name | Data Type | Required |
|---|---|---|
| path | string | false |
| name | string | false |