VTEX · Example Payload

Vtex Get Autocomplete Suggestions Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Get Autocomplete Suggestions Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "get-autocomplete-suggestions",
  "method": "GET",
  "path": "/autocomplete_suggestions",
  "summary": "VTex Get list of suggested terms and attributes similar to the search term",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "searches": [
          {
            "term": "tv",
            "count": 28861,
            "attributes": [
              {
                "key": "departamento",
                "value": "tvs-e-video",
                "labelKey": "Departamento",
                "labelValue": "TVs e V\u00eddeo"
              },
              {
                "key": "categoria",
                "value": "tvs",
                "labelKey": "Categoria",
                "labelValue": "TVs"
              },
              {
                "key": "subcategoria",
                "value": "receptor-de-controle-de-acesso",
                "labelKey": "Subcategoria",
                "labelValue": "Receptor de Controle de Acesso"
              }
            ]
          },
          {
            "term": "smarth tv",
            "count": 2308
          },
          {
            "term": "painel para tv",
            "count": 975
          },
          {
            "term": "rack tv",
            "count": 589
          }
        ]
      }
    }
  ]
}