VTvtex
Autocomplete

Product search autocomplete

Retrieves product's information related to the searched string. {{searchString}} is the part of string the user is looking for. E.g.: ref|refrig|refrigerator`

get/buscaautocomplete

Request

  • Base URL
    https://apiexamples.vtexcommercestable.com.br
  • URL
    https://apiexamples.vtexcommercestable.com.br/buscaautocomplete
  • Auth
    • API key in header X-VTEX-API-AppKey and API key in header X-VTEX-API-AppToken
    • or API key in header VtexIdclientAutCookie

Query parameters

productNameContainsstring required
Example:jeans

Part of the string that will be searched.

Headers

Content-Typestring required
Example:application/json

Type of the content being sent

Acceptstring required
Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand

Response

OK

Example response

{
  "itemsReturned": [
    {
      "items": [],
      "thumb": "",
      "thumbUrl": null,
      "name": "Cacilds in Coronas",
      "href": "https://merch.vtexcommercestable.com.br/coronas/Cacilds",
      "criteria": "£Cacilds in Coronas¢/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
    }
  ]
}

Changes

No recorded changes to this operation across all 50 revisions of this API.