searching
suggestions
did you mean
concept
Unified Search
Unified Search is the recommended way to search with Ecommerce Search. It provides access to the following data sources and features from a single endpoint:
Tip
In cases where only a specific type of data is required, such as SKUs , single endpoints are available for improved performance.
See the full POST /search
API reference here .
Example
Simple request to Unified Search
Request {
"segmentId" : "b2c-dk-en" ,
"scopeId" : "browse" ,
"phrase" : "bicycle"
}
Response shortened for brevity.
Response {
"products" : [
...
],
"content" : [
...
],
"facets" : [
...
],
"suggestions" : [
...
],
"didYouMean" : [
...
],
"relatedTags" : [
...
],
"numberOfRequestedProductResults" : 36 ,
"totalProducts" : 0 ,
"totalSuggestions" : 0 ,
"totalRelatedTags" : 0 ,
"originalPhrase" : "bicycle" ,
"usedPhrase" : "bicycle" ,
"productOffset" : 0 ,
"numberOfRequestedContentResults" : 1 ,
"totalContent" : 0
}
Automatic corrections
If a search phrase returns no results, the first suggestion from Did You Mean is automatically used for a second search, which may return results. This allows misspelled searches to be corrected without the end user having to perform a second search.
Automatic correction
Note the deliberate misspelling of bicykle
Request {
"segmentId" : "b2c-dk-en" ,
"scopeId" : "full-search" ,
"phrase" : "bicykle"
}
Response {
"didYouMean" : [
"bicycle"
],
"originalPhrase" : "bicykle" ,
"usedPhrase" : "bicycle"
}
The automatic correction functionality can be disabled by setting forceSearch
to true in the request.
Disabling automatic corrections
Request {
"segmentId" : "b2c-dk-en" ,
"scopeId" : "full-search" ,
"phrase" : "bicykle" ,
"forceSearch" : true
}
Response {
"didYouMean" : [
"bicycle"
],
"originalPhrase" : "bicykle" ,
"usedPhrase" : "bicykle"
}