Feature Pack 7

Get matching products for a given search term

The following example shows how to get matching products for a given search term.

Request


http://localhost/search/resources/store/10001/productview/bySearchTerm/dress?langId=-1&catalogId=10001&currency=USD&responseFormat=json&pageSize=2&pageNumber=1

Response


{
	"catalogEntryView": [
		{
			"attributes": [
				{
					"comparable": true,
					"displayable": true,
					"facetable": false,
					"identifier": "occasion",
					"name": "Occasion",
					"searchable": false,
					"sequence": "1.00000",
					"storeDisplay": false,
					"uniqueID": "7000000000000000006",
					"usage": "Descriptive",
					"values": [
						{
							"identifier": "Cocktail & Evening",
							"sequence": "25.00000",
							"uniqueID": "7000000000000000037",
							"value": "Cocktail & Evening"
						}
					]
				},
				{
					"comparable": true,
					"displayable": true,
					"facetable": false,
					"identifier": "material",
					"name": "Material",
					"searchable": false,
					"sequence": "1.00000",
					"storeDisplay": false,
					"uniqueID": "7000000000000000005",
					"usage": "Descriptive",
					"values": [
						{
							"identifier": "Synthetic",
							"sequence": "21.00000",
							"uniqueID": "7000000000000000030",
							"value": "Synthetic"
						}
					]
				},
				{
					"comparable": true,
					"displayable": true,
					"facetable": false,
					"identifier": "length",
					"name": "Length",
					"searchable": false,
					"sequence": "1.00000",
					"storeDisplay": false,
					"uniqueID": "7000000000000000004",
					"usage": "Descriptive",
					"values": [
						{
							"identifier": "Short",
							"sequence": "20.00000",
							"uniqueID": "7000000000000000027",
							"value": "Short"
						}
					]
				},
				{
					"comparable": true,
					"displayable": true,
					"facetable": false,
					"identifier": "construction",
					"name": "Construction",
					"searchable": false,
					"sequence": "1.00000",
					"storeDisplay": false,
					"uniqueID": "7000000000000000003",
					"usage": "Descriptive",
					"values": [
						{
							"identifier": "Knit",
							"sequence": "19.00000",
							"uniqueID": "7000000000000000025",
							"value": "Knit"
						}
					]
				},
				{
					"comparable": true,
					"displayable": true,
					"facetable": false,
					"identifier": "swatchcolor",
					"name": "Color",
					"searchable": false,
					"sequence": "1.00000",
					"storeDisplay": false,
					"uniqueID": "7000000000000000002",
					"usage": "Defining",
					"values": [
						{
							"identifier": "0",
							"sequence": "0.00000",
							"uniqueID": "0",
							"value": "0"
						}
					]
				},
				{
					"comparable": true,
					"displayable": true,
					"facetable": false,
					"identifier": "swatchSize",
					"name": "Available Sizes",
					"searchable": false,
					"sequence": "2.00000",
					"storeDisplay": false,
					"uniqueID": "7000000000000000001",
					"usage": "Defining",
					"values": [
						{
							"identifier": "0",
							"sequence": "0.00000",
							"uniqueID": "0",
							"value": "0"
						}
					]
				}
			],
			"buyable": "true",
			"catalogEntryTypeCode": "ProductBean",
			"hasSingleSKU": false,
			"manufacturer": "Hermitage Collection",
			"name": "Hermitage Fit and Flare Dress",
			"parentCatalogGroupID": "10006",
			"partNumber": "AuroraWMDRS-1",
			"price": [
				{
					"currency": "USD",
					"description": "L",
					"usage": "Display",
					"value": "250.0"
				},
				{
					"currency": "USD",
					"description": "I",
					"usage": "Offer",
					"value": "100.0"
				}
			],
			"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/productview\/byId\/10001",
			"shortDescription": "Jewel-toned cocktail dress with fitted bodice and gently flared skirt",
			"storeID": "10001",
			"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/wcl000_dresses\/200x310\/wcl000_0028_a_red.jpg",
			"uniqueID": "10001"
		},
		{
			"attributes": [
				{
					"comparable": true,
					"displayable": true,
					"facetable": false,
					"identifier": "swatchcolor",
					"name": "Color",
					"searchable": false,
					"sequence": "1.00000",
					"storeDisplay": false,
					"uniqueID": "7000000000000000002",
					"usage": "Defining",
					"values": [
						{
							"identifier": "0",
							"sequence": "0.00000",
							"uniqueID": "0",
							"value": "0"
						}
					]
				},
				{
					"comparable": true,
					"displayable": true,
					"facetable": false,
					"identifier": "occasion",
					"name": "Occasion",
					"searchable": false,
					"sequence": "1.00000",
					"storeDisplay": false,
					"uniqueID": "7000000000000000006",
					"usage": "Descriptive",
					"values": [
						{
							"identifier": "Casual",
							"sequence": "26.00000",
							"uniqueID": "7000000000000000038",
							"value": "Casual"
						}
					]
				},
				{
					"comparable": true,
					"displayable": true,
					"facetable": false,
					"identifier": "material",
					"name": "Material",
					"searchable": false,
					"sequence": "1.00000",
					"storeDisplay": false,
					"uniqueID": "7000000000000000005",
					"usage": "Descriptive",
					"values": [
						{
							"identifier": "Georgette",
							"sequence": "22.00000",
							"uniqueID": "7000000000000000031",
							"value": "Georgette"
						}
					]
				},
				{
					"comparable": true,
					"displayable": true,
					"facetable": false,
					"identifier": "length",
					"name": "Length",
					"searchable": false,
					"sequence": "1.00000",
					"storeDisplay": false,
					"uniqueID": "7000000000000000004",
					"usage": "Descriptive",
					"values": [
						{
							"identifier": "Short",
							"sequence": "20.00000",
							"uniqueID": "7000000000000000027",
							"value": "Short"
						}
					]
				},
				{
					"comparable": true,
					"displayable": true,
					"facetable": false,
					"identifier": "construction",
					"name": "Construction",
					"searchable": false,
					"sequence": "1.00000",
					"storeDisplay": false,
					"uniqueID": "7000000000000000003",
					"usage": "Descriptive",
					"values": [
						{
							"identifier": "Knit",
							"sequence": "19.00000",
							"uniqueID": "7000000000000000025",
							"value": "Knit"
						}
					]
				},
				{
					"comparable": true,
					"displayable": true,
					"facetable": false,
					"identifier": "swatchSize",
					"name": "Available Sizes",
					"searchable": false,
					"sequence": "2.00000",
					"storeDisplay": false,
					"uniqueID": "7000000000000000001",
					"usage": "Defining",
					"values": [
						{
							"identifier": "0",
							"sequence": "0.00000",
							"uniqueID": "0",
							"value": "0"
						}
					]
				}
			],
			"buyable": "true",
			"catalogEntryTypeCode": "ProductBean",
			"hasSingleSKU": false,
			"manufacturer": "Versatil",
			"name": "Versatil Empire Waist Sundress",
			"parentCatalogGroupID": "10006",
			"partNumber": "AuroraWMDRS-2",
			"price": [
				{
					"currency": "USD",
					"description": "L",
					"usage": "Display",
					"value": "50.0"
				},
				{
					"currency": "USD",
					"description": "I",
					"usage": "Offer",
					"value": "50.0"
				}
			],
			"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/productview\/byId\/10002",
			"shortDescription": "Empire waist sundress with flower print and frilly sleeves",
			"storeID": "10001",
			"thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/wcl000_dresses\/200x310\/wcl000_0015_a_teal.jpg",
			"uniqueID": "10002"
		}
	],
	"facetView": [
		{
			"entry": [
				{
					"count": "13",
					"extendedData": {
						"uniqueId": "-100276117105103105328697108101110116105"
					},
					"label": "Luigi Valenti",
					"value": "mfName_ntk_cs%3A%22Luigi+Valenti%22"
				},
				{
					"count": "12",
					"extendedData": {
						"uniqueId": "-10026510898105110105"
					},
					"label": "Albini",
					"value": "mfName_ntk_cs%3A%22Albini%22"
				},
				{
					"count": "11",
					"extendedData": {
						"uniqueId": "-10027210111410910511697103101326711110810810199116105111110"
					},
					"label": "Hermitage Collection",
					"value": "mfName_ntk_cs%3A%22Hermitage+Collection%22"
				},
				{
					"count": "10",
					"extendedData": {
						"uniqueId": "-100271117115115111"
					},
					"label": "Gusso",
					"value": "mfName_ntk_cs%3A%22Gusso%22"
				},
				{
					"count": "10",
					"extendedData": {
						"uniqueId": "-10028610111411597116105108"
					},
					"label": "Versatil",
					"value": "mfName_ntk_cs%3A%22Versatil%22"
				},
				{
					"count": "3",
					"extendedData": {
						"uniqueId": "-100276101111"
					},
					"label": "Leo",
					"value": "mfName_ntk_cs%3A%22Leo%22"
				},
				{
					"count": "2",
					"extendedData": {
						"uniqueId": "-10026611111411597116105"
					},
					"label": "Borsati",
					"value": "mfName_ntk_cs%3A%22Borsati%22"
				},
				{
					"count": "1",
					"extendedData": {
						"uniqueId": "-100277101115111"
					},
					"label": "Meso",
					"value": "mfName_ntk_cs%3A%22Meso%22"
				}
			],
			"extendedData": {
				"allValuesReturned": "true",
				"allowMultipleValueSelection": "false",
				"displaySequence": "0.0",
				"displayable": "1",
				"facet_id": "-1000",
				"fdesc": "The manufacturer",
				"fname": "Brand",
				"groupId": "0",
				"group_id": "0",
				"keyword_search": "1",
				"max_display": "20",
				"maximumValuesToDisplay": "20",
				"propertyname": "facet",
				"propertyvalue": "mfName_ntk_cs",
				"selection": "0",
				"sortorder": "0",
				"srchattr_id": "-1002",
				"srchattridentifier": "_cat.ManufacturerName",
				"storeent_id": "0",
				"zero_display": "0"
			},
			"name": "ManufacturerName",
			"value": "mfName_ntk_cs"
		},
		{
			"entry": [
				{
					"count": "62",
					"extendedData": {
						"uniqueId": "10001"
					},
					"label": "Apparel",
					"value": "10001"
				},
				{
					"count": "42",
					"extendedData": {
						"parentIds": "10001",
						"uniqueId": "10003"
					},
					"label": "Women",
					"value": "10003"
				},
				{
					"count": "39",
					"extendedData": {
						"parentIds": "10001_10003",
						"uniqueId": "10006"
					},
					"label": "Dresses",
					"value": "10006"
				},
				{
					"count": "13",
					"extendedData": {
						"parentIds": "10001",
						"uniqueId": "10002"
					},
					"label": "Men",
					"value": "10002"
				},
				{
					"count": "7",
					"extendedData": {
						"parentIds": "10001",
						"uniqueId": "10005"
					},
					"label": "Girls",
					"value": "10005"
				},
				{
					"count": "7",
					"extendedData": {
						"parentIds": "10001_10005",
						"uniqueId": "10022"
					},
					"label": "Skirts",
					"value": "10022"
				},
				{
					"count": "5",
					"extendedData": {
						"parentIds": "10001_10002",
						"uniqueId": "10015"
					},
					"label": "Shirts",
					"value": "10015"
				},
				{
					"count": "4",
					"extendedData": {
						"parentIds": "10001_10002",
						"uniqueId": "10019"
					},
					"label": "Shoes",
					"value": "10019"
				},
				{
					"count": "3",
					"extendedData": {
						"parentIds": "10001_10003",
						"uniqueId": "10008"
					},
					"label": "Sweaters",
					"value": "10008"
				},
				{
					"count": "2",
					"extendedData": {
						"parentIds": "10001_10002",
						"uniqueId": "10017"
					},
					"label": "Pants",
					"value": "10017"
				},
				{
					"count": "2",
					"extendedData": {
						"parentIds": "10001_10002",
						"uniqueId": "10018"
					},
					"label": "Accessories",
					"value": "10018"
				}
			],
			"extendedData": {
				"allValuesReturned": "true",
				"allowMultipleValueSelection": "false",
				"displaySequence": "0.0",
				"displayable": "1",
				"facet_id": "-1001",
				"fdesc": "The category",
				"fname": "Category",
				"groupId": "0",
				"group_id": "0",
				"keyword_search": "1",
				"max_display": "20",
				"maximumValuesToDisplay": "20",
				"propertyname": "facet",
				"propertyvalue": "parentCatgroup_id_search",
				"selection": "0",
				"sortorder": "0",
				"srchattr_id": "-1013",
				"srchattridentifier": "_cat.ParentCatalogGroup",
				"storeent_id": "0",
				"zero_display": "0"
			},
			"name": "ParentCatalogGroup",
			"value": "parentCatgroup_id_search"
		},
		{
			"entry": [
				{
					"count": 51,
					"extendedData": {
						"uniqueId": "4012342324948481253249484841"
					},
					"label": "({* 100} 100)",
					"value": "price_USD%3A%28%7B*+100%7D+100%29"
				},
				{
					"count": 2,
					"extendedData": {
						"uniqueId": "40123494848325048481253250484841"
					},
					"label": "({100 200} 200)",
					"value": "price_USD%3A%28%7B100+200%7D+200%29"
				},
				{
					"count": 9,
					"extendedData": {
						"uniqueId": "40123504848325148481253251484841"
					},
					"label": "({200 300} 300)",
					"value": "price_USD%3A%28%7B200+300%7D+300%29"
				},
				{
					"count": 0,
					"extendedData": {
						"uniqueId": "40123514848325248481253252484841"
					},
					"label": "({300 400} 400)",
					"value": "price_USD%3A%28%7B300+400%7D+400%29"
				},
				{
					"count": 0,
					"extendedData": {
						"uniqueId": "40123524848325348481253253484841"
					},
					"label": "({400 500} 500)",
					"value": "price_USD%3A%28%7B400+500%7D+500%29"
				},
				{
					"count": 0,
					"extendedData": {
						"uniqueId": "40123534848324212541"
					},
					"label": "({500 *})",
					"value": "price_USD%3A%28%7B500+*%7D%29"
				}
			],
			"name": "OfferPrice_USD",
			"value": "price_USD"
		}
	],
	"metaData": {
		"price": "1"
	},
	"recordSetComplete": "false",
	"recordSetCount": 2,
	"recordSetStartNumber": 0,
	"recordSetTotal": 62,
	"resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/productview\/bySearchTerm\/dress?langId=-1&catalogId=10001&currency=USD&responseFormat=json&pageSize=2&pageNumber=1",
	"resourceName": "productview"
}