WebSphere Commerce search profiles
Search profiles are defined in the WebSphere Commerce
search configuration file (wc-search.xml). They map to the WebSphere Commerce
REST API search handler classes.
Product view flows
For more information about the specific usage of the product view flows, see the WebSphere
Commerce REST API:
| REST API | Search Profile Name | Description |
|---|---|---|
| store/{storeId}/productview/{partNumber} | IBM_findProductByPartNumber_Details | This profile is used to retrieve entitled products' details 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 is used to retrieve entitled products' summary using the catalog entry code from the CatalogEntry index. Catalog entry summary 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 is used to retrieve entitled products' details 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 is used to retrieve entitled products' summary using the catalog entry unique identifier from the CatalogEntry index. Catalog entry summary include the indexed price and attributes dictionary attributes. |
| store/{storeId}/productview/byId/{productId}, store/{storeId}/productview/byIds | IBM_findProductByIdsWithAttributesAndAttachments | This profile is used to retrieve entitled products' summary using the catalog entry unique identifier from the CatalogEntry index. Catalog entry summary 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 is used to retrieve products' summary without doing entitlement check using the catalog entry unique identifier from the CatalogEntry index. Catalog entry summary include the indexed price and attributes dictionary attributes. |
| store/{storeId}/productview/byCategory/{categoryId} | IBM_findProductsByCategory | This profile is used to retrieve entitled products' details 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 is used to retrieve entitled products' details 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 extends the IBM_findProductsBySearchTerm profile. It inherits everything from its parent, but overrides the query search fields to only limit the search scope to the catalog entry name. |
| store/{storeId}/productview/bySearchTerm/{searchTerm} | IBM_findProductsByNameAndShortDescriptionOnly | This profile extends the IBM_findProductsBySearchTerm profile. It inherits everything from its parent, but overrides the query search fields to only limit the search scope to the catalog entry name and short description fields. |
| store/{storeId}/productview/bySearchTerm/{searchTerm} | IBM_findProductsByUnstructureOnly | This profile extends the IBM_findProductsBySearchTerm profile. It inherits everything from its parent, but overrides the query search fields to only limit the search scope to the catalog entry unstructured field. |
| store/{storeId}/productview/byIds | IBM_findProductByIds_Basic_Summary | This profile is used to retrieve basic summaries of products 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 is used to retrieve entitled products details 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 | This profile extends the IBM_findProductsByCategory profile. It inherits everything from its parent, but overrides the query postprocessors to include search result grouping-specific postprocessors. It also defines group product configurations for search result grouping. |
| store/{storeId}/productview/bySearchTerm/{searchTerm} | IBM_findProductsBySearchTerm_Summary | This profile is used to retrieve entitled products details 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 | This profile extends the IBM_findProductsBySearchTerm profile. It inherits everything from its parent, but overrides the query postprocessors to include search result grouping-specific postprocessors. It also defines group product configurations for search result grouping. |
Category view flows
For more information about the specific usage of the category view flows, see the WebSphere
Commerce REST API:
| REST API | Search Profile Name | Description |
|---|---|---|
| store/{storeId}/categoryview/@top, store/{storeId}/categoryview/byParentCategory/{parentCategoryId} | IBM_findSubCategories | This profile is used to retrieve the entitled top and subcategories details using the catalog group parent's unique identifier from the catalog group index. |
| store/{storeId}/categoryview/{categoryIdentifier} | IBM_findCategoryByIdentifier | This profile is used to retrieve the entitled catalog group details using the catalog group code from the catalog group index. |
| store/{storeId}/categoryview/byId/{categoryId}, store/{storeId}/categoryview/byIds | IBM_findCategoryByUniqueIds | This profile is used to retrieve the entitled catalog group details using the catalog group unique identifier from the catalog group index. |
Site content flows
For more information about the specific usage of the site content flows, see the WebSphere
Commerce REST API:
| 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. |
| 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. |
Additional information in the wc-search.xml file
The wc-search.xml file comments contain additional information, such as the search result queries and filters. For more information, see Search configuration.