This class provides RESTful services to get the ProductView details.
com.ibm.commerce.rest.search.handler.v2_0.ProductViewHandler
HTTP Method | Path | Description |
---|---|---|
GET | /store/{storeId}/productview/{partNumber} | Gets product details based on the part number. |
GET | /store/{storeId}/productview/{byPartNumbers} | Gets multiple products by part number. |
GET | /store/{storeId}/productview/byCategory/{categoryId} | By default, this API returns all products under the category and subcategories by deep search. It does not only return products in the current category. There is no control over the limit of each subcategory under the category facet. |
GET | /store/{storeId}/productview/byId/{productId} | Gets product details based on the product ID. |
GET | /store/{storeId}/productview/byIds | Gets product details based on the product ID. |
GET | /store/{storeId}/productview/bySearchTerm/{searchTerm} | Gets product details based on a search term. |
Gets products by part number.
findProductByPartNumber
false
true
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
partNumber | The product part number. | path | string | true | N/A |
associationType | The type of the merchandising association to be returned. | query | string | false | true |
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 |
attachementFilter | The attachment filter. | 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. |
ProductViewHandler/productdetails.json
/search/resources/store/10001/productview/AuroraWMDRS-692
200
{ "catalogEntryView": [ { "attributes": [ { "comparable": true, "displayable": true, "facetable": false, "identifier": "swatchcolor", "name": "Color", "searchable": false, "sequence": "1.00000", "storeDisplay": false, "uniqueID": "7000000000000000002", "usage": "Defining", "values": [ { "identifier": "Blue", "image1": "images\/catalog\/apparel\/women\/Swatches\/swatch_blue.png", "image1path": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/Swatches\/swatch_blue.png", "sequence": "6.00000", "uniqueID": "7000000000000000012", "value": "Blue" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "swatchSize", "name": "Available Sizes", "searchable": false, "sequence": "1.00000", "storeDisplay": false, "uniqueID": "7000000000000000001", "usage": "Defining", "values": [ { "identifier": "XS", "image1": "images\/catalog\/apparel\/women\/Swatches\/swatch_size\/size_xs_enabled.png", "image1path": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/Swatches\/swatch_size\/size_xs_enabled.png", "sequence": "1.00000", "uniqueID": "7000000000000000004", "value": "XS" } ] } ], "buyable": "true", "catalogEntryTypeCode": "ItemBean", "disallowRecurringOrder": "1", "fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/wcl000_dresses\/646x1000\/wcl000_0016_a_blue.jpg", "hasSingleSKU": false, "longDescription": "Shapely one shoulder striped dress designed to give the impression of different types of crossover, be it on the road, in your personal life, or in your profession.", "manufacturer": "Luigi Valenti", "name": "Luigi Valenti Striped Pencil Dress", "parentCatalogEntryID": "10038", "parentCatalogGroupID": [ "10001_10006", "10052_10006" ], "partNumber": "AuroraWMDRS-692", "price": [ { "currency": "USD", "description": "L", "usage": "Display", "value": "50.0" }, { "currency": "USD", "description": "I", "usage": "Offer", "value": "50.0" } ], "resourceId": "https:\/\/localhost\/search\/resources\/store\/10001\/productview\/byId\/10706", "shortDescription": "One shoulder pencil evening dress with stripes", "storeID": "10001", "subscriptionTypeCode": "NONE", "thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/wcl000_dresses\/200x310\/wcl000_0016_a_blue.jpg", "uniqueID": "10706" } ], "metaData": { "price": "1" }, "recordSetComplete": "true", "recordSetCount": 1, "recordSetStartNumber": 0, "recordSetTotal": 1, "recordSetTotalMatches": 1, "resourceId": "https:\/\/localhost\/search\/resources\/store\/10001\/productview\/AuroraWMDRS-692", "resourceName": "productview" }
Gets products by part number.
findProductByPartNumber
false
true
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
partNumber | The product part numbers. | query | string[] , multiple parameters (partNumber=aaa&partNumber=bbb) | true | N/A |
associationType | The type of the merchandising association to be returned. | query | string | false | true |
catalogId | The catalog identifier. If none is specified, the store default catalog shall be used. | query | string | false | false |
currency | The currency code to use. Example usage : currency=USD. If no currency code is specified, the store default currency shall be used. | query | string | false | false |
langId | Language identifier. If not specified, the "locale" parameter will be used. If "locale" isn't specified, then the store default language shall be used. | query | string | false | false |
contractId | The contractId. | query | string | false | false |
checkEntitlement | Option to force an entitlement check. | query | boolean | false | false |
attachementFilter | The attachment filter. | 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. |
ProductViewHandler/productdetails.json
By default, this API returns all products under the category and subcategories by deep search. It does not only return products in the current category. There is no control over the limit of each subcategory under the category facet.
findProductsByCategory
false
true
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
categoryId | The category identifier. | path | string | true | N/A |
associationType | The type of the merchandising association to be returned. | query | string | false | true |
facet | The selected facets. | query | string | false | true |
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 |
advancedFacetList | The advanced facet list. | query | string | false | false |
filterFacet | The filter facet. | query | string | false | false |
filterTerm | The filter term. | query | string | false | false |
manufacturer | The manufacturer name. | query | string | false | false |
minPrice | The minimum price. Based on the selected currency. | query | string | false | false |
maxPrice | The maximum price. Based on the selected currency.mc | query | string | false | false |
orderBy | The field name to use when ordering the results. | 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 |
searchSource | The search source. The default is "N" for shallow search navigation. All other values will result in expanded search in sub-categories. | query | string | false | false |
priceMode | The price mode. | query | string | false | false |
checkEntitlement | Option to force an entitlement check. | query | boolean | false | false |
attachementFilter | The attachment filter. | 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. |
ProductViewHandler/productsbycategory.json
/search/resources/store/10001/productview/byCategory/10043?currency=USD&profileName=IBM_BreadCrumbByCategoryUniqueId&catalogId=10052&responseFormat=json&langId=-1&contractId=10001
200
{ "DocumentList": [ ], "breadCrumbTrailEntryView": [ { "label": "Home & Furnishing", "type_": "FACET_ENTRY_CATEGORY", "value": "10041" }, { "label": "Furniture", "type_": "FACET_ENTRY_CATEGORY", "value": "10043" } ] }
Gets product details based on the product ID.
findProductById
false
true
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
productId | The product identifier. | path | string | true | N/A |
associationType | The type of the merchandising association to be returned. | query | string | false | true |
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 |
attachementFilter | The attachment filter. | 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. |
ProductViewHandler/productdetails.json
/search/resources/store/10001/productview/byId/12837?currency=USD&catalogId=10052&responseFormat=json&langId=-1&contractId=10001
200
{ "catalogEntryView": [ { "attributes": [ { "comparable": true, "displayable": true, "facetable": false, "identifier": "FurnitureType", "name": "Type", "searchable": false, "sequence": "0.00000", "storeDisplay": false, "uniqueID": "7000000000000000114", "usage": "Defining", "values": [ { "identifier": "Sofa", "sequence": "1.00000", "uniqueID": "7000000000000002000", "value": "Sofa" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "FurnitureColor", "name": "Color", "searchable": false, "sequence": "1.00000", "storeDisplay": false, "uniqueID": "7000000000000000115", "usage": "Defining", "values": [ { "identifier": "Black", "sequence": "1.00000", "uniqueID": "7000000000000002008", "value": "Black" } ] } ], "buyable": "true", "catalogEntryTypeCode": "ItemBean", "disallowRecurringOrder": "1", "fullImage": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/hfu032_furniture\/646x1000\/hfu032_3201.jpg", "hasSingleSKU": false, "longDescription": "A sofa set with a modern design from StyleHome that is perfect for you living room. Made from 100% leather and memory foam its as comfortable as it looks.", "manufacturer": "StyleHome", "name": "StyleHome Modern Rimmed 3 Piece Sofa Set", "parentCatalogEntryID": "12836", "parentCatalogGroupID": [ "10001_10043", "10052_10043" ], "partNumber": "HFU032_320101", "price": [ { "currency": "USD", "description": "L", "usage": "Display", "value": "2500.0" }, { "currency": "USD", "description": "I", "usage": "Offer", "value": "2325.0" } ], "resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/productview\/byId\/12837", "shortDescription": "3 piece sofa set with a very modern design.", "storeID": "10001", "subscriptionTypeCode": "NONE", "thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/hfu032_furniture\/200x310\/hfu032_3201.jpg", "uniqueID": "12837" } ], "metaData": { "price": "1" }, "recordSetComplete": "true", "recordSetCount": 1, "recordSetStartNumber": 0, "recordSetTotal": 1, "recordSetTotalMatches": 1, "resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/productview\/byId\/12837?currency=USD&catalogId=10052&responseFormat=json&langId=-1&contractId=10001", "resourceName": "productview" }
Gets product details based on the product ID.
findProductsByIds
false
true
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
id | The product identifiers. | query | string | false | true |
associationType | The type of the merchandising association to be returned. | query | string | false | true |
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 |
attachementFilter | The attachment filter. | 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. |
ProductViewHandler/productdetails.json
/search/resources/store/10001/productview/byIds?currency=USD&profileName=IBM_findProductByIds_Summary&catalogId=10052&responseFormat=json&langId=-1&id=12894&id=12880&id=12868&id=12860&contractId=10001
200
{ "catalogEntryView": [ { "attributes": [ { "comparable": true, "displayable": true, "facetable": false, "identifier": "FurnitureColor", "name": "Color", "searchable": false, "sequence": "0.00000", "storeDisplay": false, "uniqueID": "7000000000000000115", "usage": "Defining", "values": [ { "identifier": "0", "sequence": "0.00000", "uniqueID": "0", "value": "0" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "Style", "name": "Style", "searchable": false, "sequence": "0.00000", "storeDisplay": false, "uniqueID": "7000000000000000010", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3213", "sequence": "9.00000", "uniqueID": "7000000000000002100", "value": "Work table" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "FurnitureType", "name": "Type", "searchable": false, "sequence": "1.00000", "storeDisplay": false, "uniqueID": "7000000000000000114", "usage": "Defining", "values": [ { "identifier": "0", "sequence": "0.00000", "uniqueID": "0", "value": "0" } ] }, { "comparable": false, "displayable": true, "facetable": false, "identifier": "Finish", "name": "Finish", "searchable": false, "sequence": "1.00000", "storeDisplay": false, "uniqueID": "7000000000000000116", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3213", "sequence": "6.00000", "uniqueID": "7000000000000002047", "value": "Rough" } ] }, { "comparable": false, "displayable": true, "facetable": false, "identifier": "Assembly", "name": "Assembly", "searchable": false, "sequence": "2.00000", "storeDisplay": false, "uniqueID": "7000000000000000117", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3213", "sequence": "1.00000", "uniqueID": "7000000000000002125", "value": "Pre-built" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "Material", "name": "Material", "searchable": false, "sequence": "3.00000", "storeDisplay": false, "uniqueID": "7000000000000000009", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3213", "sequence": "7.00000", "uniqueID": "7000000000000002062", "value": "Hard wood" } ] } ], "buyable": "true", "catalogEntryTypeCode": "ProductBean", "disallowRecurringOrder": "1", "hasSingleSKU": true, "manufacturer": "Stonehenge", "name": "Stonehenge WorkMan Working Table", "parentCatalogGroupID": [ "10001_10043", "10052_10043" ], "partNumber": "HFU032_3213", "price": [ { "currency": "USD", "description": "L", "usage": "Display", "value": "110.0" }, { "currency": "USD", "description": "I", "usage": "Offer", "value": "102.0" } ], "resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/productview\/byId\/12860", "shortDescription": "Working table made to take damage.", "singleSKUCatalogEntryID": "12861", "storeID": "10001", "subscriptionTypeCode": "NONE", "thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/hfu032_furniture\/200x310\/hfu032_3213.jpg", "uniqueID": "12860" }, { "attributes": [ { "comparable": true, "displayable": true, "facetable": false, "identifier": "FurnitureColor", "name": "Color", "searchable": false, "sequence": "0.00000", "storeDisplay": false, "uniqueID": "7000000000000000115", "usage": "Defining", "values": [ { "identifier": "0", "sequence": "0.00000", "uniqueID": "0", "value": "0" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "Style", "name": "Style", "searchable": false, "sequence": "0.00000", "storeDisplay": false, "uniqueID": "7000000000000000010", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3217", "sequence": "12.00000", "uniqueID": "7000000000000002104", "value": "Kids bed" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "FurnitureType", "name": "Type", "searchable": false, "sequence": "1.00000", "storeDisplay": false, "uniqueID": "7000000000000000114", "usage": "Defining", "values": [ { "identifier": "0", "sequence": "0.00000", "uniqueID": "0", "value": "0" } ] }, { "comparable": false, "displayable": true, "facetable": false, "identifier": "Finish", "name": "Finish", "searchable": false, "sequence": "1.00000", "storeDisplay": false, "uniqueID": "7000000000000000116", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3217", "sequence": "2.00000", "uniqueID": "7000000000000002028", "value": "Smooth" } ] }, { "comparable": false, "displayable": true, "facetable": false, "identifier": "Assembly", "name": "Assembly", "searchable": false, "sequence": "2.00000", "storeDisplay": false, "uniqueID": "7000000000000000117", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3217", "sequence": "3.00000", "uniqueID": "7000000000000002139", "value": "Self-assembly" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "Material", "name": "Material", "searchable": false, "sequence": "3.00000", "storeDisplay": false, "uniqueID": "7000000000000000009", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3217", "sequence": "5.00000", "uniqueID": "7000000000000002060", "value": "Oak wood" } ] } ], "buyable": "true", "catalogEntryTypeCode": "ProductBean", "disallowRecurringOrder": "1", "hasSingleSKU": true, "manufacturer": "SleepyHead", "name": "SleepyHead Storytime Double Bed", "parentCatalogGroupID": [ "10001_10043", "10052_10043" ], "partNumber": "HFU032_3217", "price": [ { "currency": "USD", "description": "L", "usage": "Display", "value": "450.0" }, { "currency": "USD", "description": "I", "usage": "Offer", "value": "435.0" } ], "resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/productview\/byId\/12868", "shortDescription": "Kids low double bed made of wood.", "singleSKUCatalogEntryID": "12869", "storeID": "10001", "subscriptionTypeCode": "NONE", "thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/hfu032_furniture\/200x310\/hfu032_3217.jpg", "uniqueID": "12868" }, { "attributes": [ { "comparable": true, "displayable": true, "facetable": false, "identifier": "FurnitureColor", "name": "Color", "searchable": false, "sequence": "0.00000", "storeDisplay": false, "uniqueID": "7000000000000000115", "usage": "Defining", "values": [ { "identifier": "0", "sequence": "0.00000", "uniqueID": "0", "value": "0" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "Style", "name": "Style", "searchable": false, "sequence": "0.00000", "storeDisplay": false, "uniqueID": "7000000000000000010", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3223", "sequence": "3.00000", "uniqueID": "7000000000000002093", "value": "Contemporary" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "FurnitureType", "name": "Type", "searchable": false, "sequence": "1.00000", "storeDisplay": false, "uniqueID": "7000000000000000114", "usage": "Defining", "values": [ { "identifier": "0", "sequence": "0.00000", "uniqueID": "0", "value": "0" } ] }, { "comparable": false, "displayable": true, "facetable": false, "identifier": "Finish", "name": "Finish", "searchable": false, "sequence": "1.00000", "storeDisplay": false, "uniqueID": "7000000000000000116", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3223", "sequence": "2.00000", "uniqueID": "7000000000000002034", "value": "Smooth" } ] }, { "comparable": false, "displayable": true, "facetable": false, "identifier": "Assembly", "name": "Assembly", "searchable": false, "sequence": "2.00000", "storeDisplay": false, "uniqueID": "7000000000000000117", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3223", "sequence": "3.00000", "uniqueID": "7000000000000002145", "value": "Self-assembly" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "Material", "name": "Material", "searchable": false, "sequence": "3.00000", "storeDisplay": false, "uniqueID": "7000000000000000009", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3223", "sequence": "11.00000", "uniqueID": "7000000000000002072", "value": "Birch wood" } ] } ], "buyable": "true", "catalogEntryTypeCode": "ProductBean", "disallowRecurringOrder": "1", "hasSingleSKU": true, "manufacturer": "StyleHome", "name": "StyleHome Intree Chest of drawer", "parentCatalogGroupID": [ "10001_10043", "10052_10043" ], "partNumber": "HFU032_3223", "price": [ { "currency": "USD", "description": "L", "usage": "Display", "value": "245.0" }, { "currency": "USD", "description": "I", "usage": "Offer", "value": "245.0" } ], "resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/productview\/byId\/12880", "shortDescription": "Chest of drawer with 4 drawer made of Birch wood.", "singleSKUCatalogEntryID": "12881", "storeID": "10001", "subscriptionTypeCode": "NONE", "thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/hfu032_furniture\/200x310\/hfu032_3223.jpg", "uniqueID": "12880" }, { "attributes": [ { "comparable": true, "displayable": true, "facetable": false, "identifier": "FurnitureColor", "name": "Color", "searchable": false, "sequence": "0.00000", "storeDisplay": false, "uniqueID": "7000000000000000115", "usage": "Defining", "values": [ { "identifier": "0", "sequence": "0.00000", "uniqueID": "0", "value": "0" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "Style", "name": "Style", "searchable": false, "sequence": "0.00000", "storeDisplay": false, "uniqueID": "7000000000000000010", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3230", "sequence": "18.00000", "uniqueID": "7000000000000002112", "value": "Modern contemporary" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "FurnitureType", "name": "Type", "searchable": false, "sequence": "1.00000", "storeDisplay": false, "uniqueID": "7000000000000000114", "usage": "Defining", "values": [ { "identifier": "0", "sequence": "0.00000", "uniqueID": "0", "value": "0" } ] }, { "comparable": false, "displayable": true, "facetable": false, "identifier": "Finish", "name": "Finish", "searchable": false, "sequence": "1.00000", "storeDisplay": false, "uniqueID": "7000000000000000116", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3230", "sequence": "2.00000", "uniqueID": "7000000000000002035", "value": "Smooth" } ] }, { "comparable": false, "displayable": true, "facetable": false, "identifier": "Assembly", "name": "Assembly", "searchable": false, "sequence": "2.00000", "storeDisplay": false, "uniqueID": "7000000000000000117", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3230", "sequence": "1.00000", "uniqueID": "7000000000000002132", "value": "Pre-built" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "Material", "name": "Material", "searchable": false, "sequence": "3.00000", "storeDisplay": false, "uniqueID": "7000000000000000009", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3230", "sequence": "16.00000", "uniqueID": "7000000000000002078", "value": "Wood and steel" } ] } ], "buyable": "true", "catalogEntryTypeCode": "ProductBean", "disallowRecurringOrder": "1", "hasSingleSKU": true, "manufacturer": "Stonehenge", "name": "Stongehenge Bolds Dining chair", "parentCatalogGroupID": [ "10001_10043", "10052_10043" ], "partNumber": "HFU032_3230", "price": [ { "currency": "USD", "description": "L", "usage": "Display", "value": "80.0" }, { "currency": "USD", "description": "I", "usage": "Offer", "value": "72.0" } ], "resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/productview\/byId\/12894", "shortDescription": "Dining chair with a bold design.", "singleSKUCatalogEntryID": "12895", "storeID": "10001", "subscriptionTypeCode": "NONE", "thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/hfu032_furniture\/200x310\/hfu032_3230.jpg", "uniqueID": "12894" } ], "metaData": { "price": "1" }, "recordSetComplete": "true", "recordSetCount": 4, "recordSetStartNumber": 0, "recordSetTotal": 4, "recordSetTotalMatches": 4, "resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/productview\/byIds?currency=USD&profileName=IBM_findProductByIds_Summary&catalogId=10052&responseFormat=json&langId=-1&id=12894&id=12880&id=12868&id=12860&contractId=10001", "resourceName": "productview" }
Gets product details based on a search term.
findProductsBySearchTerm
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 |
associationType | The type of the merchandising association to be returned. | query | string | false | true |
facet | The selected facets. | query | string | false | true |
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 |
advancedFacetList | The advanced facet list. | query | string | false | false |
filterFacet | The filter facet. | query | string | false | false |
filterTerm | The filter term. | query | string | false | false |
manufacturer | The manufacturer name. | query | string | false | false |
minPrice | The minimum price. Based on the selected currency. | query | string | false | false |
maxPrice | The maximum price. Based on the selected currency.mc | query | string | false | false |
orderBy | The field name to use when ordering the results. | 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 |
searchSource | The search source. The default is "N" for shallow search navigation. All other values will result in expanded search in sub-categories. | query | string | false | false |
priceMode | The price mode. | query | string | false | false |
checkEntitlement | Option to force an entitlement check. | query | boolean | false | false |
attachementFilter | The attachment filter. | query | string | false | false |
categoryId | The category identifier. | query | string | false | false |
searchTerm | The optional searchTerm parameter that will replace the {searchTerm} value in the context path parameter. It is used to avoid potential limitation of the special characters as being part of the context path. | query | string | false | false |
intentSearchTerm | The value of the parameter is the term that the user intends to search. Characters are not escaped for the search engine. | query | string | false | false |
originalSearchTerm | The value of the parameter is the term that the user intends to search. Characters are escaped for the search engine. | query | string | false | false |
filterType | Used for advanced search option. 0 - search for any match, 1 - search for exact match, 2 - search for all matches | query | string | false | false |
physicalStoreIds | The list of physical store identifiers. | query | string | false | true |
landingPage | The landing page information will be returned if it is available and the value is true. By default, the value is false. | query | boolean | 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. |
ProductViewHandler/productsbysearchterm.json
/search/resources/store/10001/productview/bySearchTerm/*?searchType=1000&searchSource=Q&filterTerm=&maxPrice=&orderBy=&langId=-1&contractId=10001&physicalStoreIds=10039%2C10003&pageSize=12&intentSearchTerm=sofa&manufacturer=¤cy=USD&filterType=&advancedFacetList=&profileName=IBM_findProductsBySearchTerm&searchTerm=sofa&catalogId=10052&minPrice=&pageNumber=1&responseFormat=json&categoryId=&filterFacet=
200
{ "catalogEntryView": [ { "attributes": [ { "comparable": true, "displayable": true, "facetable": false, "identifier": "FurnitureColor", "name": "Color", "searchable": false, "sequence": "0.00000", "storeDisplay": false, "uniqueID": "7000000000000000115", "usage": "Defining", "values": [ { "identifier": "0", "sequence": "0.00000", "uniqueID": "0", "value": "0" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "Style", "name": "Style", "searchable": false, "sequence": "0.00000", "storeDisplay": false, "uniqueID": "7000000000000000010", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3206", "sequence": "4.00000", "uniqueID": "7000000000000002094", "value": "Lounge" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "FurnitureType", "name": "Type", "searchable": false, "sequence": "1.00000", "storeDisplay": false, "uniqueID": "7000000000000000114", "usage": "Defining", "values": [ { "identifier": "0", "sequence": "0.00000", "uniqueID": "0", "value": "0" } ] }, { "comparable": false, "displayable": true, "facetable": false, "identifier": "Finish", "name": "Finish", "searchable": false, "sequence": "1.00000", "storeDisplay": false, "uniqueID": "7000000000000000116", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3206", "sequence": "2.00000", "uniqueID": "7000000000000002020", "value": "Smooth" } ] }, { "comparable": false, "displayable": true, "facetable": false, "identifier": "Assembly", "name": "Assembly", "searchable": false, "sequence": "2.00000", "storeDisplay": false, "uniqueID": "7000000000000000117", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3206", "sequence": "1.00000", "uniqueID": "7000000000000002119", "value": "Pre-built" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "Material", "name": "Material", "searchable": false, "sequence": "3.00000", "storeDisplay": false, "uniqueID": "7000000000000000009", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3206", "sequence": "3.00000", "uniqueID": "7000000000000002056", "value": "Synthetic" } ] } ], "buyable": "true", "catalogEntryTypeCode": "ProductBean", "hasSingleSKU": true, "manufacturer": "Supreme", "name": "Supreme LoungeStyle Double Sofa", "parentCatalogGroupID": [ "10001_10043", "10052_10043" ], "partNumber": "HFU032_3206", "price": [ { "currency": "USD", "description": "L", "usage": "Display", "value": "230.0" }, { "currency": "USD", "description": "I", "usage": "Offer", "value": "209.0" } ], "resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/productview\/byId\/12846", "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" }, { "attributes": [ { "comparable": true, "displayable": true, "facetable": false, "identifier": "FurnitureColor", "name": "Color", "searchable": false, "sequence": "0.00000", "storeDisplay": false, "uniqueID": "7000000000000000115", "usage": "Defining", "values": [ { "identifier": "0", "sequence": "0.00000", "uniqueID": "0", "value": "0" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "Style", "name": "Style", "searchable": false, "sequence": "0.00000", "storeDisplay": false, "uniqueID": "7000000000000000010", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3203", "sequence": "2.00000", "uniqueID": "7000000000000002086", "value": "Office" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "FurnitureType", "name": "Type", "searchable": false, "sequence": "1.00000", "storeDisplay": false, "uniqueID": "7000000000000000114", "usage": "Defining", "values": [ { "identifier": "0", "sequence": "0.00000", "uniqueID": "0", "value": "0" } ] }, { "comparable": false, "displayable": true, "facetable": false, "identifier": "Finish", "name": "Finish", "searchable": false, "sequence": "1.00000", "storeDisplay": false, "uniqueID": "7000000000000000116", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3203", "sequence": "3.00000", "uniqueID": "7000000000000002039", "value": "Matte" } ] }, { "comparable": false, "displayable": true, "facetable": false, "identifier": "Assembly", "name": "Assembly", "searchable": false, "sequence": "2.00000", "storeDisplay": false, "uniqueID": "7000000000000000117", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3203", "sequence": "1.00000", "uniqueID": "7000000000000002116", "value": "Pre-built" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "Material", "name": "Material", "searchable": false, "sequence": "3.00000", "storeDisplay": false, "uniqueID": "7000000000000000009", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3203", "sequence": "3.00000", "uniqueID": "7000000000000002054", "value": "Synthetic" } ] } ], "buyable": "true", "catalogEntryTypeCode": "ProductBean", "hasSingleSKU": true, "manufacturer": "StyleHome", "name": "StyleHome InOffice Double Sofa", "parentCatalogGroupID": [ "10001_10043", "10052_10043" ], "partNumber": "HFU032_3203", "price": [ { "currency": "USD", "description": "L", "usage": "Display", "value": "300.0" }, { "currency": "USD", "description": "I", "usage": "Offer", "value": "289.0" } ], "resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/productview\/byId\/12840", "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" }, { "attributes": [ { "comparable": true, "displayable": true, "facetable": false, "identifier": "FurnitureColor", "name": "Color", "searchable": false, "sequence": "0.00000", "storeDisplay": false, "uniqueID": "7000000000000000115", "usage": "Defining", "values": [ { "identifier": "0", "sequence": "0.00000", "uniqueID": "0", "value": "0" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "Style", "name": "Style", "searchable": false, "sequence": "0.00000", "storeDisplay": false, "uniqueID": "7000000000000000010", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3204", "sequence": "2.00000", "uniqueID": "7000000000000002087", "value": "Office" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "FurnitureType", "name": "Type", "searchable": false, "sequence": "1.00000", "storeDisplay": false, "uniqueID": "7000000000000000114", "usage": "Defining", "values": [ { "identifier": "0", "sequence": "0.00000", "uniqueID": "0", "value": "0" } ] }, { "comparable": false, "displayable": true, "facetable": false, "identifier": "Finish", "name": "Finish", "searchable": false, "sequence": "1.00000", "storeDisplay": false, "uniqueID": "7000000000000000116", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3204", "sequence": "3.00000", "uniqueID": "7000000000000002040", "value": "Matte" } ] }, { "comparable": false, "displayable": true, "facetable": false, "identifier": "Assembly", "name": "Assembly", "searchable": false, "sequence": "2.00000", "storeDisplay": false, "uniqueID": "7000000000000000117", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3204", "sequence": "1.00000", "uniqueID": "7000000000000002117", "value": "Pre-built" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "Material", "name": "Material", "searchable": false, "sequence": "3.00000", "storeDisplay": false, "uniqueID": "7000000000000000009", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3204", "sequence": "3.00000", "uniqueID": "7000000000000002055", "value": "Synthetic" } ] } ], "buyable": "true", "catalogEntryTypeCode": "ProductBean", "hasSingleSKU": true, "manufacturer": "StyleHome", "name": "StyleHome InOffice Single Sofa", "parentCatalogGroupID": [ "10001_10043", "10052_10043" ], "partNumber": "HFU032_3204", "price": [ { "currency": "USD", "description": "L", "usage": "Display", "value": "200.0" }, { "currency": "USD", "description": "I", "usage": "Offer", "value": "195.0" } ], "resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/productview\/byId\/12842", "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" }, { "attributes": [ { "comparable": true, "displayable": true, "facetable": false, "identifier": "FurnitureColor", "name": "Color", "searchable": false, "sequence": "0.00000", "storeDisplay": false, "uniqueID": "7000000000000000115", "usage": "Defining", "values": [ { "identifier": "0", "sequence": "0.00000", "uniqueID": "0", "value": "0" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "Style", "name": "Style", "searchable": false, "sequence": "0.00000", "storeDisplay": false, "uniqueID": "7000000000000000010", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3211", "sequence": "8.00000", "uniqueID": "7000000000000002098", "value": "Lazy sofa" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "FurnitureType", "name": "Type", "searchable": false, "sequence": "1.00000", "storeDisplay": false, "uniqueID": "7000000000000000114", "usage": "Defining", "values": [ { "identifier": "0", "sequence": "0.00000", "uniqueID": "0", "value": "0" } ] }, { "comparable": false, "displayable": true, "facetable": false, "identifier": "Finish", "name": "Finish", "searchable": false, "sequence": "1.00000", "storeDisplay": false, "uniqueID": "7000000000000000116", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3211", "sequence": "2.00000", "uniqueID": "7000000000000002023", "value": "Smooth" } ] }, { "comparable": false, "displayable": true, "facetable": false, "identifier": "Assembly", "name": "Assembly", "searchable": false, "sequence": "2.00000", "storeDisplay": false, "uniqueID": "7000000000000000117", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3211", "sequence": "1.00000", "uniqueID": "7000000000000002123", "value": "Pre-built" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "Material", "name": "Material", "searchable": false, "sequence": "3.00000", "storeDisplay": false, "uniqueID": "7000000000000000009", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3211", "sequence": "2.00000", "uniqueID": "7000000000000002052", "value": "Fabric" } ] } ], "buyable": "true", "catalogEntryTypeCode": "ProductBean", "hasSingleSKU": true, "manufacturer": "StyleHome", "name": "StyleHome UltraCozy Single Sofa", "parentCatalogGroupID": [ "10001_10043", "10052_10043" ], "partNumber": "HFU032_3211", "price": [ { "currency": "USD", "description": "L", "usage": "Display", "value": "300.0" }, { "currency": "USD", "description": "I", "usage": "Offer", "value": "289.0" } ], "resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/productview\/byId\/12856", "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" }, { "attributes": [ { "comparable": true, "displayable": true, "facetable": false, "identifier": "FurnitureColor", "name": "Color", "searchable": false, "sequence": "0.00000", "storeDisplay": false, "uniqueID": "7000000000000000115", "usage": "Defining", "values": [ { "identifier": "0", "sequence": "0.00000", "uniqueID": "0", "value": "0" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "Style", "name": "Style", "searchable": false, "sequence": "0.00000", "storeDisplay": false, "uniqueID": "7000000000000000010", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3212", "sequence": "8.00000", "uniqueID": "7000000000000002099", "value": "Lazy sofa" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "FurnitureType", "name": "Type", "searchable": false, "sequence": "1.00000", "storeDisplay": false, "uniqueID": "7000000000000000114", "usage": "Defining", "values": [ { "identifier": "0", "sequence": "0.00000", "uniqueID": "0", "value": "0" } ] }, { "comparable": false, "displayable": true, "facetable": false, "identifier": "Finish", "name": "Finish", "searchable": false, "sequence": "1.00000", "storeDisplay": false, "uniqueID": "7000000000000000116", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3212", "sequence": "2.00000", "uniqueID": "7000000000000002024", "value": "Smooth" } ] }, { "comparable": false, "displayable": true, "facetable": false, "identifier": "Assembly", "name": "Assembly", "searchable": false, "sequence": "2.00000", "storeDisplay": false, "uniqueID": "7000000000000000117", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3212", "sequence": "1.00000", "uniqueID": "7000000000000002124", "value": "Pre-built" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "Material", "name": "Material", "searchable": false, "sequence": "3.00000", "storeDisplay": false, "uniqueID": "7000000000000000009", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3212", "sequence": "2.00000", "uniqueID": "7000000000000002053", "value": "Fabric" } ] } ], "buyable": "true", "catalogEntryTypeCode": "ProductBean", "hasSingleSKU": true, "manufacturer": "StyleHome", "name": "StyleHome UltraCozy Large Sofa", "parentCatalogGroupID": [ "10001_10043", "10052_10043" ], "partNumber": "HFU032_3212", "price": [ { "currency": "USD", "description": "L", "usage": "Display", "value": "600.0" }, { "currency": "USD", "description": "I", "usage": "Offer", "value": "572.0" } ], "resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/productview\/byId\/12858", "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" }, { "attributes": [ { "comparable": true, "displayable": true, "facetable": false, "identifier": "FurnitureColor", "name": "Color", "searchable": false, "sequence": "0.00000", "storeDisplay": false, "uniqueID": "7000000000000000115", "usage": "Defining", "values": [ { "identifier": "0", "sequence": "0.00000", "uniqueID": "0", "value": "0" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "Style", "name": "Style", "searchable": false, "sequence": "0.00000", "storeDisplay": false, "uniqueID": "7000000000000000010", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3205", "sequence": "3.00000", "uniqueID": "7000000000000002091", "value": "Contemporary" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "FurnitureType", "name": "Type", "searchable": false, "sequence": "1.00000", "storeDisplay": false, "uniqueID": "7000000000000000114", "usage": "Defining", "values": [ { "identifier": "0", "sequence": "0.00000", "uniqueID": "0", "value": "0" } ] }, { "comparable": false, "displayable": true, "facetable": false, "identifier": "Finish", "name": "Finish", "searchable": false, "sequence": "1.00000", "storeDisplay": false, "uniqueID": "7000000000000000116", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3205", "sequence": "4.00000", "uniqueID": "7000000000000002044", "value": "Soft" } ] }, { "comparable": false, "displayable": true, "facetable": false, "identifier": "Assembly", "name": "Assembly", "searchable": false, "sequence": "2.00000", "storeDisplay": false, "uniqueID": "7000000000000000117", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3205", "sequence": "1.00000", "uniqueID": "7000000000000002118", "value": "Pre-built" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "Material", "name": "Material", "searchable": false, "sequence": "3.00000", "storeDisplay": false, "uniqueID": "7000000000000000009", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3205", "sequence": "2.00000", "uniqueID": "7000000000000002051", "value": "Fabric" } ] } ], "buyable": "true", "catalogEntryTypeCode": "ProductBean", "hasSingleSKU": true, "manufacturer": "Supreme", "name": "Supreme GiantsCorner Sofa Set", "parentCatalogGroupID": [ "10001_10043", "10052_10043" ], "partNumber": "HFU032_3205", "price": [ { "currency": "USD", "description": "L", "usage": "Display", "value": "1000.0" }, { "currency": "USD", "description": "I", "usage": "Offer", "value": "949.0" } ], "resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/productview\/byId\/12844", "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" }, { "attributes": [ { "comparable": true, "displayable": true, "facetable": false, "identifier": "FurnitureColor", "name": "Color", "searchable": false, "sequence": "0.00000", "storeDisplay": false, "uniqueID": "7000000000000000115", "usage": "Defining", "values": [ { "identifier": "0", "sequence": "0.00000", "uniqueID": "0", "value": "0" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "Style", "name": "Style", "searchable": false, "sequence": "0.00000", "storeDisplay": false, "uniqueID": "7000000000000000010", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3209", "sequence": "2.00000", "uniqueID": "7000000000000002088", "value": "Office" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "FurnitureType", "name": "Type", "searchable": false, "sequence": "1.00000", "storeDisplay": false, "uniqueID": "7000000000000000114", "usage": "Defining", "values": [ { "identifier": "0", "sequence": "0.00000", "uniqueID": "0", "value": "0" } ] }, { "comparable": false, "displayable": true, "facetable": false, "identifier": "Finish", "name": "Finish", "searchable": false, "sequence": "1.00000", "storeDisplay": false, "uniqueID": "7000000000000000116", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3209", "sequence": "5.00000", "uniqueID": "7000000000000002046", "value": "Hard" } ] }, { "comparable": false, "displayable": true, "facetable": false, "identifier": "Assembly", "name": "Assembly", "searchable": false, "sequence": "2.00000", "storeDisplay": false, "uniqueID": "7000000000000000117", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3209", "sequence": "1.00000", "uniqueID": "7000000000000002121", "value": "Pre-built" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "Material", "name": "Material", "searchable": false, "sequence": "3.00000", "storeDisplay": false, "uniqueID": "7000000000000000009", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3209", "sequence": "1.00000", "uniqueID": "7000000000000002049", "value": "Leather" } ] } ], "buyable": "true", "catalogEntryTypeCode": "ProductBean", "hasSingleSKU": true, "manufacturer": "Stonehenge", "name": "Stonehenge Modern Steelet Single Sofa", "parentCatalogGroupID": [ "10001_10043", "10052_10043" ], "partNumber": "HFU032_3209", "price": [ { "currency": "USD", "description": "L", "usage": "Display", "value": "250.0" }, { "currency": "USD", "description": "I", "usage": "Offer", "value": "235.0" } ], "resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/productview\/byId\/12852", "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" }, { "attributes": [ { "comparable": true, "displayable": true, "facetable": false, "identifier": "FurnitureColor", "name": "Color", "searchable": false, "sequence": "0.00000", "storeDisplay": false, "uniqueID": "7000000000000000115", "usage": "Defining", "values": [ { "identifier": "0", "sequence": "0.00000", "uniqueID": "0", "value": "0" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "Style", "name": "Style", "searchable": false, "sequence": "0.00000", "storeDisplay": false, "uniqueID": "7000000000000000010", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3202", "sequence": "1.00000", "uniqueID": "7000000000000002082", "value": "Modern" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "FurnitureType", "name": "Type", "searchable": false, "sequence": "1.00000", "storeDisplay": false, "uniqueID": "7000000000000000114", "usage": "Defining", "values": [ { "identifier": "0", "sequence": "0.00000", "uniqueID": "0", "value": "0" } ] }, { "comparable": false, "displayable": true, "facetable": false, "identifier": "Finish", "name": "Finish", "searchable": false, "sequence": "1.00000", "storeDisplay": false, "uniqueID": "7000000000000000116", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3202", "sequence": "2.00000", "uniqueID": "7000000000000002019", "value": "Smooth" } ] }, { "comparable": false, "displayable": true, "facetable": false, "identifier": "Assembly", "name": "Assembly", "searchable": false, "sequence": "2.00000", "storeDisplay": false, "uniqueID": "7000000000000000117", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3202", "sequence": "1.00000", "uniqueID": "7000000000000002115", "value": "Pre-built" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "Material", "name": "Material", "searchable": false, "sequence": "3.00000", "storeDisplay": false, "uniqueID": "7000000000000000009", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3202", "sequence": "2.00000", "uniqueID": "7000000000000002050", "value": "Fabric" } ] } ], "buyable": "true", "catalogEntryTypeCode": "ProductBean", "hasSingleSKU": true, "manufacturer": "StyleHome", "name": "StyleHome Modern Plain Single Large Sofa", "parentCatalogGroupID": [ "10001_10043", "10052_10043" ], "partNumber": "HFU032_3202", "price": [ { "currency": "USD", "description": "L", "usage": "Display", "value": "1200.0" }, { "currency": "USD", "description": "I", "usage": "Offer", "value": "1099.0" } ], "resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/productview\/byId\/12838", "shortDescription": "Sophisticated modern sofa design.", "singleSKUCatalogEntryID": "12839", "storeID": "10001", "thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/hfu032_furniture\/200x310\/hfu032_3202.jpg", "uniqueID": "12838" }, { "attributes": [ { "comparable": true, "displayable": true, "facetable": false, "identifier": "FurnitureColor", "name": "Color", "searchable": false, "sequence": "0.00000", "storeDisplay": false, "uniqueID": "7000000000000000115", "usage": "Defining", "values": [ { "identifier": "0", "sequence": "0.00000", "uniqueID": "0", "value": "0" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "Style", "name": "Style", "searchable": false, "sequence": "0.00000", "storeDisplay": false, "uniqueID": "7000000000000000010", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3201", "sequence": "1.00000", "uniqueID": "7000000000000002081", "value": "Modern" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "FurnitureType", "name": "Type", "searchable": false, "sequence": "1.00000", "storeDisplay": false, "uniqueID": "7000000000000000114", "usage": "Defining", "values": [ { "identifier": "0", "sequence": "0.00000", "uniqueID": "0", "value": "0" } ] }, { "comparable": false, "displayable": true, "facetable": false, "identifier": "Finish", "name": "Finish", "searchable": false, "sequence": "1.00000", "storeDisplay": false, "uniqueID": "7000000000000000116", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3201", "sequence": "1.00000", "uniqueID": "7000000000000002015", "value": "Glossy" } ] }, { "comparable": false, "displayable": true, "facetable": false, "identifier": "Exclusive", "name": "Exclusive", "searchable": false, "sequence": "1.00000", "storeDisplay": true, "uniqueID": "7000000000000000177", "usage": "Descriptive", "values": [ { "identifier": "Exclusive", "sequence": "1.00000", "uniqueID": "7000000000000002925", "value": "Exclusive" } ] }, { "comparable": false, "displayable": true, "facetable": false, "identifier": "Assembly", "name": "Assembly", "searchable": false, "sequence": "2.00000", "storeDisplay": false, "uniqueID": "7000000000000000117", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3201", "sequence": "1.00000", "uniqueID": "7000000000000002114", "value": "Pre-built" } ] }, { "comparable": true, "displayable": true, "facetable": false, "identifier": "Material", "name": "Material", "searchable": false, "sequence": "3.00000", "storeDisplay": false, "uniqueID": "7000000000000000009", "usage": "Descriptive", "values": [ { "identifier": "HFU032_3201", "sequence": "1.00000", "uniqueID": "7000000000000002048", "value": "Leather" } ] } ], "buyable": "true", "catalogEntryTypeCode": "ProductBean", "hasSingleSKU": true, "manufacturer": "StyleHome", "name": "StyleHome Modern Rimmed 3 Piece Sofa Set", "parentCatalogGroupID": [ "10001_10043", "10052_10043" ], "partNumber": "HFU032_3201", "price": [ { "currency": "USD", "description": "L", "usage": "Display", "value": "2500.0" }, { "currency": "USD", "description": "I", "usage": "Offer", "value": "2325.0" } ], "resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/productview\/byId\/12836", "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" } ], "facetView": [ { "entry": [ { "count": "6", "extendedData": { "uniqueId": "-10028311612110810172111109101" }, "label": "StyleHome", "value": "mfName_ntk_cs%3A%22StyleHome%22" }, { "count": "2", "extendedData": { "uniqueId": "-100283117112114101109101" }, "label": "Supreme", "value": "mfName_ntk_cs%3A%22Supreme%22" }, { "count": "1", "extendedData": { "uniqueId": "-100283116111110101104101110103101" }, "label": "Stonehenge", "value": "mfName_ntk_cs%3A%22Stonehenge%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": "9", "extendedData": { "uniqueId": "10041" }, "label": "Home & Furnishing", "value": "10041" }, { "count": "9", "extendedData": { "parentIds": "10041", "uniqueId": "10043" }, "label": "Furniture", "value": "10043" } ], "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": 0, "extendedData": { "uniqueId": "1121141059910195858368584012342324948481253249484841" }, "label": "({* 100} 100)", "value": "price_USD%3A%28%7B*+100%7D+100%29" }, { "count": 1, "extendedData": { "uniqueId": "11211410599101958583685840123494848325048481253250484841" }, "label": "({100 200} 200)", "value": "price_USD%3A%28%7B100+200%7D+200%29" }, { "count": 4, "extendedData": { "uniqueId": "11211410599101958583685840123504848325148481253251484841" }, "label": "({200 300} 300)", "value": "price_USD%3A%28%7B200+300%7D+300%29" }, { "count": 0, "extendedData": { "uniqueId": "11211410599101958583685840123514848325248481253252484841" }, "label": "({300 400} 400)", "value": "price_USD%3A%28%7B300+400%7D+400%29" }, { "count": 0, "extendedData": { "uniqueId": "11211410599101958583685840123524848325348481253253484841" }, "label": "({400 500} 500)", "value": "price_USD%3A%28%7B400+500%7D+500%29" }, { "count": 4, "extendedData": { "uniqueId": "11211410599101958583685840123534848324212541" }, "label": "({500 *})", "value": "price_USD%3A%28%7B500+*%7D%29" } ], "name": "OfferPrice_USD", "value": "price_USD" } ], "metaData": { "price": "1" }, "recordSetComplete": "true", "recordSetCount": 9, "recordSetStartNumber": 0, "recordSetTotal": 9, "recordSetTotalMatches": 9, "resourceId": "http:\/\/localhost\/search\/resources\/store\/10001\/productview\/bySearchTerm\/*?searchType=1000&searchSource=Q&filterTerm=&maxPrice=&orderBy=&langId=-1&contractId=10001&physicalStoreIds=10039%2C10003&pageSize=12&intentSearchTerm=sofa&manufacturer=¤cy=USD&filterType=&advancedFacetList=&profileName=IBM_findProductsBySearchTerm&searchTerm=sofa&catalogId=10052&minPrice=&pageNumber=1&responseFormat=json&categoryId=&filterFacet=", "resourceName": "productview" }
Name | Data Type | Required |
---|---|---|
recordSetTotal | string | false |
resourceId | string | false |
resourceName | string | false |
recordSetComplete | string | false |
recordSetStartNumber | string | false |
catalogEntryView | ProductViewHandler/productdetails.json.catalogEntryView array | false |
recordSetCount | string | false |
Name | Data Type | Required |
---|---|---|
ad_attribute | ProductViewHandler/productdetails.json.catalogEntryView.ad_attribute array | false |
buyable | string | false |
catalogEntryTypeCode | string | false |
longDescription | string | false |
shortDescription | string | false |
subscriptionTypeCode | string | false |
price | ProductViewHandler/productdetails.json.catalogEntryView.price array | false |
resourceId | string | false |
name | string | false |
parentCatalogGroupID | string | false |
fullImage | string | false |
uniqueID | string | false |
thumbnail | string | false |
disallowRecurringOrder | string | false |
manufacturer | string | false |
partNumber | string | false |
storeID | string | false |
Name | Data Type | Required |
---|---|---|
ad_attribute | string | false |
usage | string | false |
description | string | false |
Name | Data Type | Required |
---|---|---|
currency | string | false |
usage | string | false |
value | string | false |
description | string | false |
Name | Data Type | Required |
---|---|---|
recordSetTotal | string | false |
breadCrumbTrailEntryView | ProductViewHandler/productsbycategory.json.breadCrumbTrailEntryView array | false |
resourceId | string | false |
resourceName | string | false |
recordSetComplete | string | false |
recordSetStartNumber | string | false |
facetView | ProductViewHandler/productsbycategory.json.facetView array | false |
catalogEntryView | ProductViewHandler/productsbycategory.json.catalogEntryView array | false |
recordSetCount | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
label | string | false |
type_ | string | false |
Name | Data Type | Required |
---|---|---|
buyable | string | false |
catalogEntryTypeCode | string | false |
shortDescription | string | false |
manufacturer | string | false |
price | ProductViewHandler/productsbycategory.json.catalogEntryView.price array | false |
resourceId | string | false |
name | string | false |
parentCatalogGroupID | string | false |
partNumber | string | false |
storeID | string | false |
thumbnail | string | false |
uniqueID | string | false |
Name | Data Type | Required |
---|---|---|
currency | string | false |
usage | string | false |
value | string | false |
description | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
entry | ProductViewHandler/productsbycategory.json.facetView.entry array | false |
extendedData | string | false |
name | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
extendedData | string | false |
label | string | false |
count | string | false |
Name | Data Type | Required |
---|---|---|
uniqueId | string | false |
Name | Data Type | Required |
---|---|---|
propertyname | string | false |
displaySequence | string | false |
facet_id | string | false |
srchattr_id | string | false |
maximumValuesToDisplay | string | false |
max_display | string | false |
zero_display | string | false |
selection | string | false |
storeent_id | string | false |
sortorder | string | false |
fname | string | false |
allValuesReturned | string | false |
allowMultipleValueSelection | string | false |
fdesc | string | false |
groupId | string | false |
group_id | string | false |
displayable | string | false |
propertyvalue | string | false |
keyword_search | string | false |
srchattridentifier | string | false |
Name | Data Type | Required |
---|---|---|
recordSetTotal | string | false |
resourceId | string | false |
resourceName | string | false |
recordSetComplete | string | false |
recordSetStartNumber | string | false |
facetView | ProductViewHandler/productsbysearchterm.json.facetView array | false |
catalogEntryView | ProductViewHandler/productsbysearchterm.json.catalogEntryView array | false |
recordSetCount | string | false |
Name | Data Type | Required |
---|---|---|
buyable | string | false |
catalogEntryTypeCode | string | false |
shortDescription | string | false |
manufacturer | string | false |
price | ProductViewHandler/productsbysearchterm.json.catalogEntryView.price array | false |
resourceId | string | false |
name | string | false |
parentCatalogGroupID | string | false |
partNumber | string | false |
storeID | string | false |
thumbnail | string | false |
uniqueID | string | false |
Name | Data Type | Required |
---|---|---|
currency | string | false |
usage | string | false |
value | string | false |
description | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
entry | ProductViewHandler/productsbysearchterm.json.facetView.entry array | false |
extendedData | string | false |
name | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
extendedData | string | false |
label | string | false |
count | string | false |
Name | Data Type | Required |
---|---|---|
uniqueId | string | false |
parentIds | string | false |
Name | Data Type | Required |
---|---|---|
propertyname | string | false |
displaySequence | string | false |
facet_id | string | false |
srchattr_id | string | false |
maximumValuesToDisplay | string | false |
max_display | string | false |
zero_display | string | false |
selection | string | false |
storeent_id | string | false |
sortorder | string | false |
fname | string | false |
allValuesReturned | string | false |
allowMultipleValueSelection | string | false |
fdesc | string | false |
groupId | string | false |
group_id | string | false |
displayable | string | false |
propertyvalue | string | false |
keyword_search | string | false |
srchattridentifier | string | false |