Configuring custom search fields
Custom search fields allow you to extend product search capabilities beyond standard product attributes. By mapping product parameters using the param:{{parameteridentifier}} syntax, you can include custom product data in search indexes.
This configuration enables more flexible search scenarios by incorporating configurable extensions to the standard product model into the search experience.
Standard search fields
The following standard product fields are available for search configuration:
| Field | Description |
|---|---|
Name | Product name |
Categories/Name | Category names |
Brand/Name | Brand name |
ArticleNumber | Product article number |
Skus/ArticleNumber | SKU article numbers |
Texts/Text1 | Product text field 1 |
Texts/Text2 | Product text field 2 |
Texts/Text3 | Product text field 3 |
ProductIdString | Product identifier as string |
Working with custom search fields
Map up to 6 custom search fields using parameter mappings with the param:{{parameteridentifier}} syntax (see example below).
Example search configuration with custom fields:
"Search": {
"SearchFields": [
"Name",
"Categories/Name",
"Brand/Name",
"ArticleNumber",
"Skus/ArticleNumber",
"Texts/Text1",
"Texts/Text2",
"Texts/Text3",
"ProductIdString",
"CustomSearch/SearchText1"
],
"Weights": { ... },
"CustomSearch": {
"SearchText1": "param:testtext"
}
}
Typical use cases
Custom search fields enable merchants and developers to incorporate product parameters into the search index for specialized search scenarios.
1. Including custom product attributes
Integrate product parameters that extend the standard product model. Examples include:
- Mapping supplier codes or internal SKUs stored as product parameters.
- Including regulatory or compliance data configured as product parameters.
2. Enhancing product discoverability
Add product-specific content to improve search results. Examples include:
- Mapping promotional keywords or campaign tags stored as parameters.
- Including localized product attributes specific to different markets.
3. Custom taxonomies and classifications
Extend product discoverability with custom categorization. Examples include:
- Mapping internal product classifications or merchandising tags.
- Including custom attributes like sustainability ratings or quality certifications.
- Adding market-specific product groupings stored as product parameters.