VTEX · Example Payload

Vtex Get Search Suggestions Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Get Search 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-search-suggestions",
  "method": "GET",
  "path": "/search_suggestions",
  "summary": "VTex Get list of suggested terms similar to the search term",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "searches": [
          {
            "term": "mountain bike",
            "count": 66
          },
          {
            "term": "bike helmet",
            "count": 121
          },
          {
            "term": "electric bike",
            "count": 78
          },
          {
            "term": "bike rack",
            "count": 161
          },
          {
            "term": "road bike",
            "count": 28
          }
        ]
      }
    }
  ]
}