Skip to content

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:

See the full POST /search API reference here.

Example

Simple request to Unified Search

Request
1
2
3
4
5
{
"segmentId": "b2c-dk-en",
"scopeId": "browse",
"phrase": "bicycle"
}
Response shortened for brevity.

Response
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
    "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
1
2
3
4
5
{
    "segmentId": "b2c-dk-en",
    "scopeId": "full-search",
    "phrase": "bicykle"
}
Response
1
2
3
4
5
6
7
{
    "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
1
2
3
4
5
6
{
    "segmentId": "b2c-dk-en",
    "scopeId": "full-search",
    "phrase": "bicykle",
    "forceSearch": true
}
Response
1
2
3
4
5
6
7
{
    "didYouMean": [
        "bicycle"
    ],
    "originalPhrase": "bicykle",
    "usedPhrase": "bicykle"
}