[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides vtex io documentation frequently asked questions in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/updates/release-notes)

App Development

[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-what-is-vtex-io)

---

[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-what-is-a-vtex-app)

---

[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/governance-and-shared-security-in-vtex-io-apps)

---

[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/code-samples)

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-getting-started)

---

Project structure

---

[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)

---

[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-workspace)

---

Managing apps

---

Development guides

---

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/app-development-guides)

---

[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/graphql-in-vtex-io)

---

[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-policies)

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/ab-tests)

---

[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)

---

[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-app-store)

---

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/managing-edition-apps)

---

[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/updates/release-notes)

App Development

[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-what-is-vtex-io)

---

[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-what-is-a-vtex-app)

---

[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/governance-and-shared-security-in-vtex-io-apps)

---

[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/code-samples)

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-getting-started)

---

Project structure

---

[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)

---

[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-workspace)

---

Managing apps

---

Development guides

---

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/app-development-guides)

---

[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/graphql-in-vtex-io)

---

[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-policies)

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/ab-tests)

---

[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)

---

[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-app-store)

---

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/managing-edition-apps)

---

[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions)

---

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/app-development)

[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions)

Frequently asked questions

This FAQ provides detailed information on VTEX IO and the VTEX IO Store Framework, covering their usage, access requirements, cost, and support options.

## VTEX IO

### What can I develop with VTEX IO?

VTEX IO enables you to build:

* **Storefront apps:** Design tailored storefront components with React.
* **Admin apps:** Extend your store's admin capabilities with additional applications.
* **Backend apps:** Create backend services for integration with Storefront or Admin apps, using Node or .NET Core.
* **Pixel apps:** Develop pixel apps to gather user data for integration with third-party services.

### Who can use VTEX IO?

VTEX IO access is generally limited to a small group of developers as a closed beta, except for custom storefront apps.

* **Closed beta access:** To join the closed beta for project types like Admin, backend, and pixel, you must meet one of the following criteria:
   * Enterprise VTEX Accounts: Users on an Enterprise plan can verify eligibility based on their contract.
   * Partners: VTEX IO-certified development partners are eligible for closed beta access.
* **Storefront apps:** All VTEX accounts and partners can develop storefront apps without restrictions. This option allows you to build React-based storefronts to suit your specific business needs, regardless of your VTEX plan or certification status.

### I meet all the necessary prerequisites. What do I need to do to start developing?

