{ "opencollection": "1.0.0", "info": { "name": "Depict Lite Ab Test Search (v3) API", "version": "1.0.0" }, "items": [ { "info": { "name": "Search (v3)", "type": "folder" }, "items": [ { "info": { "name": "Get Results", "type": "http" }, "http": { "method": "POST", "url": "/api/lite/v3/search/results", "headers": [ { "name": "x-use-db-display-store", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns products and content that matches a given query, optionally filtered. This is the main search endpoint.\n\nExample response:\n
\n{\n \"n_hits\": 2,\n \"sorts\": [\n {\n \"field\": \"_relevance\",\n \"order\": \"desc\",\n \"meta\": {\n \"title\": \"Recommended\",\n \"values\": [\n \"desc\"\n ],\n \"names\": [\n \"Recommended\"\n ]\n }\n },\n {\n \"field\": \"title\",\n \"order\": \"asc\",\n "
},
{
"info": {
"name": "Get Suggestions",
"type": "http"
},
"http": {
"method": "GET",
"url": "/api/lite/v3/search/suggestions",
"params": [
{
"name": "merchant",
"value": "",
"type": "query"
},
{
"name": "market",
"value": "",
"type": "query"
},
{
"name": "locale",
"value": "",
"type": "query"
},
{
"name": "query",
"value": "",
"type": "query"
},
{
"name": "session_id",
"value": "",
"type": "query"
}
]
},
"docs": "Returns suggestions for a given query. Call this while the user is typing to help\nthe user find what they're looking for. The suggestions are of two types:\n- suggestions for search queries that are related to the current query\n- suggestions for listings that are related to the current query\n\nExample response:\n\n{\n \"suggestions_request_id\": \"c6fa5efd-1bde-43a8-9ac4-434605f53024\",\n \"suggestions\": [\n {\n \"type\": \"query\",\n \"title\": \"red hat\",\n \"suggestions_result_id\": \"60c5495"
},
{
"info": {
"name": "Get Related Recommendations",
"type": "http"
},
"http": {
"method": "POST",
"url": "/api/lite/v3/search/related",
"headers": [
{
"name": "x-use-db-display-store",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Returns recommendations for products related to the search query. Note that this\nendpoint takes the same request body as the `/v3/search/results` endpoint, excluding\nthe pagination parameters. It should be called once the user has exhausted the\nsearch results for their query and the recommended products are typically shown\nbelow the search results."
}
]
}
],
"bundled": true
}