HCL Commerce Search profiles
HCL Commerce Search uses search profiles to control the storefront search experience at a page-level. Search profiles group sets of search runtime parameters such as search index name, search index fields, expression providers, paging and sorting. The profile also controls search feature configurations such as text highlighting, facets, and spelling correction. Search profiles are defined in the HCL Commerce Search configuration file (wc-search.xml).
Note: Inheritance between search profiles is not supported. Instead, create your own search profile
that contains all the required configurations.
Product view flows
| REST API | Search Profile Name | Description |
|---|---|---|
| store/{storeId}/productview/{partNumber} | IBM_findProductByPartNumber_Details | This profile retrieves entitled products' details by using the catalog entry code from the CatalogEntry index. Catalog entry details include the basic catalog entry properties such as name and description. The extended properties such as the indexed price, attributes dictionary attributes, underlying SKUs, associated assets, merchandising associations, and components. |
| store/{storeId}/productview/{partNumber} | IBM_findProductByPartNumber_Summary | This profile retrieves entitled products' summary by using the catalog entry code from the CatalogEntry index. Catalog entry summaries include the basic catalog entry properties such as name and description. The extended properties such as the indexed price and attributes dictionary attributes. |
| store/{storeId}/productview/byId/{productId}, store/{storeId}/productview/byIds | IBM_findProductByIds_Details | This profile retrieves entitled products' details by using the catalog entry unique identifier from the CatalogEntry index. Catalog entry details include the indexed price, attributes dictionary attributes, underlying SKUs, associated assets, merchandising associations, and components. |
| store/{storeId}/productview/byId/{productId}, store/{storeId}/productview/byIds | IBM_findProductByIds_Summary | This profile retrieves entitled products' summary by using the catalog entry unique identifier from the CatalogEntry index. Catalog entry summaries include the indexed price and attributes dictionary attributes. |
| store/{storeId}/productview/byId/{productId}, store/{storeId}/productview/byIds | IBM_findProductByIdsWithAttributesAndAttachments | This profile retrieves entitled products' summary by using the catalog entry unique identifier from the CatalogEntry index. Catalog entry summaries include the indexed price, attributes dictionary attributes, underlying SKUs, and associated assets. |
| store/{storeId}/productview/byId/{productId}, store/{storeId}/productview/byIds | IBM_findProductByIds_Summary_WithNoEntitlementCheck | This profile retrieves products' summary without doing entitlement check by using the catalog entry unique identifier from the CatalogEntry index. Catalog entry summaries include the indexed price and attributes dictionary attributes. |
| store/{storeId}/productview/byCategory/{categoryId} | IBM_findProductsByCategory | This profile retrieves entitled products' details by using the catalog entry parent category unique identifier from the CatalogEntry index. Catalog entry details include the basic catalog entry properties such as name and description. The extended properties such as the indexed price, attributes dictionary attributes, facets, and breadcrumb trail. |
| store/{storeId}/productview/bySearchTerm/{searchTerm} | IBM_findProductsBySearchTerm | This profile retrieves entitled products' details by using a search term from the CatalogEntry index. Catalog entry details include the basic catalog entry properties such as name and description. The extended properties such as the indexed price, attributes dictionary attributes, facets, and spell check suggestion. |
| store/{storeId}/productview/bySearchTerm/{searchTerm} | IBM_findProductsByNameOnly | This profile limits the search scope to the catalog entry name. |
| store/{storeId}/productview/bySearchTerm/{searchTerm} | IBM_findProductsByNameAndShortDescriptionOnly | This profile limits the search scope to the catalog entry name and short description fields. |
| store/{storeId}/productview/bySearchTerm/{searchTerm} | IBM_findProductsByUnstructureOnly | This profile limits the search scope to the catalog entry unstructured field. |
| store/{storeId}/productview/byIds | IBM_findProductByIds_Basic_Summary | This profile retrieves basic summaries of products by using the catalog entry unique identifier from the CatalogEntry index. Catalog entry details include the name, partNumber, and catentryId. |
| store/{storeId}/productview/byCategory/{categoryId} | IBM_findProductsByCategory_Summary | This profile retrieves entitled products details by using the catalog entry parent category unique identifier from the CatalogEntry index. Catalog entry details include the basic catalog entry properties such as name and description, and extended properties such as the indexed price. |
| store/{storeId}/productview/byCategory/{categoryId} | IBM_ComposeFacetListByCategoryId | This profile is used to retrieve entitled products facet list. |
| store/{storeId}/productview/byCategory/{categoryId} | IBM_BreadCrumbByCategoryUniqueId | This profile is used to retrieve the breadcrumb trails of the entitled products category. |
| store/{storeId}/productview/byCategory/{categoryId} | IBM_findProductsByCategory_grouping is deprecated by IBM_findProductsByCategory | This profile defines configurations for product grouping by category. |
| store/{storeId}/productview/bySearchTerm/{searchTerm} | IBM_findProductsBySearchTerm_Summary | This profile retrieves entitled products details by using a search term from the CatalogEntry index. Catalog entry details include the basic catalog entry properties such as name and description, and extended properties such as the indexed price, facets, and spell check suggestion. |
| store/{storeId}/productview/bySearchTerm/{searchTerm} | IBM_findProductsBySearchTerm_grouping is deprecated by IBM_findProductsBySearchTerm | This profile defines configurations for product grouping by search term. |
Category view flows
| REST API | Search Profile Name | Description |
|---|---|---|
| store/{storeId}/categoryview/@top, store/{storeId}/categoryview/byParentCategory/{parentCategoryId} | IBM_findSubCategories | This profile retrieves the entitled top and subcategories details by using the catalog group parent's unique identifier from the catalog group index. |
| V1 store/{storeId}/categoryview/{categoryIdentifier} |
IBM_findCategoryByIdentifier | This profile retrieves the entitled catalog group details by using the catalog group code from the catalog group index. |
| V1 store/{storeId}/categoryview/byIdentifiers |
IBM_findCategoryByIdentifier | This profile retrieves the entitled catalog group details by using the catalog group code from the catalog group index. |
| store/{storeId}/categoryview/byId/{categoryId}, store/{storeId}/categoryview/byIds | IBM_findCategoryByUniqueIds | This profile retrieves the entitled catalog group details by using the catalog group unique identifier from the catalog group index. |
| store/{storeId}/categoryview/byIds store/{storeId}/categoryview/byId/{categoryId} | IBM_Admin_findCategoryByIds | This search profile retrieves the categories based on multiple unique IDs. It is Reserved for HCL internal use. |
Site content flows
| REST API | Search Profile Name | Description |
|---|---|---|
| store/{storeId}/sitecontent/webContentsBySearchTerm/{searchTerm} | IBM_findWebContentsBySearchTerm | This search profile is used to retrieve the
site contents' articles and videos summary by using a search term
from the Unstructured index. Note: This profile
and API endpoint is not part of in elastic
query-service. |
| store/{storeId}/sitecontent/sellerSuggestions | IBM_findNavigationSuggestion_Sellers | When the marketplace feature is enabled, this search profile retrieves the catalog entry seller suggestions from the catalog entry index. |
| store/{storeId}/sitecontent/brandSuggestions | IBM_findNavigationSuggestion_Brands | This search profile is used to retrieve the catalog entry brand suggestions from the catalog entry index. |
| store/{storeId}/sitecontent/categorySuggestions | IBM_findNavigationSuggestion_Categories | This search profile is used to retrieve the catalog group suggestions from the catalog group index. |
| store/{storeId}/sitecontent/productSuggestionsBySearchTerm/{searchTerm} | IBM_findNavigationSuggestion_Products | This search profile is used to retrieve the catalog entry suggestions from the catalog entry index. |
| store/{storeId}/sitecontent/productSuggestionsBySearchTerm/{searchTerm} | IBM_findNavigationSuggestion_PartNumber | This search profile is used to retrieve the catalog entry's part number suggestions from the catalog entry index. |
| store/{storeId}/sitecontent/keywordSuggestionsByTerm/{term} | IBM_findNavigationSuggestion_Keywords | This search profile is used to retrieve the keywords suggestions from the catalog entry index. |
Additional configuration in the wc-search.xml file
The wc-search.xml file comments contain additional configuration, such as the search result queries and filters. For more information, see Search configuration.