If you meet the prerequisites for closed beta access, complete the [Application form](https://read.calvincode.net/reader?url=https://forms.gle/f7bYdTA7tfdfB5tt7) with your project details. Review the guidelines on [filling out the application form for development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-filling-the-application-form-for-development/) to ensure you meet all criteria.

> **Note:** No application is needed to develop storefront apps.

### How much does it cost?

Currently, developing on VTEX IO does not incur additional fees.

### What type of support is available?

Custom apps are the responsibility of their developers. VTEX does not provide support for custom apps.

## VTEX IO Store Framework

### What are the advantages of building with the Store Framework?

The Store Framework is designed to reduce time-to-market, lower maintenance costs, and provide extensive customization options for storefront development. It is backed by an active developer community that contributes enhancements to store blocks, fostering scalable and customizable storefronts.

### Can I customize Store Framework blocks?

Yes, Store Framework blocks are designed with flexibility in mind. Each block comes with configurable properties and CSS Handles, allowing you to adapt styling and behavior to match your brand and design requirements, making it easier to build a distinct store identity and streamline implementation time.

For more complex needs, custom apps and components can be created. However, note that VTEX does not provide support for third-party apps; the app vendor is responsible for maintaining and supporting these custom solutions.

### Who can use Store Framework?

All VTEX accounts can use Store Framework, as it is available in open beta. However, as an open-source project in active development, expect ongoing updates and improvements.

### How much does Store Framework cost?

The Store Framework is included by default in VTEX contracts, with no additional cost for clients.

### What support is available for Store Framework?

VTEX provides support for all native Store Framework blocks, so any issues related to these blocks can be resolved by opening a [support ticket](https://read.calvincode.net/reader?url=https://help-tickets.vtex.com/smartlink/sso/login/zendesk) with the VTEX Support team.

Being open-source, the Store Framework also benefits from a community-driven support network. Users can request new features, report bugs, and engage with other developers via the [VTEX Community](https://read.calvincode.net/reader?url=https://community.vtex.com/), and follow updates in our [Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/updates/release-notes).

### How do I get started with Store Framework?

To start building with Store Framework, check out our [Getting Started guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3).

> Need additional assistance? If you have questions not covered here, feel free to [VTEX support](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/opening-tickets-to-vtex-support--16yOEqpO32UQYygSmMSSAM) for further help.

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Hello/vtex-io-documentation-frequently-asked-questions.md)

[Seller Portal Edition App« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions//docs/guides/seller-portal-edition-app)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

ON THIS PAGE

[VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23vtex-io)

[What can I develop with VTEX IO?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23what-can-i-develop-with-vtex-io)[Who can use VTEX IO?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23who-can-use-vtex-io)[I meet all the necessary prerequisites. What do I need to do to start developing?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23i-meet-all-the-necessary-prerequisites-what-do-i-need-to-do-to-start-developing)[How much does it cost?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23how-much-does-it-cost)[What type of support is available?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23what-type-of-support-is-available)

[VTEX IO Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23vtex-io-store-framework)

[What are the advantages of building with the Store Framework?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23what-are-the-advantages-of-building-with-the-store-framework)[Can I customize Store Framework blocks?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23can-i-customize-store-framework-blocks)[Who can use Store Framework?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23who-can-use-store-framework)[How much does Store Framework cost?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23how-much-does-store-framework-cost)[What support is available for Store Framework?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23what-support-is-available-for-store-framework)[How do I get started with Store Framework?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23how-do-i-get-started-with-store-framework)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Hello/vtex-io-documentation-frequently-asked-questions.md)

Copy page

On this page

ON THIS PAGE

[VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23vtex-io)

[What can I develop with VTEX IO?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23what-can-i-develop-with-vtex-io)[Who can use VTEX IO?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23who-can-use-vtex-io)[I meet all the necessary prerequisites. What do I need to do to start developing?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23i-meet-all-the-necessary-prerequisites-what-do-i-need-to-do-to-start-developing)[How much does it cost?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23how-much-does-it-cost)[What type of support is available?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23what-type-of-support-is-available)

[VTEX IO Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23vtex-io-store-framework)

[What are the advantages of building with the Store Framework?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23what-are-the-advantages-of-building-with-the-store-framework)[Can I customize Store Framework blocks?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23can-i-customize-store-framework-blocks)[Who can use Store Framework?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23who-can-use-store-framework)[How much does Store Framework cost?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23how-much-does-store-framework-cost)[What support is available for Store Framework?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23what-support-is-available-for-store-framework)[How do I get started with Store Framework?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions/docs/guides/vtex-io-documentation-frequently-asked-questions%23how-do-i-get-started-with-store-framework)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] How do I use the VTEX menu app? Provide documentation and configuration details.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/updates/release-notes)

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/basic-components)

[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.add-to-cart-button)

[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.search/Autocomplete)

[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.search/banner)

[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.breadcrumb)

[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.store-footer)

[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/google-one-tap-login)

[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.store-header)

[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.locale-switcher)

[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.login)

[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.menu)

[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.minicart)

[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.order-placed)

[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-customizer)

[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-highlights)

[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-identifier)

[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-list)

[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-price)

[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-quantity)

[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-specifications)

[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary)

[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummaryattachmentlist)

[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummarybuybutton)

[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummarydescription)

[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummaryimage)

[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummarylist)

[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummaryname)

[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummaryshelf)

[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummaryskuselector)

[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummaryskuname)

[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.rich-text)

[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.search)

[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.search/suggestions)

[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.search/didyoumean)

[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.search-result)

[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.store-image)

---

[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/store-components)

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/advanced-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.b2b-suite)

---

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/functional-apps)

---

[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/layout-apps)

---

[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/pixel-apps)

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.my-account)

---

[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/vtex-io-deprecated-apps)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/updates/release-notes)

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/basic-components)

[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.add-to-cart-button)

[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.search/Autocomplete)

[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.search/banner)

[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.breadcrumb)

[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.store-footer)

[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/google-one-tap-login)

[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.store-header)

[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.locale-switcher)

[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.login)

[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.menu)

[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.minicart)

[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.order-placed)

[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-customizer)

[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-highlights)

[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-identifier)

[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-list)

[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-price)

[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-quantity)

[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-specifications)

[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary)

[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummaryattachmentlist)

[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummarybuybutton)

[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummarydescription)

[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummaryimage)

[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummarylist)

[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummaryname)

[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummaryshelf)

[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummaryskuselector)

[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.product-summary/productsummaryskuname)

[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.rich-text)

[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.search)

[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.search/suggestions)

[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.search/didyoumean)

[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.search-result)

[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.store-image)

---

[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/store-components)

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/advanced-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.b2b-suite)

---

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/functional-apps)

---

[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/layout-apps)

---

[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/pixel-apps)

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.my-account)

---

[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/vtex-io-deprecated-apps)

---

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/vtex-io-apps)

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/guides/basic-components)

Menu

Official extension

Version: 2.35.3

Latest version: 2.35.3

[![{"base64":"  ","img":{"width":110,"height":20,"type":"svg","mime":"image/svg+xml","wUnits":"px","hUnits":"px","url":"https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square"}}](https://read.calvincode.net/reader?url=https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors)

The Menu component displays a navigation bar with links and dropdown submenus. It can be configured to display internal or external links and supports both category-based and custom menu items.

![{"base64":"  ","img":{"width":2876,"height":1636,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":1421988,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-menu-0.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-menu-0.png)

## Configuration

1. Add the app to the store theme dependencies in the `manifest.json` file.

`1

 "dependencies": {

2

 "vtex.menu": "2.x"

3

 }

`

1. Add the `vtex.menu@2.x:menu` block to the [store header](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-header/blob/master/store/interfaces.json) template.
2. Configure the `menu-item` blocks to build the store menu options. These can be declared in two ways in `vtex.menu@2.x:menu`: as children or as props. The advantage of the second type of `menu-item` configuration is that Site Editor can be used to edit the blocks.

### `menu-item` as children

_Example:_

`1

"vtex.menu@2.x:menu#websites": {

2

 "children": [

3

 "menu-item#shop",

4

 "menu-item#about-us"

5

 ]

6

},

7

"menu-item#shop": {

8

 "props": {

9

 "id": "menu-item-shop",

10

 "type": "custom",

11

 "highlight": false,

12

 "itemProps": {

13

 "type": "internal",

14

 "href": "#",

15

 "noFollow": false,

16

 "tagTitle": "Shop",

17

 "text": "Shop"

18

 },

19

 "iconProps": {

20

 "id": "bnd-logo",

21

 "size": 16,

22

 "viewBox": "0 0 16 16",

23

 "activeClassName": "rebel-pink",

24

 "mutedClassName": "c-action-primary"

25

 },

26

 "iconToTheRight": true

27

 }

28

}

`

### `menu-item` as props

_Example:_

`1

"vtex.menu@2.x:menu#websites": {

2

 "props": {

3

 "items": [

4

 {

5

 "id": "menu-item-shop",

6

 "type": "custom",

7

 "highlight": false,

8

 "itemProps": {

9

 "type": "internal",

10

 "href": "#",

11

 "noFollow": false,

12

 "tagTitle": "Shop",

13

 "text": "Shop"

14

 }

15

 },

16

 {

17

 "id": "menu-item-about-us",

18

 "type": "custom",

19

 "highlight": false,

20

 "itemProps": {

21

 "type": "internal",

22

 "href": "/about-us",

23

 "noFollow": false,

24

 "tagTitle": "about-us",

25

 "text": "About Us"

26

 }

27

 }

28

 ]

29

 }

30

}

`

### Adding a submenu

You can define a submenu by adding the `submenu` block to a `menu-item`:

`1

"menu-item#shop": {

2

 "props": {

3

 "type": "custom",

4

 "highlight": false,

5

 "itemProps": {

6

 "type": "internal",

7

 "href": "#",

8

 "noFollow": false,

9

 "tagTitle": "Shop",

10

 "text": "Shop"

11

 },

12

 },

13

 "blocks": ["vtex.menu@2.x:submenu#shop"] // Defining a submenu

14

},

15

"vtex.menu@2.x:submenu#shop": {

16

 "children": [

17

 "vtex.menu@2.x:menu#submenushop"

18

 ]

19

},

20

"vtex.menu@2.x:menu#submenushop": {

21

 "children": [

22

 "menu-item#shop"

23

 ]

24

}

`

> The Menu block doesn't require any specific child blocks to work

## `menu-item` props

The available `menu-item` block props are:

| Prop name       | Type                       | Description                                                                                | Default value |
| --------------- | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| type            | string                     | Menu item type, either category or custom                                                                                | category      |
| id              | string                     | Menu item ID                                                                                | undefined     |
| highlight       | boolean                    | Indicates whether the item has a highlight                                                                                | undefined     |
| iconPosition    | string                     | Icon position relative to the menu item text, either to the left or right                                                                                | left          |
| iconProps       | IconProps                  | Icon props                                                                                | undefined     |
| onMountBehavior | enum                       | Indicates whether the submenu should always be automatically displayed when its parent is hovered/clicked on (open) or (close)                                                                                | closed        |
| itemProps       | CategoryItem or CustomItem | Item props                                                                                | undefined     |
| blockClass      | CustomCSSClasses           | Used to override default CSS handles. To learn how this prop works, check this description of [useCustomClasses](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/css-handles%23usecustomclasses). Please note that this is only useful when importing this block as a React component. | undefined     |

### Icon props

| Prop name       | Type    | Description                           | Default value |
| --------------- | ------- | ------------------------------------- | ------------- |
| id              | string  | Icon ID                               | N/A           |
| isActive        | boolean | Indicates if the item is active       | true          |
| size            | number  | Icon size                             | 16            |
| viewBox         | string  | Icon view box                         | 0 0 16 16     |
| activeClassName | string  | Icon classname when isActive is true  | N/A           |
| mutedClassName  | string  | Icon classname when isActive is false | N/A           |

### Category-specific props

| Prop name  | Type   | Description      | Default value |
| ---------- | ------ | ---------------- | ------------- |
| categoryId | number | Item category ID | N/A           |
| text       | string | Menu item text   | N/A           |

### Custom item props

| Prop name | Type    | Description                                 | Default value |
| --------- | ------- | ------------------------------------------- | ------------- |
| type      | string  | Menu item type, either internal or external | internal      |
| href      | string  | Link to the menu item destination           | N/A           |
| noFollow  | boolean | No follow attribute                         | N/A           |
| tagTitle  | string  | Menu item tag                               | N/A           |
| text      | string  | Menu item text                              | N/A           |

## Customization

To apply CSS customizations to this and other blocks, please follow the instructions in [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization).

| CSS Handle               |
| ------------------------ |
| accordionIcon--isClosed  |
| accordionIcon--isOpen    |
| accordionIcon            |
| container                |
| linkLeft                 |
| linkMiddle               |
| linkRight                |
| menuContainerNav         |
| menuContainer            |
| menuItemInnerDiv         |
| menuItem                 |
| menuItem--isOpen         |
| menuItem--isClosed       |
| menuLinkDivLeft          |
| menuLinkDivMiddle        |
| menuLinkDivRight         |
| menuLinkNav              |
| renderLink               |
| styledLinkContainer      |
| styledLinkContent        |
| styledLinkIcon           |
| styledLink               |
| submenuAccordion         |
| submenuColumn            |
| submenuContainer         |
| submenuWrapper--isClosed |
| submenuWrapper--isOpen   |
| submenuWrapper           |
| submenu                  |

[Login« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.login)[MinicartNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.minicart)

See also

[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)

ON THIS PAGE

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.menu%23configuration)

[menu-item as children](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.menu%23menu-item-as-children)[menu-item as props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.menu%23menu-item-as-props)[Adding a submenu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.menu%23adding-a-submenu)

[menu-item props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.menu%23menu-item-props)

[Icon props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.menu%23icon-props)[Category-specific props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.menu%23category-specific-props)[Custom item props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.menu%23custom-item-props)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu/docs/apps/vtex.menu%23customization)

Was this helpful?

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Explain troubleshooting i cant integrate my external search provider in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/updates/release-notes)

Troubleshooting

API

---

Development

[I am getting 500 errors in VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)

[I am getting errors with my service configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)

[Issues during extending the FastStore API schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)

[I can’t access the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/unable-to-access-headless-cms)

[I can’t install the Headless CMS plugins in my account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account)

[I can't install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-install-vtex-io-cli)

[I can’t integrate my external Search Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-integrate-my-external-search-provider)

[My multi-language store is not functioning in the development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)

[My store catalog does not display the price range filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter)

[My pages are taking too long to be published on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)

[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)

[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)

[The Price in the shelf or in the search results is different from the product page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)

[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)

[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)

[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-create-a-new-workspace)

[I can't install an app with a major other than 0.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)

[I don't see my Store Theme changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-dont-see-my-store-theme-changes)

---

Store performance

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/updates/release-notes)

Troubleshooting

API

---

Development

[I am getting 500 errors in VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)

[I am getting errors with my service configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)

[Issues during extending the FastStore API schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)

[I can’t access the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/unable-to-access-headless-cms)

[I can’t install the Headless CMS plugins in my account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account)

[I can't install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-install-vtex-io-cli)

[I can’t integrate my external Search Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-integrate-my-external-search-provider)

[My multi-language store is not functioning in the development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)

[My store catalog does not display the price range filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter)

[My pages are taking too long to be published on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)

[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)

[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)

[The Price in the shelf or in the search results is different from the product page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)

[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)

[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)

[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-create-a-new-workspace)

[I can't install an app with a major other than 0.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)

[I don't see my Store Theme changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-dont-see-my-store-theme-changes)

---

Store performance

---

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting)

Development

I can’t integrate my external Search Provider

Learn how to fix "Unknown errors" when integrating an external search provider with VTEX.

**Keywords:** Integration | VTEX Protocol | Search Protocol | Search Resolver | External Search Provider

When attempting to integrate an external search provider with the VTEX Platform as described in the guide [Implementing a Custom Search Resolver App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-search-provider-recipe), you may encounter "Unknown errors" that prevent successful integration.

These errors may occur due to outdated dependencies in your app.

## Solution

To fix any "Unknown errors" during search integration, follow these steps:

### Step 1 - Update the `vtex.search-graphql` dependency version

Make sure the `vtex.search-graphql` dependency in your `node/package.json` file is up-to-date with the latest version of the `vtex.search-graphql` app.

1. Open your app directory and go to the `node/package. json` file.
2. Locate the `vtex.search-graphql` dependency.
3. Compare the version listed in your `node/package.json` with the [latest version available for the vtex.search-graphql app](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/search-graphql/blob/master/manifest.json%23L4).
4. If your `vtex.search-graphql` dependency is outdated, update it to the latest version.
a. Edit the `node/package. json` file, updating the version number for `vtex.search-graphql`.
b. Save the changes to the `node/package. json` file.

### Step 2 - Install updated dependencies

After updating the `vtex.search-graphql` version, install the update dependencies:

1. Open a terminal and go to your app's `node` folder.
2. Run the following command to install the updated dependencies:
`1
yarn
`

### Step 3 - Re-link the app

After installing the updated dependencies, re-link the app to apply the changes. Run the following command:

`1

vtex link

`

If the issue persists, please open a ticket with [VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/support).

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F112641072%3Fv%3D4%26w=64%26q=75)](https://github.com/barbara-celi)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/development/i-cant-integrate-my-external-search-provider.md)

[I can't install VTEX IO CLI« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-install-vtex-io-cli)[My multi-language store is not functioning in the development workspaceNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F112641072%3Fv%3D4%26w=64%26q=75)](https://github.com/barbara-celi)

ON THIS PAGE

[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-integrate-my-external-search-provider%23solution)

[Step 1 - Update the vtex.search-graphql dependency version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-integrate-my-external-search-provider%23step-1-update-the-vtexsearch-graphql-dependency-version)[Step 2 - Install updated dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-integrate-my-external-search-provider%23step-2-install-updated-dependencies)[Step 3 - Re-link the app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-integrate-my-external-search-provider%23step-3-re-link-the-app)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/development/i-cant-integrate-my-external-search-provider.md)

Copy page

On this page

ON THIS PAGE

[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-integrate-my-external-search-provider%23solution)

[Step 1 - Update the vtex.search-graphql dependency version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-integrate-my-external-search-provider%23step-1-update-the-vtexsearch-graphql-dependency-version)[Step 2 - Install updated dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-integrate-my-external-search-provider%23step-2-install-updated-dependencies)[Step 3 - Re-link the app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-integrate-my-external-search-provider/docs/troubleshooting/i-cant-integrate-my-external-search-provider%23step-3-re-link-the-app)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Explain troubleshooting the promotion highlight flag does not appear on the product in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/updates/release-notes)

Troubleshooting

API

---

Development

[I am getting 500 errors in VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)

[I am getting errors with my service configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)

[Issues during extending the FastStore API schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)

[I can’t access the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/unable-to-access-headless-cms)

[I can’t install the Headless CMS plugins in my account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account)

[I can't install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-cant-install-vtex-io-cli)

[I can’t integrate my external Search Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-cant-integrate-my-external-search-provider)

[My multi-language store is not functioning in the development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)

[My store catalog does not display the price range filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter)

[My pages are taking too long to be published on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)

[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)

[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)

[The Price in the shelf or in the search results is different from the product page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)

[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)

[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)

[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-cant-create-a-new-workspace)

[I can't install an app with a major other than 0.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)

[I don't see my Store Theme changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-dont-see-my-store-theme-changes)

---

Store performance

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/updates/release-notes)

Troubleshooting

API

---

Development

[I am getting 500 errors in VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)

[I am getting errors with my service configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)

[Issues during extending the FastStore API schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)

[I can’t access the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/unable-to-access-headless-cms)

[I can’t install the Headless CMS plugins in my account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account)

[I can't install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-cant-install-vtex-io-cli)

[I can’t integrate my external Search Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-cant-integrate-my-external-search-provider)

[My multi-language store is not functioning in the development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)

[My store catalog does not display the price range filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter)

[My pages are taking too long to be published on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)

[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)

[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)

[The Price in the shelf or in the search results is different from the product page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)

[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)

[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)

[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-cant-create-a-new-workspace)

[I can't install an app with a major other than 0.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)

[I don't see my Store Theme changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/i-dont-see-my-store-theme-changes)

---

Store performance

---

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting)

Development

The promotion highlight flag does not appear on the product

When creating a promotion and enabling the highlight option, the product does not display the highlight flag in the store.

In stores developed with VTEX IO Store Framework, when creating a promotion and [enabling the highlight option](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/configurando-promocao-com-destaque-flag--tutorials%5F2295%23configuring-the-promotion), the corresponding flag may not appear on the product.

This behavior may occur due to the absence of the [product-highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-highlights) component on the corresponding page.

## Solution

To display the promotion highlight on a product, follow the steps below.

### Check the promotion setup

Make sure your promotion is configured properly and has the highlight option enabled. You can check this directly in the VTEX Admin or using a VTEX API.

#### VTEX Admin

1. In the VTEX Admin, go to **Promotions > Promotions**.
2. Open the promotion you configured.
3. Confirm the promotion is highlighted.

![{"base64":"  ","img":{"width":388,"height":289,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":8708,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/docs/troubleshooting/development/is-featured-en.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/docs/troubleshooting/development/is-featured-en.png)

#### VTEX API

Using the [Get promotion or tax by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api%23get-/api/rnb/pvt/calculatorconfiguration/-idCalculatorConfiguration-) API, check if the `isFeatured` field is set as **true**.

### Check the `product-highlights` component

1. Open the Store Theme app using any code editor, such as Visual Studio Code.
2. Go to the page template where the product should be displayed with the highlight flag.
3. Check if the template has a product highlight block declared.

> The Product Highlights blocks require a product context to work properly. Therefore, when declaring these blocks, ensure that they are placed in a theme template or a block where this context is available, such as `store.product` and `product-summary.shelf`.

1. If a product highlight block is not declared, follow the [Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-highlights) documentation to set it up.

If the problem continues, open a ticket with [VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support).

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F112641072%3Fv%3D4%26w=64%26q=75)](https://github.com/barbara-celi)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/development/the-promotion-highlight-flag-does-not-appear-on-the-product.md)

[The Price in the shelf or in the search results is different from the product page« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)[vtex release CLI command returns an EBADF messageNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F112641072%3Fv%3D4%26w=64%26q=75)](https://github.com/barbara-celi)

ON THIS PAGE

[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product%23solution)

[Check the promotion setup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product%23check-the-promotion-setup)[Check the product-highlights component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product%23check-the-product-highlights-component)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/development/the-promotion-highlight-flag-does-not-appear-on-the-product.md)

Copy page

On this page

ON THIS PAGE

[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product%23solution)

[Check the promotion setup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product%23check-the-promotion-setup)[Check the product-highlights component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product%23check-the-product-highlights-component)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)