Introduced in Feature Pack 3

SearchDisplay URL

The SearchDisplay URL is used in starter stores to display search results from WebSphere Commerce search. For example, in search results pages, or in search-based navigation.

URL structure

http://host_name/path/
The fully qualified name of your WebSphere Commerce Server and the configuration path
Feature Pack 3Feature Pack 4

SearchDisplay URL syntax diagram (Feature Pack 3, 4)
Feature Pack 5 or later

SearchDisplay URL syntax diagram (Feature Pack 5 and later)

Parameter values

pageSize
The number of search result rows to display per page.
beginIndex
Used to page the result set. The value is the index of the first result row in a page.
searchTerm
The search term that is used in the storefront when searching.
searchType
Defines more precise search instructions on how the search engine performs the search operation with the set of keywords.
For more information, see WebSphere Commerce search interface.
searchSource
Used for analytics to tell the runtime where the search request was initiated from in the storefront. For example:
  • A for advanced search
  • E for extended deep category navigation
  • N for search-based navigation
  • Q for quick search
  • S for secondary search upon search miss
metaData
Passes the meta string containing the history of facets.
orderBy
The ordering for search results. For example, no sort by default, 1 to sort by brand, 2 to sort by name, 3 to sort by price (low to high), or 4 to sort by price (high to low).
Feature Pack 5 or laterfacet
Feature Pack 5 or laterThe new facet parameter to apply to the search. The request generates a new metadata string for the next request using the new facet.
categoryId
The category reference number that is associated with the search results to display.
filterTerm
The search term to exclude.
filterType
The filter type. For example, 0 to search any words [OR], 1 for exact phrase match, or 2 for all words [AND].
filterFacet
The facet to remove in the search request, and the generated metadata string.
manufacturer
The filter, by brand.
minPrice
The minimum price to display when searching for price ranges.
maxPrice
The maximum price to display when searching for price ranges.
storeId
The store reference number that is associated with the search results to display.
catalogId
The catalog reference number that is associated with the search results to display.
searchTermScope
The scope of the search term. For example, 1 for name and description, 2 for name only, or 3 for product attachments.
viewMode
Overrides the default view for mobile devices to load specific entries that are defined in the Struts configuration file.
When set to t, it is used by tablet devices to load the tSearchDisplayView.
When set to m20, it is used by smart phone devices to load the m20SearchDisplayView.

Behavior

  • Search-based navigation must be enabled in your starter store to include enhanced search functionality.
  • SearchDisplay is called within the storefront when a search is submitted or when a facet link is clicked.