How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

VTEX Autocomplete API

The Autocomplete API from VTEX — 4 operation(s) for autocomplete.

VTEX Autocomplete API is one of 142 APIs that VTEX publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Autocomplete. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 4 paths, and defines 4 schemas. It is described by OpenAPI 3.0.0, at version 1.0.

Requests are made against a single base URL, https://{providerApiEndpoint}.

4 operations 4 paths 4 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0
Base URL
https://{providerApiEndpoint}
Authentication
API Key
Resource Areas
1

Authentication & Security 1

VTEX Autocomplete API declares 1 security scheme for authenticating requests. An API key is passed in the header as VtexIdclientAutCookie (VtexIdclientAutCookie).

  • VtexIdclientAutCookie — [User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

Autocomplete 4
GET
/top_searches
VTex Get list of the 10 most searched terms
1 param → 2005XX
GET
/autocomplete_suggestions
VTex Get list of suggested terms and attributes similar to the search term
2 params → 2005XX
GET
/search_suggestions
VTex Get list of suggested terms similar to the search term
2 params → 2005XX
GET
/buscaautocomplete
VTex Product Search Autocomplete
AutoComplete 3 params → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Error (2 properties), SearchSuggestions (1 property), AutocompleteSearchSuggestions (1 property), TopSearches (1 property). Each schema is shown below with its type and property counts.

TopSearches
object
Response body object.
1 property
Error
object
Response body object.
2 properties 2 required
AutocompleteSearchSuggestions
object
Response body object.
1 property
SearchSuggestions
object
Response body object.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vtex-autocomplete-api-openapi.yml Raw ↑

Other APIs VTEX publishes across the network.

VTEX Account API
VTEX Addresses API
VTEX Anti-Fraud Flow API
VTEX App Keys API
VTEX Attachment API
VTEX Authentication API
VTEX Brand API
VTEX Bulk Import API
VTEX Carriers API
VTEX Cart Attachments API
VTEX Category API
VTEX Category Specification API
Where this information came from

This is an independent, third-party profile of VTEX Autocomplete API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.