Dokumentace FoodRetailor Help

Test search

CRUD operace vyhledávání a ukládání feedbacku.

API specifikace

Endpoint for listing personalized results on given query.

/search/aggregations

Returns a list of product results.

Request parameters

{ "attributesByGroup": { "111111": [ "123456", "654321" ] }, "brandIds": [ "111111" ], "categoryIds": [ "123456", "654321" ] }

Responses

{ "aggregations": { "totalProductCount": 1234, "attributeGroups": [ { "attributeGroupName": "attribute group", "attributeGroupId": "222222", "productsInGroupCount": 1234, "groupsOmitted": false, "attributes": [ { "key": "attribute 1", "productCount": 1234, "id": "123456" }, { "key": "attribute 2", "productCount": 1234, "id": "234567" } ] } ], "brandGroups": [ { "key": "brand 1", "productCount": 1234, "id": "123456" }, { "key": "brand 2", "productCount": 1234, "id": "234567" } ], "categoryGroups": [ { "key": "category 1", "productCount": 1234, "id": "123456" }, { "key": "category 2", "productCount": 1234, "id": "654321" } ] } }

Endpoint fo store feedback for given suggestion/result.

/search/feedback

Saves feedback for given suggestion/result.

Request parameters

{ "type": "suggestion/result", "reason": "The search results are not ordered correctly", "details": "The search results are not ordered alphabetically by the title", "userId": "123456", "query": "hokejka", "response": "hokejka1, hokejka2", "severity": "critical" }

Responses

Endpoint for listing personalized results and aggregations on given query.

/search/results

Returns a list of product results and aggregations.

Request parameters

{ "attributesByGroup": { "111111": [ "123456", "654321" ] }, "brandIds": [ "111111" ], "categoryIds": [ "123456", "654321" ] }

Responses

{ "search": { "results": [ { "id": "__label__hokejka", "score": 0.9, "name": "hokejka", "description": "hokejka description", "generalId": "123456", "imageUrl": "https://example.com/hokejka.jpg" }, { "id": "__label__hokejka", "score": 0.89, "name": "hokejka2", "description": "hokejka2 description", "generalId": "234567", "imageUrl": "https://example.com/hokejka2.jpg" } ], "aggregations": { "totalProductCount": 1234, "attributeGroups": [ { "attributeGroupName": "attribute group", "attributeGroupId": "1111111", "productsInGroupCount": 1234, "groupsOmitted": false, "attributes": [ { "key": "attribute 1", "productCount": 1234, "id": "123456" }, { "key": "attribute 2", "productCount": 1234, "id": "234567" } ] } ], "brandGroups": [ { "key": "brand 1", "productCount": 1234, "id": "123456" }, { "key": "brand 2", "productCount": 1234, "id": "234567" } ], "categoryGroups": [ { "key": "category 1", "productCount": 1234, "id": "123456" }, { "key": "category 2", "productCount": 1234, "id": "654321" } ] } } }

Endpoint to get available search strategies.

/search/strategies

Return list of available search strategies with their IDs and names.

Request parameters

Responses

{ "strategies": [ { "id": "strategy-1", "name": "Test Strategy 1", "description": "Test Strategy 1 description" }, { "id": "strategy-2", "name": "Test Strategy 2", "description": "Test Strategy 2 description" }, { "id": "strategy-3", "name": "Test Strategy 3", "description": "Test Strategy 3 description" }, { "id": "strategy-4", "name": "Test Strategy 4", "description": "Test Strategy 4 description" }, { "id": "strategy-5", "name": "Test Strategy 5", "description": "Test Strategy 5 description" }, { "id": "strategy-6", "name": "Test Strategy 6", "description": "Test Strategy 6 description" }, { "id": "strategy-7", "name": "Test Strategy 7", "description": "Test Strategy 7 description" }, { "id": "strategy-8", "name": "Test Strategy 8", "description": "Test Strategy 8 description" }, { "id": "strategy-9", "name": "Test Strategy 9", "description": "Test Strategy 9 description" }, { "id": "strategy-10", "name": "Test Strategy 10", "description": "Test Strategy 10 description" } ] }

Endpoint for getting personalized suggestions for given query.

/search/suggestions

Returns a list of suggestions for given query.

Request parameters

Responses

{ "suggestions": { "suggestions": [ { "id": "__label__hokejka", "name": "hokejka", "score": 0.9, "generalId": "123456", "imageUrl": "https://example.com/hokejka.jpg" }, { "id": "__label__hokejka2", "name": "hokejka2", "score": 0.89, "generalId": "234567", "imageUrl": "https://example.com/hokejka2.jpg" } ], "categories": [ { "key": "category 1", "productCount": 1234, "id": "123456" }, { "key": "category 2", "productCount": 1234, "id": "654321" } ] } }
21 August 2025