Pipelet: Search Search
Pipelet Search
This pipelet executes either a product or content search, as specified by the configuration parameters, and returns a corresponding ProductSearchModel or ContentSearchModel. The SearchPhrase parameter can be used with either search. The FolderID and ContentID parameters are specific to the content search. All other parameters are specific to the product search. Product search refinements are filtered by session currency.
Group:
Search
Configuration Properties
DisallowOfflineCategory : Boolean Optional
If set to true, the pipelet checks if the passed cgid parameter represents an offline category. In this case, it is treated like an invalid cgid. If set to false, the pipelet will execute the search also in offline categories.
Permissible Values:
false
true
RecursiveCategorySearch : String Optional
If set to true, the pipelet will execute a recursive category search. Otherwise, the pipelet will only search within the selected category. Default is 'false'.
Permissible Values:
false
true
RecursiveFolderSearch : String Optional
If set to true, the pipelet will execute a recursive folder search. Otherwise, the pipelet will only search within the selected folder. Default is 'false'.
Permissible Values:
false
true
SearchContent : String Optional
If set to true, the pipelet will execute a content search and returns the ContentSearchModel. Default is 'true'.
Permissible Values:
false
true
SearchProduct : String Optional
If set to true, the pipelet will execute a product search and returns the ProductSearchModel. Default is 'true'.
Permissible Values:
false
true
Input Parameters
SearchPhrase : String Optional
The search phrase used in this search. The search query parser uses the following operators:
- PHRASE operator (""), e.g. "cream cheese", "John Lennon"
- NOT operator (-), e.g. -cargo (will not return results containing "cargo")
- WILDCARD operator (*), e.g. sho* (will return results containing "shoulder", "shoes" and "shoot")
SortBy1 : String Optional
If specified, the search result is sorted by the specified criteria. The supplied value can either be the id of a defined sorting attribute, e.g. "name" or "brand". To sort by price, value "price" must be specified. For backward compatibility, names of search index sort fields can still be specified, such as "price-sort" or "name-sort".
SortBy3 : String Optional
If specified, the search result is additionally sorted by the specified criteria. The supplied value can either be the id of a defined sorting attribute, e.g. "name" or "brand". To sort by price, value "price" must be specified. For backward compatibility, names of search index sort fields can still be specified, such as "price-sort" or "name-sort".
SortBy2 : String Optional
If specified, the search result is additionally sorted by the specified criteria. The supplied value can either be the id of a defined sorting attribute, e.g. "name" or "brand". To sort by price, value "price" must be specified. For backward compatibility, names of search index sort fields can still be specified, such as "price-sort" or "name-sort".
SortBy1Direction : Number Optional
Sort ascending (1) or descending (2).
SortBy2Direction : Number Optional
Sort ascending (1) or descending (2).
SortBy3Direction : Number Optional
Sort ascending (1) or descending (2).
PriceMax : Number Optional
Maximum price condition. Only products whose price is less than this value are included in the result. Products whose prices are equal to or above this value are excluded from the result.
PriceMin : Number Optional
Minimum product price condition.
RefineBy1Name : String Optional
RefineBy1Phrase : String Optional
RefineBy1Min : String Optional
RefineBy1Max : String Optional
RefineBy2Name : String Optional
RefineBy2Phrase : String Optional
RefineBy2Min : String Optional
RefineBy2Max : String Optional
RefineBy3Name : String Optional
RefineBy3Phrase : String Optional
RefineBy3Min : String Optional
RefineBy3Max : String Optional
RefineBy4Name : String Optional
RefineBy4Phrase : String Optional
RefineBy4Min : String Optional
RefineBy4Max : String Optional
RefineBy5Name : String Optional
RefineBy5Phrase : String Optional
RefineBy5Min : String Optional
RefineBy5Max : String Optional
CategoryID : String Optional
ProductID : String Optional
FolderID : String Optional
ContentID : String Optional
RefineByNamePrefix : String Optional
The URL parameter prefix used to provide names of refinement attributes. The prefix is followed by a running number to connect it to the value of the attribute to refine on (e.g. prefn1=myAttribute&prefv1=myValue).
RefineByPhrasePrefix : String Optional
The URL parameter prefix used to provide values for a search refinement. The prefix is followed by a running number to connect it to the name of the attribute to refine on (e.g. prefn1=myAttribute&prefv1=myValue).
RefineByMinPrefix : String Optional
RefineByMaxPrefix : String Optional
OrderableProductsOnly : Boolean Optional
Optional control flag which determines if unorderable products (i.e products with ATS = 0) should be excluded from search results. Pass a value of true in order to exclude unorderable products, and false to include them. If no value is passed, then the default search preference controls the behavior.
SortingRuleID : String Optional
The ID of a sorting rule to use to sort the products in the search results. If no ID is provided, the default sorting rule is used for the given category, or the root category if no category is provided. This property is ignored for a content search.
PromotionID : String Optional
Optional promotion id to filter products in the search results. Multiple promotion id's must be encoded by the pipe symbol ('|'). Note: The search supports up to 30 promotion id's. If the value string contains more than 30 id's only the first 30 will be considered.
PromotionProductType : String Optional
The type of product to filter by when searching by promotion ID. Allowed values are ProductSearchModel.PROMOTION_PRODUCT_TYPE_ALL, ProductSearchModel.PROMOTION_PRODUCT_TYPE_QUALIFYING, and ProductSearchModel.PROMOTION_PRODUCT_TYPE_DISCOUNTED. If null is passed, or an invalid value is passed, the search will use ProductSearchModel.PROMOTION_PRODUCT_TYPE_ALL.
TrackingEmptySearchesEnabled : Boolean Optional
Set it to be true or null to enable tracking empty searches for predictive intelligence use. Set it to be false to disable tracking empty searches.
SortingOptionID : String Optional
The ID of a sorting option to use to sort the products in the search results. Will not be used if a sorting rule is set.
Output Parameters
ProductSearchModel : ProductSearchModel : Required
ContentSearchModel : ContentSearchModel : Optional