VTEX · Schema
AutocompleteSearchSuggestions
Response body object.
CommerceE-CommerceRetailMarketplacePayments
Properties
| Name | Type | Description |
|---|---|---|
| searches | array | List of suggested facets and terms. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/AutocompleteSearchSuggestions",
"title": "AutocompleteSearchSuggestions",
"type": "object",
"description": "Response body object.",
"properties": {
"searches": {
"type": "array",
"description": "List of suggested facets and terms.",
"items": {
"type": "object",
"description": "Suggested facet or term.",
"properties": {
"term": {
"type": "string",
"description": "Search term."
},
"count": {
"type": "number",
"description": "Number of times the term was searched."
},
"attributes": {
"type": "array",
"nullable": true,
"description": "List of facets in which the term can be searched.",
"items": {
"type": "object",
"description": "Facet information.",
"properties": {
"key": {
"type": "string",
"description": "Facet key."
},
"value": {
"type": "string",
"description": "Facet value."
},
"labelKey": {
"type": "string",
"description": "Human-readable format of the facet key."
},
"labelValue": {
"type": "string",
"description": "Human-readable format of the facet value."
}
}
}
}
}
}
}
}
}