Autocomplete
2 min
Autocomplete Results
When making a request with the type parameter set to type=autocomplete BlueCart API will return autocomplete suggestions for the search term specified in the search_term parameter.
Autocomplete Suggestions
An example of the JSON object returned from an Autocomplete request is shown below:
{
"request_info": {
"success": true,
"credits_used": 1,
"credits_remaining": 999
},
"request_metadata": {
"id": "48d63ef58b3eb240d5b18115b674c4170faba51f",
"created_at": "2021-01-01T00:00:00.000Z",
"processed_at": "2021-01-01T00:00:00.001Z",
"total_time_taken": 0.1
},
"request_parameters": {
"type": "autocomplete",
"search_term": "memory"
},
"autocomplete_results": [
{
"suggestion": "memory foam mattress",
"category_name": "All Departments",
"type": "KEYWORD"
},
{
"suggestion": "memory foam mattress",
"category_name": "Home",
"type": "KEYWORD"
},
{
"suggestion": "memory foam pillow",
"category_name": "All Departments",
"type": "KEYWORD"
},
{
"suggestion": "memory foam mattress topper",
"category_name": "All Departments",
"type": "KEYWORD"
},
{
"suggestion": "memory card",
"category_name": "All Departments",
"type": "KEYWORD"
},
{
"suggestion": "memory foam futon",
"category_name": "All Departments",
"type": "KEYWORD"
},
{
"suggestion": "memory foam mattress queen",
"category_name": "All Departments",
"type": "KEYWORD"
},
{
"suggestion": "memory foam bath mat",
"category_name": "All Departments",
"type": "KEYWORD"
},
{
"suggestion": "memory foam mattress full",
"category_name": "All Departments",
"type": "KEYWORD"
}
]
}BlueCart API returns the following properties for Autocomplete requests:
Property | Type | Description |
|---|---|---|
autocomplete_results | array | Autocomplete Results Array The autocomplete results array contains details of each of the autocomplete suggestions returned from the query.
|
Next Steps Autocomplete Parameters