This class provides RESTful services to get product data for search-based catalog navigation. It performs the service by delegating to the CatalogNavigationView BOD service.
com.ibm.commerce.rest.search.handler.ProductViewHandler
HTTP Method | Path | Description |
---|---|---|
GET | /store/{storeId}/productview/{partNumber} | Gets product details based on the part number. |
GET | /store/{storeId}/productview/byCategory/{categoryId} | Gets all products belonging to a category based on the category unique ID. |
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 matching products for a given search term. It supports specifying conditions to filter the search results. |
Gets product details based on the part number.
findProductByPartNumber
false
true
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
partNumber | Part number to retrieve details about a particular sku | 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 |
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. |
500 | Internal server error. Additional details will be contained on the server logs. |
GET /wcs/resources/store/10001/productview/AuroraWMDRS-692
200
{ "CatalogEntryView": [ { "Attributes": [ { "ExtendedValue": [ { "extValue": "C62" } ], "Values": [ { "extendedValue": [ { "key": "UnitOfMeasure", "value": "C62" }, { "key": "Image1", "value": "images\/catalog\/apparel\/women\/Swatches\/swatch_size\/size_xs_enabled.png" }, { "key": "Image1Path", "value": "Aurora\/images\/catalog\/apparel\/women\/Swatches\/swatch_size\/size_xs_enabled.png" } ], "identifier": "XS", "uniqueID": "7000000000000000004", "values": "XS" } ], "comparable": "true", "dataType": "STRING", "description": "Available Sizes", "displayable": "true", "identifier": "swatchSize", "name": "Available Sizes", "searchable": "false", "uniqueID": "7000000000000000001", "usage": "Defining" }, { "ExtendedValue": [ { "extValue": "C62" } ], "Values": [ { "extendedValue": [ { "key": "UnitOfMeasure", "value": "C62" }, { "key": "Image1", "value": "images\/catalog\/apparel\/women\/Swatches\/swatch_blue.png" }, { "key": "Image1Path", "value": "Aurora\/images\/catalog\/apparel\/women\/Swatches\/swatch_blue.png" } ], "identifier": "Blue", "uniqueID": "7000000000000000012", "values": "Blue" } ], "comparable": "true", "dataType": "STRING", "description": "Color", "displayable": "true", "identifier": "swatchcolor", "name": "Color", "searchable": "false", "uniqueID": "7000000000000000002", "usage": "Defining" } ], "Price": [ { "priceDescription": "I", "priceUsage": "Offer", "priceValue": "50.00" } ], "buyable": "true", "disallowRecOrder": "true", "fullImage": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/wcl000_dresses\/646x1000\/wcl000_0016_a_blue.jpg", "fullImageAltDescription": "Image for Luigi Valenti Striped Pencil Dress from Aurora", "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", "metaDescription": "One shoulder pencil evening dress with stripes", "metaKeyword": " Luigi Valenti", "name": "Luigi Valenti Striped Pencil Dress", "parentCategoryID": "10006", "parentProductID": "10038", "partNumber": "AuroraWMDRS-692", "productType": "ItemBean", "resourceId": "https:\/\/localhost:443\/wcs\/resources\/store\/10001\/productview\/byId\/10706", "shortDescription": "One shoulder pencil evening dress with stripes", "storeID": "10001", "subscriptionType": "NONE", "thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/apparel\/women\/wcl000_dresses\/200x310\/wcl000_0016_a_blue.jpg", "title": "Luigi Valenti Striped Pencil Dress | Aurora", "uniqueID": "10706" } ], "MetaData": [ { "metaData": "1", "metaKey": "price" } ], "recordSetComplete": "true", "recordSetCount": "1", "recordSetStartNumber": "0", "recordSetTotal": "1", "resourceId": "https:\/\/localhost:443\/wcs\/resources\/store\/10001\/productview\/AuroraWMDRS-692", "resourceName": "productview" }
Gets all products belonging to a category based on the category unique ID.
findProductsByCategory
false
true
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
categoryId | The category id used to narrow down search results to a cateogry id | path | string | true | N/A |
searchType | Specify different search configurations example 1000 (INCLUDE products, kits, bundles, category level SKUs) | 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 | integer | false | false |
pageSize | Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The "pageNumber" must be specified for paging to work. | query | integer | false | false |
orderBy | Change the order of search results, possible values 1-4 | 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. |
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 | Product identifier code to retrieve details about a particular product | path | string | true | N/A |
catalogId | The catalog identifier. If none is specified, the store default catalog shall be used. | query | string | false | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
GET /wcs/resources/store/10001/productview/byId/13011
200
{ "CatalogEntryView": [ { "Attributes": [ { "ExtendedValue": [ { "extValue": "C62" } ], "Values": [ { "extendedValue": [ { "key": "UnitOfMeasure", "value": "C62" } ], "identifier": "White", "uniqueID": "7000000000000002300", "values": "White" } ], "comparable": "true", "dataType": "STRING", "description": "Color", "displayable": "true", "identifier": "TablewareColor", "name": "Color", "searchable": "false", "uniqueID": "7000000000000000129", "usage": "Defining" } ], "Price": [ { "priceDescription": "I", "priceUsage": "Offer", "priceValue": "20.00" } ], "buyable": "true", "disallowRecOrder": "true", "fullImage": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/hta029_tableware\/646x1000\/hta029_2920.jpg", "fullImageAltDescription": "Image for KitchenComfort Mugs from Aurora", "longDescription": "High grade porcelain mug. Specifically designed in this shape to give a better grip to the mug. Great for use in office, or to give as a gift to a friend with a personal note. Dishwasher and microwave safe.", "manufacturer": "KitchenComfort", "metaDescription": "Plain porcelain mug.", "metaKeyword": " KitchenComfort", "name": "KitchenComfort Mugs", "parentCategoryID": "10046", "parentProductID": "13010", "partNumber": "HTA029_292001", "productType": "ItemBean", "resourceId": "http:\/\/localhost:8007\/wcs\/previewresources\/store\/10001\/productview\/byId\/13011", "shortDescription": "Plain porcelain mug.", "storeID": "10001", "subscriptionType": "NONE", "thumbnail": "\/wcsstore\/Aurora\/images\/catalog\/homefurnishings\/hta029_tableware\/200x310\/hta029_2920.jpg", "title": "KitchenComfort Mugs | Aurora", "uniqueID": "13011" } ], "MetaData": [ { "metaData": "1", "metaKey": "price" } ], "recordSetComplete": "true", "recordSetCount": "1", "recordSetStartNumber": "0", "recordSetTotal": "1", "resourceId": "http:\/\/localhost:8007\/wcs\/previewresources\/store\/10001\/productview\/byId\/13011", "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 | Product identifier code to retrieve details about a particular product | query | string | true | 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 |
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. |
500 | Internal server error. Additional details will be contained on the server logs. |
Gets matching products for a given search term. It supports specifying conditions to filter the search results.
findProductsBySearchTerm
false
true
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
searchTerm | The term you are searching for | path | string | true | N/A |
pageNumber | Page number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work. | query | integer | false | false |
pageSize | Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The "pageNumber" must be specified for paging to work. | query | integer | false | false |
intentSearchTerm | The term to be used for search after a spell correction will be logged in search statistics as a suggestion | query | string | false | false |
originalSearchTerm | The term which was miss spelled will be used in search statistics to track search misses | query | string | false | false |
categoryId | The category id used to narrow down search results to a cateogry id | query | string | false | false |
searchType | Specify different search configurations example 1000 (INCLUDE products, kits, bundles, category level SKUs) | query | string | false | false |
filterTerm | Term used to filter out search results | query | string | false | false |
filterType | The type of filter to use | query | string | false | false |
manufacturer | Specific brand to narrow down score of search | query | string | false | false |
minPrice | Set the minimum price range for a search. Price values are non-formatted numeric strings containing two decimal places | query | string | false | false |
maxPrice | Set the maximum price range for a search. Price values are non-formatted numeric strings containing two decimal places | query | string | false | false |
facet | Specify facets which have been selected | query | string | false | true |
advancedFacetList | Specify advanced facets which have been selected | query | string | false | false |
filterFacet | Narrow down scope of search results by excluding facet filters | query | string | false | false |
orderBy | Change the order of search results, possible values 1-4 | query | string | false | false |
metaData | Specify metadata to be used in search result | query | string | false | false |
searchSource | Specify the origin of the search request (ie 'A' to indicate search is coming from advanced search) | 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. |
500 | Internal server error. Additional details will be contained on the server logs. |
Name | Data Type | Required |
---|---|---|
value | string | false |
currency | string | false |
Name | Data Type | Required |
---|---|---|
indexStatus | string | false |
userDataField | productview-productSummary.userDataField array | false |
SuggestionView | productview-productSummary.SuggestionView array | false |
WebContentView | productview-productSummary.WebContentView array | false |
recordSetComplete | string | false |
MetaData | productview-productSummary.MetaData array | false |
finalQuery | string | false |
recordSetTotal | string | false |
BreadCrumbTrailEntryView | productview-productSummary.BreadCrumbTrailEntryView array | false |
report | string array | false |
recordSetStartNumber | string | false |
FacetView | productview-productSummary.FacetView array | false |
recordSetCount | string | false |
CatalogEntryView | productview-productSummary.CatalogEntryView array | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
label | string | false |
type | string | false |
Name | Data Type | Required |
---|---|---|
longDescription | string | false |
buyable | string | false |
shortDescription | string | false |
parentCategoryID | string | false |
metaKeyword | string | false |
Price | productview-productSummary.CatalogEntryView.Price array | false |
productType | string | false |
keyword | string | false |
name | string | false |
fullImage | string | false |
thumbnail | string | false |
uniqueID | string | false |
metaDescription | string | false |
title | string | false |
storeID | string | false |
partNumber | string | true |
fullImageAltDescription | string | false |
Name | Data Type | Required |
---|---|---|
priceDescription | string | false |
PriceRange | productview-productSummary.CatalogEntryView.Price.PriceRange array | false |
maxPrice | string | false |
userDataField | productview-productSummary.CatalogEntryView.Price.userDataField array | false |
minPrice | string | false |
priceUsage | string | false |
priceValue | string | false |
isLowestContractPrice | string | false |
contractId | string | false |
Name | Data Type | Required |
---|---|---|
priceRange | com.ibm.commerce.foundation.common.datatypes.MonetaryAmountType | true |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
value | string | false |
Entry | productview-productSummary.FacetView.Entry array | false |
name | string | false |
Name | Data Type | Required |
---|---|---|
label | string | false |
image | string | false |
count | string | false |
entryValue | string | false |
Name | Data Type | Required |
---|---|---|
metaKey | string | true |
metaData | string | false |
Name | Data Type | Required |
---|---|---|
Entry | productview-productSummary.SuggestionView.Entry array | false |
label | string | false |
identifier | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
userDataField | productview-productSummary.SuggestionView.Entry.userDataField array | false |
image | string | false |
name | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
userDataField | productview-productSummary.WebContentView.userDataField array | false |
name | string | false |
uniqueID | string | false |
URL | string | true |
MetaData | productview-productSummary.WebContentView.MetaData array | false |
Name | Data Type | Required |
---|---|---|
metaKey | string | true |
metaData | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |