[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 install an app with a major other than 0x 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-install-an-app-with-a-major-other-than-0x/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/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-install-an-app-with-a-major-other-than-0x/docs/troubleshooting)

Development

I can't install an app with a major other than 0.x

The app major conflicts with the installed Edition App.

**Keywords:** Apps | Edition App

If you're unable to install an app with a major [version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-releasing-a-new-app-version%23understanding-app-versioning) other than `0.x`, follow the instructions below.

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

## Solution

Run `vtex ls` to check which apps are included on the [Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app) installed on your account. If you see the app you're trying to install with another major, there might be an issue with the Edition App installed on your account.

If this is the case, consider [opening a support ticket](https://read.calvincode.net/reader?url=https://support.vtex.com/hc/en-us/requests) to request a change to the Edition App installed on your account. See the [Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app) article to learn more about the available Edition Apps.

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/_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-install-an-app-with-a-major-other-than-0x/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F7026595%3Fv%3D4%26w=64%26q=75)](https://github.com/henriquessb)

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-install-an-app-with-a-major-other-than-0x.md)

[I can't create a new workspace« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/troubleshooting/i-cant-create-a-new-workspace)[I don't see my Store Theme changesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/troubleshooting/i-dont-see-my-store-theme-changes)

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/_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-install-an-app-with-a-major-other-than-0x/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F7026595%3Fv%3D4%26w=64%26q=75)](https://github.com/henriquessb)

ON THIS PAGE

[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x%23solution)

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-install-an-app-with-a-major-other-than-0x.md)

Copy page

On this page

ON THIS PAGE

[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x%23solution)

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 product summary productsummaryshelf 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.product-summary/ProductSummaryShelf/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/ProductSummaryShelf/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.product-summary/ProductSummaryShelf/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/ProductSummaryShelf/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.product-summary/ProductSummaryShelf/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/ProductSummaryShelf/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.product-summary/ProductSummaryShelf/updates/release-notes)

VTEX IO Apps

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

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

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

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

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

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

---

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

VTEX IO Apps

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

Product Summary Shelf

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

Version: 2.91.0

Latest version: 2.91.0

The Product Summary Shelf is the main block exported by the [Product Summary app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary). It includes the child blocks required to display the Product Summary component in your store.

![{"base64":"  ","img":{"width":2852,"height":1550,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":543765,"url":"https://user-images.githubusercontent.com/40380674/96649443-7d21d480-1307-11eb-9100-534fa9e70ca6.png"}}](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/40380674/96649443-7d21d480-1307-11eb-9100-534fa9e70ca6.png)

)

## Configuration

1. Import the `vtex.product-summary` app to your theme dependencies in the `manifest.json` file:

`1

 dependencies: {

2

 "vtex.product-summary": "2.x"

3

 }

`

1. Add the `product-summary.shelf` block as a child of the [list-context.product-list block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarylist%23product-list-block):

`1

 "list-context.product-list": {

2

+ "blocks": ["product-summary.shelf"]

3

 },

`

1. Declare the `product-summary.shelf` block, passing the desired blocks exported by the Product Summary app to build your Product Summary component. For example:

`1

{

2

+ "product-summary.shelf": {

3

+ "children": [

4

+ "product-summary-image",

5

+ "product-summary-name",

6

+ "product-rating-inline",

7

+ "product-summary-space",

8

+ "product-summary-price",

9

+ "product-summary-buy-button"

10

+ ]

11

+ }

12

}

`

> Remember to define the other Product Summary blocks in your theme, otherwise the component will not be displayed.

| Prop name              | Type    | Description                                                                                | Default value                 |
| ---------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |
| priceBehavior          | enum    | Determines whether the component should fetch the most up-to-date price (async) or (default). Remember to configure the [Search Result](https://read.calvincode.net/reader?url=https://vtex.io/docs/components/content-blocks/vtex.search-result@3.79.1/%23configuration)'s simulationBehavior prop to skip and use the Product Price [product-price-suspense](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/product-price/blob/master/docs/README.md) block to render a loading spinner while the price information is being fetched. | default                       |
| trackListName          | boolean | Determines whether the component should send the list name to the product page when the product summary is clicked. Disabling it will prevent the productDetail GTM event sent on the PDP to identify from which list the user navigated.                                                                                | true                          |
| sponsoredBadgeLabel    | String  | The text of the "Sponsored" tag, if applicable.                                                                                | "store/sponsored-badge.label" |
| sponsoredBadgePosition | enum    | The position of the "Sponsored" tag, if applicable. Possible values are titleTop, containerTopLeft and none.                                                                                | "containerTopLeft"            |

## Customization

The Product Summary Shelf merely establishes the block structure to render the Product Summary component. Therefore, this block does not have CSS Handles for its specific customization.

Instead, you should use its child block Handles.

See also

[Vtex.product SummaryVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/ProductSummaryShelf/docs/apps/vtex.product-summary)[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.product-summary/ProductSummaryShelf/docs/apps/vtex.product-summary/ProductSummaryShelf%23configuration)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/ProductSummaryShelf/docs/apps/vtex.product-summary/ProductSummaryShelf%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] How do I use the VTEX product list 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.product-list/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/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.product-list/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/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.product-list/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/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.product-list/updates/release-notes)

VTEX IO Apps

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

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

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

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

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

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

---

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

VTEX IO Apps

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

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

Product List

Official extension

Version: 0.37.4

Latest version: 0.37.4

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

The Product List component displays all items in the user's cart and informs users when items are unavailable.

> Currently, the Product List only works with [Minicart v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/).

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

## Configuration

1. Add the Product List app to your theme dependencies in `manifest.json`. For example:

`1

 "dependencies": {

2

 "vtex.product-list": "0.x"

3

 }

`

1. Add the `product-list` block to the `minicart-product-list` block (exported by the Minicart app). For example:

`1

 "minicart-product-list#example": {

2

 "blocks": ["product-list"]

3

 }

`

Once you have added the `product-list` to the `minicart-product-list`, no further actions are required, as the block works with a default implementation behind the scenes. This means that the Product List component is ready to be rendered.

### Advanced configuration

Currently, the `product-list` default implementation is the following:

`1

{

2

 "product-list": {

3

 "blocks": [

4

 "product-list-content-desktop",

5

 "product-list-content-mobile"

6

 ]

7

 },

8

 "product-list-content-desktop": {

9

 "children": ["flex-layout.row#list-row.desktop"]

10

 },

11

 "flex-layout.row#list-row.desktop": {

12

 "children": [

13

 "flex-layout.col#image.desktop",

14

 "flex-layout.col#main-container.desktop"

15

 ],

16

 "props": {

17

 "fullWidth": true,

18

 "paddingBottom": "7",

19

 "paddingTop": "6",

20

 "colSizing": "auto",

21

 "preserveLayoutOnMobile": "true"

22

 }

23

 },

24

 "flex-layout.col#image.desktop": {

25

 "children": ["product-list-image"],

26

 "props": {

27

 "marginRight": "6"

28

 }

29

 },

30

 "flex-layout.col#main-container.desktop": {

31

 "children": [

32

 "flex-layout.row#sub-container.desktop",

33

 "flex-layout.row#message.desktop"

34

 ],

35

 "props": {

36

 "width": "grow"

37

 }

38

 },

39

 "flex-layout.row#sub-container.desktop": {

40

 "children": [

41

 "flex-layout.col#product-description",

42

 "flex-layout.col#quantity.desktop",

43

 "flex-layout.row#price-remove"

44

 ],

45

 "props": {

46

 "preserveLayoutOnMobile": "true",

47

 "colSizing": "auto"

48

 }

49

 },

50

 "flex-layout.col#quantity.desktop": {

51

 "children": [

52

 "flex-layout.row#quantity-selector.desktop",

53

 "flex-layout.row#unit-price.desktop"

54

 ],

55

 "props": {

56

 "marginLeft": "8"

57

 }

58

 },

59

 "flex-layout.row#price-remove": {

60

 "children": [

61

 "flex-layout.col#price.desktop",

62

 "flex-layout.col#remove-button.desktop"

63

 ],

64

 "props": {

65

 "colSizing": "auto"

66

 }

67

 },

68

 "flex-layout.row#quantity-selector.desktop": {

69

 "children": ["quantity-selector"],

70

 "props": {

71

 "preventHorizontalStretch": "true"

72

 }

73

 },

74

 "flex-layout.row#unit-price.desktop": {

75

 "children": ["unit-price#desktop"],

76

 "props": {

77

 "marginTop": "3",

78

 "preventHorizontalStretch": "true"

79

 }

80

 },

81

 "unit-price#desktop": {

82

 "props": {

83

 "textAlign": "center"

84

 }

85

 },

86

 "flex-layout.col#price.desktop": {

87

 "children": ["price#desktop"],

88

 "props": {

89

 "blockClass": "priceWrapper",

90

 "marginLeft": "6",

91

 "preventHorizontalStretch": "true",

92

 "verticalAlign": "middle"

93

 }

94

 },

95

 "price#desktop": {

96

 "props": {

97

 "textAlign": "right"

98

 }

99

 },

100

 "flex-layout.col#remove-button.desktop": {

101

 "children": ["remove-button"],

102

 "props": {

103

 "marginLeft": "6",

104

 "verticalAlign": "middle"

105

 }

106

 },

107

 "flex-layout.row#message.desktop": {

108

 "children": ["message#desktop"],

109

 "props": {

110

 "marginTop": "4"

111

 }

112

 },

113

 "message#desktop": {

114

 "props": {

115

 "layout": "cols"

116

 }

117

 },

118

 "product-list-content-mobile": {

119

 "children": ["flex-layout.row#list-row.mobile"]

120

 },

121

 "flex-layout.row#list-row.mobile": {

122

 "children": [

123

 "flex-layout.col#image.mobile",

124

 "flex-layout.col#main-container.mobile"

125

 ],

126

 "props": {

127

 "fullWidth": true,

128

 "paddingBottom": "6",

129

 "paddingTop": "5",

130

 "colSizing": "auto",

131

 "preserveLayoutOnMobile": "true"

132

 }

133

 },

134

 "flex-layout.col#image.mobile": {

135

 "children": ["product-list-image"],

136

 "props": {

137

 "marginRight": "5"

138

 }

139

 },

140

 "flex-layout.col#main-container.mobile": {

141

 "children": [

142

 "flex-layout.row#top.mobile",

143

 "flex-layout.row#quantity-selector.mobile",

144

 "flex-layout.row#unit-price.mobile",

145

 "flex-layout.row#price.mobile",

146

 "flex-layout.row#message.mobile"

147

 ],

148

 "props": {

149

 "width": "grow"

150

 }

151

 },

152

 "flex-layout.row#top.mobile": {

153

 "children": [

154

 "flex-layout.col#product-description",

155

 "flex-layout.col#remove-button.mobile"

156

 ],

157

 "props": {

158

 "colSizing": "auto",

159

 "preserveLayoutOnMobile": "true"

160

 }

161

 },

162

 "flex-layout.row#quantity-selector.mobile": {

163

 "children": ["quantity-selector"],

164

 "props": {

165

 "marginTop": "5",

166

 "preventHorizontalStretch": "true"

167

 }

168

 },

169

 "flex-layout.row#unit-price.mobile": {

170

 "children": ["unit-price"],

171

 "props": {

172

 "marginTop": "3"

173

 }

174

 },

175

 "flex-layout.row#price.mobile": {

176

 "children": ["price#mobile"],

177

 "props": {

178

 "marginTop": "5",

179

 "preventHorizontalStretch": "true"

180

 }

181

 },

182

 "price#mobile": {

183

 "props": {

184

 "textAlign": "left"

185

 }

186

 },

187

 "flex-layout.col#remove-button.mobile": {

188

 "children": ["remove-button"],

189

 "props": {

190

 "marginLeft": "3"

191

 }

192

 },

193

 "flex-layout.row#message.mobile": {

194

 "children": ["message#mobile"],

195

 "props": {

196

 "marginTop": "3"

197

 }

198

 },

199

 "message#mobile": {

200

 "props": {

201

 "layout": "rows"

202

 }

203

 }

204

}

`

The default implementation means that whenever you declare the `product-list` block in your store, you are actually telling your theme to render the above `json` behind the scenes.

In order to customize the `product-list` configuration, copy the code above, paste it, and change it as you wish.

| Block name                   | Description                                                                                |
| ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| product-list                 | ![{"base64":"  ","img":{"width":69,"height":20,"type":"svg","mime":"image/svg+xml","wUnits":"px","hUnits":"px","url":"https://img.shields.io/badge/-Mandatory-red"}}](https://read.calvincode.net/reader?url=https://img.shields.io/badge/-Mandatory-red) Top level block that must be declared in the minicart-product-list block to render a default detailed list with all products added to the shopping cart. |
| product-list-content-desktop | Creates the product list layout for desktop devices.                                                                                |
| product-list-content-mobile  | Creates the product list layout for mobile devices.                                                                                |
| message                      | Renders a message about the product availability.                                                                                |
| product-name                 | Renders the product names.                                                                                |
| product-reference            | Renders the product reference information.                                                                                |
| price                        | Renders the product prices.                                                                                |
| unit-price                   | Renders the price for each unit of the product added to the cart.                                                                                |
| product-list-image           | Renders the product images.                                                                                |
| product-brand                | Renders the product brands.                                                                                |
| product-variations           | Renders the product variations.                                                                                |
| product-quantity-label       | Renders a product label that displays the number of items added to the cart.                                                                                |
| quantity-selector            | Renders a selector that allows users to choose how many units of a product they want to add to the cart.                                                                                |
| remove-button                | Renders a button that allows users to remove a product from the list.                                                                                |

### `minicart-product-list` props

| Prop name | Type    | Description                                                                                | Default value |
| --------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| splitItem | boolean | Determines whether products with attachments should be split and treated as individual items (true) or as a single item (false) when their quantity is increased in the minicart. | false         |

### `product-list` props

| Prop name        | Type   | Description                                                                                | Default value |
| ---------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| itemCountMode    | enum   | Quantity badge behavior when displaying the total number of items added in Minicart. Possible values are: total (the quantity badge displays the number of items added to the cart), distinct (the quantity badge only displays the number of different products added to the cart), totalAvailable (the quantity badge displays the number of available items added to the cart), and distinctAvailable (the quantity badge only displays the number of different and available products added to the cart). | distinct      |
| lazyRenderHeight | number | The height (px) of each item loading element.                                                                                | 100           |
| lazyRenderOffset | number | The distance (px) that each item should be from the viewport at the time of its rendering.                                                                                | 300           |

### `message` props

| Prop name | Type | Description                                                                                | Default value |
| --------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| layout    | enum | Position of the availability message in the list. Possible values are: rows (displaying the message in the product row) or cols (displaying the message in the product column). | cols          |

### `price` props

| Prop name     | Type    | Description                                                                    | Default value |
| ------------- | ------- | ------------------------------------------------------------------------------ | ------------- |
| textAlign     | string  | Position of the product's price in the list.                                   | left          |
| showListPrice | boolean | Whether the product prices should be displayed in the list: (true) or (false). | true          |

### `unit-price` props

| Prop name            | Type   | Description                                                                                | Default value |
| -------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |
| textAlign            | string | Position of the product's unit price in the list.                                                                                | left          |
| unitPriceType        | enum   | Defines whether the price type should be displayed. Possible values are: sellingPrice or price                                                                                | price         |
| unitPriceDisplay     | enum   | Defines when the unit price should be displayed. Possible values are: always (unit price is always displayed) or default (unit price is only displayed when the number of products is greater than one).                       | default       |
| displayUnitListPrice | enum   | Defines whether the product list price should be displayed. Possible values are: showWhenDifferent (the list price is displayed when it is different from the regular price), and notShow (the list price is never displayed). | notShow       |

### `product-list-image` props

| Prop name | Type   | Description                      | Default value |
| --------- | ------ | -------------------------------- | ------------- |
| width     | number | Product image width (in pixels). | 96            |

### `product-reference` props

| Prop name       | Type   | Description                                                                                | Default value      |
| --------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
| identifierLabel | string | Text label to be displayed to the left of the product reference value.                                                                                | undefined          |
| identifyOption  | enum   | Desired product reference data, i.e., product identifier, to be displayed. Possible options are: ProductId, ProductSkuItemId, ProductReferenceId, and ProductSkuReferenceId. | ProductReferenceId |

### `remove-button` props

| Prop name   | Type | Description                                                                                | Default value |
| ----------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |
| variation   | enum | Variation for the button's visual prominence based on the [VTEX Styleguide](https://read.calvincode.net/reader?url=https://styleguide.vtex.com/%23/Components/Forms/Button). Possible values are: primary, secondary, tertiary, inverted-tertiary, danger, and danger-tertiary.                                                                                | danger        |
| displayMode | enum | Defines how the remove button should be displayed. Possible values are: icon-button (renders an icon button), and text-button (renders a text message button). If you want to [create a modal in the remove button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-modals-using-icons), use the icon-button value. | icon-button   |

### `quantity-selector` props

| Prop name            | Type | Description                                                                                | Default value  |
| -------------------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------- |
| mode                 | enum | Type of quantity selector input. Possible values are default, and stepper. In the default mode, the quantity stepper will initially render a dropdown component, and after the quantity exceeds 10, it will switch to an input. The stepper mode will always render a numeric stepper component. | default        |
| quantitySelectorStep | enum | Defines how the number of products that have unitMultiplier will work. Possible values are: singleUnit (the quantity will be not affected with the unitMultiplier), and unitMultiplier (the quantity will be affected with the unitMultiplier).                                                  | unitMultiplier |

## Customization

To apply CSS customizations to this and other blocks, 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 Handles                        |
| ---------------------------------- |
| availabilityMessageContainer       |
| availabilityMessageTextContainer   |
| availabilityMessageText            |
| productBrandName                   |
| productImageAnchor                 |
| productImageContainer              |
| productImage                       |
| productListAvailableItemsMessage   |
| productListItem                    |
| productListUnavailableItemsMessage |
| productName                        |
| productPriceContainer              |
| productPriceCurrency               |
| productPrice                       |
| productQuantityLabel               |
| productIdentifier                  |
| productIdentifierValue             |
| productIdentifierLabelValue        |
| productVariationsContainer         |
| productVariationsItem              |
| quantityDropdownContainer          |
| quantityDropdownMobileContainer    |
| quantityInputContainer             |
| quantityInputMobileContainer       |
| quantitySelectorContainer          |
| quantitySelectorWrapper            |
| quantitySelectorButton             |
| quantitySelectorDecrease           |
| quantitySelectorIncrease           |
| removeButtonContainer              |
| item                               |
| removeButton                       |
| unitPriceContainer                 |
| unitListPrice                      |
| unitPriceMeasurementUnit           |
| unitPricePerUnitCurrency           |

[Product Identifier« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-identifier)[Product PriceNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-price)

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.product-list/docs/apps/vtex.product-list%23configuration)

[Advanced configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-list%23advanced-configuration)[minicart-product-list props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-list%23minicart-product-list-props)[product-list props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-list%23product-list-props)[message props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-list%23message-props)[price props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-list%23price-props)[unit-price props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-list%23unit-price-props)[product-list-image props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-list%23product-list-image-props)[product-reference props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-list%23product-reference-props)[remove-button props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-list%23remove-button-props)[quantity-selector props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-list%23quantity-selector-props)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list/docs/apps/vtex.product-list%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=)