VTEX · Example Payload

Vtex Autocomplete Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Autocomplete 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

{
  "operationId": "AutoComplete",
  "method": "GET",
  "path": "/buscaautocomplete",
  "summary": "VTex Product Search Autocomplete",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "itemsReturned": [
          {
            "items": [],
            "thumb": "",
            "thumbUrl": null,
            "name": "Cacilds in Coronas",
            "href": "https://merch.vtexcommercestable.com.br/coronas/Cacilds",
            "criteria": "\u00a3Cacilds in Coronas\u00a2/coronas/Cacilds"
          },
          {
            "items": [
              {
                "productId": "3",
                "itemId": "5",
                "name": "Llf",
                "nameComplete": "Cacilds Llf",
                "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/172754-25-25/Diablo.jpg?v=637521970448770000"
              }
            ],
            "thumb": "<img src=\"https://merch.vteximg.com.br/arquivos/ids/155400-25-25/image-433ec3e72d7e4b94964481e843c9dd88.jpg?v=637172099619830000\" width=\"25\" height=\"25\" alt=\"image-433ec3e72d7e4b94964481e843c9dd88\" id=\"\" />",
            "thumbUrl": "https://merch.vteximg.com.br/arquivos/ids/172754-25-25/Diablo.jpg?v=637521970448770000",
            "name": "cacilds - llf",
            "href": "https://merch.vtexcommercestable.com.br/bay-max-3/p",
            "criteria": null
          }
        ]
      }
    }
  ]
}