Search products and content
POST/search/v1/:project-id
This endpoint lets you search for products (and content, if applicable) matching your query.
Please make sure to always attach a sessionId to the request body.
Additionally, make sure to forward the client IP address via an HTTP header called HTTP_CLIENT_IP - this makes it possible to set a limit for queries per IP per hour to prevent abuse.
Request
Responses
- 200
- 404
OK
{
"searchResults": [
{
"type": "products",
"name": "Products",
"totalResults": 13,
"totalResultsVariants": 13,
"totalResultsHead": 13,
"totalResultsHeadVariants": 13,
"results": [
[
{
"identifier": "4455671",
"groupId": "4455671",
"sxId": 241689254,
"dataPoints": [
{
"id": 292283858,
"conceptIdName": "PRICE",
"key": "price",
"type": "PASS_ON",
"value": "1299.99 $",
"parsedValue": 1299.99,
"unit": "$"
},
{
"id": 291705761,
"conceptIdName": "CATEGORY",
"key": "Category",
"type": "PASS_ON",
"value": "Laptops",
"isCategory": true
}
],
"image": "www.myshop.com/product/4455671/img.jpg",
"name": "Laptop AB",
"images": [
{
"type": "ALTERNATIVE",
"url": "www.myshop.com/product/4455671/img.jpg"
}
],
"link": "www.myshop.com/product/4455671",
"resultSet": null,
"head": true,
"relevance": 1000000
}
],
[
{
"identifier": "7788993",
"groupId": "7788993",
"sxId": 241689253,
"dataPoints": [
{
"id": 292283858,
"conceptIdName": "PRICE",
"key": "price",
"type": "PASS_ON",
"value": "1099.99 $",
"parsedValue": 1099.99,
"unit": "$"
},
{
"id": 291705761,
"conceptIdName": "CATEGORY",
"key": "Category",
"type": "PASS_ON",
"value": "Laptops",
"isCategory": true
}
],
"image": "www.myshop.com/product/7788993/img.jpg",
"name": "Laptop Y",
"images": [
{
"type": "ALTERNATIVE",
"url": "www.myshop.com/product/7788993/img.jpg"
}
],
"link": "www.myshop.com/product/7788993",
"resultSet": null,
"head": true,
"relevance": 999999
}
],
[
{
"identifier": "4455669",
"groupId": "4455669",
"sxId": 241689231,
"dataPoints": [
{
"id": 292283858,
"conceptIdName": "PRICE",
"key": "price",
"type": "PASS_ON",
"value": "1099.99 $",
"parsedValue": 1099.99,
"unit": "$"
},
{
"id": 291705761,
"conceptIdName": "CATEGORY",
"key": "Category",
"type": "PASS_ON",
"value": "Laptops",
"isCategory": true
}
],
"image": "www.myshop.com/product/4455669/img.jpg",
"name": "Laptop S",
"images": [
{
"type": "ALTERNATIVE",
"url": "www.myshop.com/product/4455669/img.jpg"
}
],
"link": "www.myshop.com/product/4455669",
"resultSet": null,
"head": true,
"relevance": 999998
}
]
]
},
{
"type": "all",
"name": "All Results",
"totalResults": 13,
"placements": [
{
"type": "PRODUCT",
"position": 0,
"id": "4455671"
}
]
}
],
"totalResults": 13,
"interpretedQuery": {
"matchSources": [],
"queryIntent": {
"type": "DEFINITION"
},
"category": "laptop",
"categoryId": 292283856,
"normalizedCategory": "ROOT/Laptops",
"categorySource": "CUSTOMER",
"corrected": "laptop",
"queryWasCorrected": false,
"original": "laptop",
"intentMatched": true,
"confidence": 2,
"tags": [],
"resultSetType": "USER_QUERY",
"filterMatchType": "FULL_FILTER_MATCH"
},
"relatedQueries": [],
"showAllResults": true,
"suggestedFilters": null,
"answerText": null,
"offset": 0,
"limit": 3,
"activeSortingOption": {},
"sortingOptions": [],
"matchedIntentId": 131455,
"activeFilterOptions": [],
"activePreSetFilterOptions": [],
"activeSxFilterOptions": [],
"activeGuidedQuestions": [],
"filterGroups": [],
"filterOptions": [
{
"key": "292283863",
"name": "brand",
"conceptIdName": "BRAND",
"type": "COLLECTION",
"semanticLevel": 1,
"visible": true,
"values": [
{
"key": 292283873,
"name": "BrandW",
"conceptIdName": "BRAND_#_BRANDW",
"value": "BRAND_#_BRANDW",
"count": 3
},
{
"key": 292283872,
"name": "BrandX",
"conceptIdName": "BRAND_#_BRANDX",
"value": "BRAND_#_BRANDX",
"count": 3
},
{
"key": 292283876,
"name": "BrandY",
"conceptIdName": "BRAND_#_BRANDY",
"value": "BRAND_#_BRANDY",
"count": 4
},
{
"key": 292283875,
"name": "BrandZ",
"conceptIdName": "BRAND_#_BRANDZ",
"value": "BRAND_#_BRANDZ",
"count": 3
}
],
"count": 13
},
{
"key": "291705761",
"name": "Category",
"conceptIdName": "CATEGORY",
"type": "TREE",
"semanticLevel": 1,
"visible": true,
"categories": [
{
"conceptId": 292283856,
"key": "292283856",
"viewName": "Laptops",
"name": "Laptops",
"value": "ROOT/Laptops",
"conceptIdName": "ROOT/Laptops",
"count": 13,
"image": "www.myshop.com/product/1122334/img.jpg",
"children": []
}
],
"totalCategories": 1
},
{
"key": "292283861",
"name": "color",
"conceptIdName": "COLOR",
"type": "COLLECTION",
"semanticLevel": 1,
"visible": true,
"values": [
{
"key": 292283870,
"name": "Blue",
"conceptIdName": "COLOR_#_BLUE",
"value": "COLOR_#_BLUE",
"count": 4
},
{
"key": 292283878,
"name": "Gold",
"conceptIdName": "COLOR_#_GOLD",
"value": "COLOR_#_GOLD",
"count": 3
},
{
"key": 292283880,
"name": "Red",
"conceptIdName": "COLOR_#_RED",
"value": "COLOR_#_RED",
"count": 1
},
{
"key": 292283881,
"name": "Silver",
"conceptIdName": "COLOR_#_SILVER",
"value": "COLOR_#_SILVER",
"count": 4
},
{
"key": 292283877,
"name": "White",
"conceptIdName": "COLOR_#_WHITE",
"value": "COLOR_#_WHITE",
"count": 1
}
],
"count": 13
},
{
"key": "292283858",
"name": "price",
"conceptIdName": "PRICE",
"type": "RANGE",
"semanticLevel": 1,
"visible": true,
"min": 799.99,
"max": 1499.99,
"counts": {
"799.99": 1,
"899.99": 1,
"1099.99": 4,
"1199.99": 2,
"1299.99": 4,
"1499.99": 1
},
"count": 13,
"unit": "$",
"fractionalDigits": 2
},
{
"key": "292283860",
"name": "rating",
"conceptIdName": "RATING",
"type": "RANGE",
"semanticLevel": 1,
"visible": true,
"min": 4.2,
"max": 5,
"counts": {
"4.2": 2,
"4.4": 1,
"4.5": 2,
"4.6": 2,
"4.7": 3,
"4.8": 2,
"5.0": 1
},
"count": 13,
"unit": "",
"fractionalDigits": 2
}
],
"sxFilterOptions": [],
"filterMapping": {
"Products": [
"292283863",
"291705761",
"292283861",
"292283858",
"292283860"
],
"_": [],
"Other": []
},
"activeRanking": "ZOOVU"
}
Not found