API Reference

Integration Guides
Headless commerce
Headless catalog

Be it through category menus, keyword searches, or product pages, shoppers accessing your headless store will need to browse through your products' information.

Below you can learn more about API endpoints you can use to help shoppers find what they need in your store. See the catalog documentation to learn how to manage products, SKUs and categories, among other things.

You can filter the results of the endpoints below by trade policy with the query parameter sc={tradePolicy}.


One of the ways shoppers will interact with your product information is by browsing through a categories menu.

Use the following endpoint to fetch category information:

Instead of browsing categories, shoppers may prefer to type a keyword into your store’s search bar to find what they want. VTEX provides two different search solutions for your store. We recommend that you use Intelligent Search, but you have the option to use the Legacy CMS Portal search if you wish.

Learn more about VTEX Intelligent Search.

Before implementing Intelligent Search in your headless storefront, make sure to check this Intelligent Search guide and make the necessary configurations.

To retrieve products with the Intelligent Search API, use this endpoint:

For any given Intelligent Search query, you can get search facets and display them so that your shoppers can narrow their search.

Shoppers may have trouble coming up with the optimal search term for their needs. Use these endpoints to help fill in the gaps:


You can use the Intelligent Search banners feature with this endpoint:

Intelligent Search autocomplete

You can also improve shopping experience by implementing an autocomplete feature. Use this endpoint to get suggested search terms based on a provided term:

You can also get the most searched terms on your site:

To retrieve products with the Legacy Search, use this endpoint:

Note that this endpoint provides multiple filtering and ordering options that can be made available for the shopper to narrow their search, improving the user’s experience. Handy examples include:

  • Searching within specific category levels (department, category and subcategory): https://{accountName}.vtexcommerce{environment}{department}/{category}/{subcategory}
  • Filtering products by collection: query string fq=productClusterIds:{collectionId}
  • Sorting by best discount: query string O=OrderByBestDiscountDESC

See the Search endpoint documentation to learn about all filtering and sorting options.

Legacy Search autocomplete

You can also implement an autocomplete feature to your store’s search bar using Legacu Search. To do this, use this endpoint:

Product details

On product pages and maybe other sections of your headless store, you will need to get information on specific products. To do this, you can use one of these endpoints:

Cross selling

When a shopper is interested in a product, it may be a good idea to display related products that they may be interested in purchasing as well.

See this guide to learn how to set up cross selling capabilities and use the endpoints below to retrieve this information on your storefront:

Learn more

See these other guides to learn more about building a headless shopping experience using VTEX:

Photo of the contributor
Photo of the contributor
+ 2 contributors
Was this helpful?
Suggest edits (Github)
Photo of the contributor
Photo of the contributor
+ 2 contributors
On this page