id
stringlengths 12
53
| messages
listlengths 3
3
|
|---|---|
doc_7252464d
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides store framework configuring analytics google tag manager in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Installing Google Tag Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/vtex-io-documentation-installing-google-tag-manager)\n\n[Setting up Google Tag Manager events and triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Installing Google Tag Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/vtex-io-documentation-installing-google-tag-manager)\n\n[Setting up Google Tag Manager events and triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/store-framework)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\nConfiguring Analytics (Google Tag Manager)\n\nDiscover how to manage Analytics on Store Framework using the Google Tag Manager app.\n\nTo manage Analytics on [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework), you need to install the [Google Tag Manager (GTM) app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager), which is a first-party solution that integrates your VTEX account with [Google Tag Manager](https://read.calvincode.net/reader?url=https://tagmanager.google.com), a JavaScript and HTML tag management system provided by Google for tracking user browsing.\n\nThe app allows you to manage website tags without accessing the store source code, allowing you to add, edit, or remove tags easily, and provides user browsing tracking for Google Analytics.\n\n> This app is only available for stores built with [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework). For stores built with Legacy CMS Portal, see [Configuring Google Tag Manager](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-to-setup-google-analytics-in-vtex-store--G2P0rmSrEiqCcmUMyUUwG%23configuring-google-tag-manager).\n\n\n\n[Installing Google Tag ManagerLearn how to install the Google Tag Manager app in your VTEX store.Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/vtex-io-documentation-installing-google-tag-manager)[Setting up Google Tag ManagerSet up the Google Tag Manager app with variables, triggers, and tags.Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/store-framework-configuring-analytics-google-tag-manager.md)\n\n[Using events to trigger side effects on store components« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager//docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components)[Installing Google Tag ManagerNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-configuring-analytics-google-tag-manager//docs/guides/vtex-io-documentation-installing-google-tag-manager)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/store-framework-configuring-analytics-google-tag-manager.md)\n\nCopy page\n\nOn this page\n\nOn this page\n\n[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=)"
}
] |
doc_193c4ab0
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation sponsor account in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[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-sponsor-account/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/api-reference)\n\n[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-sponsor-account/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/storefront-development)\n\n[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-sponsor-account/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/troubleshooting)\n\n[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-sponsor-account/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/managing-edition-apps)\n\n[Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-edition-app)\n\n[Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-sponsor-account)\n\n[Becoming a Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-becoming-a-sponsor-account)\n\n[Developing an Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-configuring-an-edition-app)\n\n[Updating Edition apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-updating-edition-apps)\n\n[Seller Portal Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/seller-portal-edition-app)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/managing-edition-apps)\n\n[Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-edition-app)\n\n[Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-sponsor-account)\n\n[Becoming a Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-becoming-a-sponsor-account)\n\n[Developing an Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-configuring-an-edition-app)\n\n[Updating Edition apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-updating-edition-apps)\n\n[Seller Portal Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/seller-portal-edition-app)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/app-development)\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/managing-edition-apps)\n\n[Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-sponsor-account)\n\nSponsor Account\n\nLearn what a Sponsor Account is and streamline the management of Edition Apps within your accounts ecosystem.\n\nA Sponsor Account is responsible for the development, maintenance, and distribution of [Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app). Its primary objective is to streamline the installation of multiple apps and configurations across a defined group of accounts. This is particularly valuable for organizations with hierarchical relationships among their accounts, such as the main VTEX account of a holding company or a brand with multiple sub-brands.\n\n## Account hierarchy\n\nThe image below exemplifies the hierarchy among VTEX accounts.\n\n\n\n### The `vtex` account\n\nAt the top of this hierarchy is the `vtex` account, which assumes the role of a Sponsor Account for all other accounts on the VTEX platform. This is because the `vtex` account is responsible for the development and release of the two native Edition Apps that all others derive from:\n\n* Edition Business (`vtex.edition-business@0.x`): Installs all the necessary apps to build a store with [Legacy CMS Portal](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/o-que-e-o-cms--EmO8u2WBj2W4MUQCS8262).\n* Edition Store (`vtex.edition-store@2.x`): Installs all the necessary apps to develop a store with the [Store Framework.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-store-framework)\n\n### Secondary Sponsor Accounts\n\nIn the second level of the account hierarchy, accounts that meet the [requirements to become a Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account) (e.g., `account2`) can release their own Edition App. These apps allow the Sponsor Account to enforce the installation of specific bundles of apps and settings in their child accounts (e.g., `account4`, `account5`, `account6`).\n\nBecoming a Sponsor Account confers greater control over child accounts, ensuring that they adhere to the desired configuration and functionality standards. This flexibility is especially valuable for businesses with complex structures and unique requirements.\n\nFor more information on how to become a Sponsor Account, refer to the [Becoming a Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account) guide.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/concepts/vtex-io-documentation-sponsor-account.md)\n\n[Edition App« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account//docs/guides/vtex-io-documentation-edition-app)[Becoming a Sponsor AccountNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account//docs/guides/vtex-io-documentation-becoming-a-sponsor-account)\n\nSee also\n\n[Becoming a Sponsor AccountApp Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-becoming-a-sponsor-account)[Edition AppGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-edition-app)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Account hierarchy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-sponsor-account%23account-hierarchy)\n\n[The vtex account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-sponsor-account%23the-vtex-account)[Secondary Sponsor Accounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-sponsor-account%23secondary-sponsor-accounts)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/concepts/vtex-io-documentation-sponsor-account.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Account hierarchy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-sponsor-account%23account-hierarchy)\n\n[The vtex account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-sponsor-account%23the-vtex-account)[Secondary Sponsor Accounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account/docs/guides/vtex-io-documentation-sponsor-account%23secondary-sponsor-accounts)\n\nOn this page\n\n[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=)"
}
] |
doc_2f8cc7b4
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore)\n\nFastStore\n\nThe ultimate toolkit for building blazing-fast storefronts.\n\n[FastStore](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore) is a toolkit based on [Jamstack](https://read.calvincode.net/reader?url=https://jamstack.org/) that helps developers build high-performance stores.\n\nIt supports integration with [Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview), offers analytics functionalities to inform storefront decision-making, and gives developers the flexibility to customize the store based on the brand’s vision, creating a unique shopping experience for users.\n\n| Aspect | Description |\n| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **Performance** | Ensures fast-loading stores and provides a good user experience, focusing on achieving high scores in tests like [Lighthouse](https://read.calvincode.net/reader?url=https://developer.chrome.com/docs/lighthouse/overview) and [Web Vitals](https://read.calvincode.net/reader?url=https://web.dev/articles/vitals%23core-web-vitals). |\n| **Stability** | Built to be stable and avoid crashes, so your store doesn't lose sales due to provider issues. |\n| **Analytics/SEO** | Works with analytics tools to understand store customers and with SEO tools to improve store visibility in search results. |\n\n> For a detailed understanding of the key differences between FastStore versions, their support levels, and guidelines for upgrading, please refer to the [FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels) guide.\n\n## FastStore architecture\n\nCodebase\n\nBuild process\n\nDeployment\n\nCustomer touchpoint\n\nUser touchpoint\n\nVersioning - GitHub\n\nFastStore WebOps\n\nFastStore WebOps\n\nVTEX GitHub bot\n\nWebstore\n\nVTEX Headless CMS\n\nDeveloper Tools\n\nGitHub pipeline\n\nFastStore CLI\n\nVTEX IO CLI\n\nReleases\n\nLocalhost preview\n\nPreview mode for Headless CMS\n\nPackage layer\n\nCore\n\nCLI\n\nComponents\n\nSDK\n\nAPI\n\nTechnologies\n\nTypescript\n\nReact\n\nNext.js\n\nGraphQL\n\nNode\n\nThe diagram above shows a FastStore architectural flow, which includes the following components:\n\n* **Codebase:** Source code of the FastStore project hosted on GitHub.\n* **Build process:** Process of converting the source code into a deployable project through [FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project).\n* **Deployment:** Process of deploying the project to a production environment through [FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project) and quality assurance bots.\n* **Business user touchpoint:** Environment where admin users interact with storefront settings on VTEX Headless CMS.\n* **Customer touchpoint:** Environment where customers interact with the storefront, in this case, the store website.\n\n## Developer tools\n\nThese are the tools that developers use to build and deploy FastStore projects. They include:\n\n* [FastStore CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli): Command-line interface (CLI) that can be used to interact with FastStore.\n* [VTEX IO CLI:](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference) CLI used when the project needs to interact with the VTEX platform.\n* Localhost preview: Tool that allows developers to preview their FastStore projects locally.\n\n## Package layer\n\nFastStore consists of five main packages that enable the store to work:\n\n* [Core](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-overview%23packagejson): Provides the starter source code to get your store up and running. It contains four sub-packages: Components, SDK, UI, and API packages.\n* [SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-overview%23packagejson): Provides developers with a set of tools that handle all meaningful states an ecommerce store might have, such as Session, Cart, Component, and Search. The SDKs also provide GA4-compatible analytics functions to help you create powerful analytics capabilities in your ecommerce store.\n* [UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index): Gathers the design system based on FastStore components, using [Sass](https://read.calvincode.net/reader?url=https://sass-lang.com/) for styling.\n* [API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview): Connects your project to your favorite ecommerce provider by creating interfaces for querying products, collections, and handling carts.\n* [CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli): Unifies the VTEX source code in `@faststore/core` with the customizations and extensions the store will create in the `/src` folder.\n\n## Technologies\n\nTo work with FastStore, you should be familiar with the following technologies:\n\n* [TypeScript](https://read.calvincode.net/reader?url=https://www.typescriptlang.org/)\n* [React](https://read.calvincode.net/reader?url=https://react.dev/)\n* [Next.js](https://read.calvincode.net/reader?url=https://nextjs.org/)\n* [GraphQL](https://read.calvincode.net/reader?url=https://graphql.org/)\n* [Node.js](https://read.calvincode.net/reader?url=https://nodejs.org/en)\n\n## Quickstart\n\nFollow the steps below to start building and deploying a FastStore storefront.\n\n### 1\\. Initial settings\n\nBefore starting the project, make sure you have the necessary tools and apps installed in your account or your local development environment. See the [Requirements](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-requirements) guide for more information.\n\n### 2\\. Starting the project\n\nAfter you have prepared your machine with the initial settings, you can start your project by following the steps below:\n\n1. [FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project): Start the onboarding of your project with the FastStore WebOps app. This app streamlines the process, saving you the trouble of complex configurations and getting your project up and running quickly.\n2. [Local Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project): After onboarding, start working on your store locally, making the initial changes and adjustments to your storefront.\n\n## Next steps\n\nNow that you have your FastStore project running extend your store functionalities by working with FastStore customization tools:\n\n[UI componentsEnhance your store's features with these components designed to help you quickly implement and customize features in your store.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index)[Using themesExplore the look-and-feel of your store by using Themes, FastStore CSS stylesheets.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview)[Customizing sections and componentsExplore new ways to customize your store components with overriding.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview)[Extending the FastStore APIExtend the FastStore API schema by adding new data to the existing queriesSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/faststore/faststore.md)\n\n[Getting started with storefront solutions« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore//docs/guides/getting-started-with-storefront-solutions)[FastStore versions and support levelsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore//docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[FastStore architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore%23faststore-architecture)\n\n[Developer tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore%23developer-tools)\n\n[Package layer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore%23package-layer)\n\n[Technologies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore%23technologies)\n\n[Quickstart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore%23quickstart)\n\n[1\\. Initial settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore%231-initial-settings)[2\\. Starting the project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore%232-starting-the-project)\n\n[Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore%23next-steps)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/faststore/faststore.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[FastStore architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore%23faststore-architecture)\n\n[Developer tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore%23developer-tools)\n\n[Package layer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore%23package-layer)\n\n[Technologies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore%23technologies)\n\n[Quickstart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore%23quickstart)\n\n[1\\. Initial settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore%231-initial-settings)[2\\. Starting the project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore%232-starting-the-project)\n\n[Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs/guides/faststore%23next-steps)\n\nOn this page\n\n[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=)"
}
] |
doc_98393841
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Explain the VTEX api reference logistics api API and how to use it."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/logistics-api/)\n\nShipping Policies\n\nFreight Values\n\nScheduled Delivery\n\nDocks\n\nWarehouses\n\nInventory\n\nHolidays\n\nReservations\n\nSLA\n\nPickup points\n\nPolygons\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/logistics-api/)\n\nShipping Policies\n\nFreight Values\n\nScheduled Delivery\n\nDocks\n\nWarehouses\n\nInventory\n\nHolidays\n\nReservations\n\nSLA\n\nPickup points\n\nPolygons\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[GeGet information about account« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/license-manager-api%23get-/api/vlm/account)[GeRetrieve shipping policy by IDNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api/docs/api-reference/logistics-api%23get-/api/logistics/pvt/shipping-policies/-id-)\n\n[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=)"
}
] |
doc_37fb602b
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides erp integration set up catalog in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-guide)\n\n[Set up catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-set-up-catalog)\n\n[Import prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-import-prices)\n\n[Import inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-import-inventory)\n\n[Import customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/import-customer-data)\n\n[Set up order integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-set-up-order-integration)\n\n[Import products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-import-products)\n\n[Set up order processing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-set-up-order-processing)\n\n[Update or delete information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-updating-and-deleting-information)\n\n[FAQ: ERP Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/faq-erp-integration)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-guide)\n\n[Set up catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-set-up-catalog)\n\n[Import prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-import-prices)\n\n[Import inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-import-inventory)\n\n[Import customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/import-customer-data)\n\n[Set up order integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-set-up-order-integration)\n\n[Import products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-import-products)\n\n[Set up order processing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-set-up-order-processing)\n\n[Update or delete information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-updating-and-deleting-information)\n\n[FAQ: ERP Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/faq-erp-integration)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides)\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-guide)\n\n[Set up catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-set-up-catalog)\n\nSet up catalog\n\nIn this step, we give you an overview of how to prepare your catalog structure to receive all of your products.\n\n> While this article provides the basic flow of integration, we recommend you check the implementation details provided on our [Catalog integration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration), as well as each **Learn more** section below.\n\n## Before you begin\n\nBefore uploading your entire catalog to VTEX it is very important to think carefully about your desired catalog structure. The way you structure your catalog and product specifications can have a great impact on site navigation, order integration and other aspects of your store.\n\nMost VTEX stores structure their **Category Tree** into three hierarchical levels: **Departments**, **Categories** and **Subcategories**. Some stores might benefit from using only a two-level structure of Departments and Categories. You could even go as simple as only using Departments to segment your product assortment.\n\n**Brands** are also an important aspect to consider, as it is very common for clients to search for products using them as a keyword. When brands are associated with products, you can use them as filters in your store navigation.\n\nEach category in your store might also use **Specification Fields** to hold extra information needed to fully describe the Products or SKUs it contains. You should consider which fields would need to be associated with Products or SKUs for each category.\n\nIn the end, the goal is to make navigation easier for your customers and to improve the chance that all category and product pages on your website will be properly indexed. If you would like a conceptual overview of our Catalog, check out the [beginner track](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/3rA2tTpIoEXdv2nzC27zxR) in our Help Center.\n\n## Create Departments, Categories and Subcategories\n\nTo create your Category Tree, you should use the [Create Category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/category) endpoint in the Catalog API.\n\nStart by creating your Departments, then your Categories, then your Subcategories. In between steps, you can use the [Get Category Tree](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pub/category/tree/-categoryLevels-) endpoint or visit the **Products > Catalog > Categories** section of your Admin panel to check on your progress.\n\n### Category migration from ERPs\n\nThe category tree is very important for your VTEX store and it is possible that the category structure represented in your Enterprise Resource Planning (ERP) software or Product Information Manager (PIM) is not optimized for that end. In this case, your ecommerce category tree may end up being different from the tree in your previous system.\n\nIf you find yourself in that situation, we recommend creating an inactive mock category called, for example, **Integration,** that will not be used in the storefront but can receive each and every product and SKU when importing. After all of your catalog has been imported, the products can be manually arranged into their new categories appropriate for your ecommerce. This can be done in the Admin or with a spreadsheet, with the [Google Drive Import app](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/google-import).\n\n> For more details, see our [Catalog categories integration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories).\n\n## Create Brands\n\nTo add a new Brand to your catalog, you should use the [Create Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/brand) endpoint in the Catalog API.\n\nAdding Brands to your catalog allows you to filter products in your storefront using this attribute. Brands need to be created before you can associate products with them, so it's a good idea to do this when setting up your catalog. You can use the [Get Brand List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/brand/list) endpoint or visit the **Products > Catalog > Brands section** of your Admin panel to check on your progress.\n\n> If your backend does not have brand information, you can perform the same process mentioned above for [category migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog%23category-migration-from-erps), by creating an inactive mock brand, used exclusively for migration. The products' information can later be manually enriched.\n\n> For more details, see our [Catalog brands integration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands).\n\n## Create Specifications Groups\n\nTo add Specification Groups to a category, you should use the [Create Specification Group](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/specificationgroup) endpoint in the Catalog API.\n\n> Specification Fields are always grouped into Specification Groups. Because of that, you will need to create at least one Specification Group for each category that will need extra information to fully describe the Products or SKUs it contains.\n\nStart creating Specification groups at the Departments level, then at the Categories level and finally at the Subcategories level. You can use the [List Specifications Groups by Category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/specification/groupbycategory/-categoryId-) endpoint to check on your progress or visit the Specifications Group list for the category you're interested in by accessing the **Products > Catalog > Categories** section of your Admin panel.\n\n> Keep in mind that Specification Groups in a category are recursively applied to all its children in the Category Tree. If a field is not used by all children of a category, it should not be associated with one of its Specification Groups.\n\n> For more details, see our [Catalog specifications integration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications).\n\n## Create Specification Fields\n\nTo add Specification Fields to a Specification Group, you should use the [Create Specifications Field](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog%5Fsystem/pvt/specification/field) endpoint in the Catalog API.\n\nGo through each of the Specification Groups you created previously and add the fields you need, one at a time. There are eight field types to choose from:\n\n1. Text\n2. Multi-Line Text\n3. Number\n4. Combo\n5. Radio\n6. Checkbox\n7. Indexed Text\n8. Indexed Multi-Line Text.\n\n> Specification Values must be specified for enumerated field types. If a Specification Field type is Combo, Radio or Checkbox, you will need to create Specification Values to represent the options that can be selected for that field.\n\n> or more details, see our [Catalog specifications integration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications).\n\n## Create Specification Values\n\nTo add Specification Values to a Specification Field, you should use the [Create Specification Field Value](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog%5Fsystem/pvt/specification/fieldValue) endpoint in the Catalog API.\n\nMake sure you add Specification Values to all Specification Fields that require them - Combo, Radio and Checkbox. You can use the [Get Specifications Values By Field Id](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pub/specification/fieldvalue/-fieldId-) endpoint to check on your progress. Alternatively, you can find the list of Specification Values for the Field you're interested in by following the steps below:\n\n1. Open the _Products > Catalog > Categories_ section of your Admin panel;\n2. Select the Category where you created the Specification Field;\n3. Click on the _Actions_ dropdown and open the appropriate Field list (Product or SKU);\n4. Find the Specification Field you're interested in (it should be an enumerated field type);\n5. Click on the dropdown in the Edit column and open the Values list;\n6. You should now be able to see the Specification Values you created for that Field.\n\n> You can use the **Position** parameter to choose the order in which Specification Values are shown for enumerated field types. For example: if you want the Specification Value `110V` to show before `220V` in a `Voltage` Specification Field.\n\n> For more details, see our [Catalog specifications integration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications).\n\n## Wrapping up\n\nAfter following the instructions in this step, you should have set up your catalog, including the category tree, brands and specifications needed to completely describe your products. This should enable you to upload all your products in the next step.\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/erp-integration-guide/erp-integration-set-up-catalog.md)\n\n[Back office integration guide (ERP/PIM/WMS)« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog//docs/guides/erp-integration-guide)[Import pricesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog//docs/guides/erp-integration-import-prices)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-set-up-catalog%23before-you-begin)\n\n[Create Departments, Categories and Subcategories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-set-up-catalog%23create-departments-categories-and-subcategories)\n\n[Category migration from ERPs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-set-up-catalog%23category-migration-from-erps)\n\n[Create Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-set-up-catalog%23create-brands)\n\n[Create Specifications Groups](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-set-up-catalog%23create-specifications-groups)\n\n[Create Specification Fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-set-up-catalog%23create-specification-fields)\n\n[Create Specification Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-set-up-catalog%23create-specification-values)\n\n[Wrapping up](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-set-up-catalog%23wrapping-up)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/erp-integration-guide/erp-integration-set-up-catalog.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-set-up-catalog%23before-you-begin)\n\n[Create Departments, Categories and Subcategories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-set-up-catalog%23create-departments-categories-and-subcategories)\n\n[Category migration from ERPs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-set-up-catalog%23category-migration-from-erps)\n\n[Create Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-set-up-catalog%23create-brands)\n\n[Create Specifications Groups](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-set-up-catalog%23create-specifications-groups)\n\n[Create Specification Fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-set-up-catalog%23create-specification-fields)\n\n[Create Specification Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-set-up-catalog%23create-specification-values)\n\n[Wrapping up](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog/docs/guides/erp-integration-set-up-catalog%23wrapping-up)\n\nOn this page\n\n[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=)"
}
] |
doc_a0814728
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX cybersource fingerprint app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/troubleshooting)\n\n[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.cybersource-fingerprint/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/vtex-io-apps)\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/guides/pixel-apps)\n\nCyberSource Fingerprint\n\nOfficial extension\n\nVersion: 1.0.2\n\nLatest version: 1.0.2\n\n[](#contributors-)\n\nThis app setup the CyberSource Fingerprint in the store order placed page following the [official documentation](https://read.calvincode.net/reader?url=http://www.braspag.com.br/wp-content/uploads/2016/03/manual-de-integracao-anti-fraude-v1.7.1.pdf).\n\n## Configuration\n\n1. [Installing the app](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/store/installing-an-app) running:\n\n`1\n\nvtex install vtex.cybersource-fingerprint \n\n`\n\n1. Open the app settings on your admin (`/admin/apps`) and fill the Org Id and Merchant Id.\n\n[Cookie Script« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.cookie-script)[ElfsightNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.elfsight)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cybersource-fingerprint/docs/apps/vtex.cybersource-fingerprint%23configuration)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_3200d791
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex product identifier in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-identifier/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-identifier/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-identifier/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-identifier/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-identifier/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-identifier/docs/troubleshooting)\n\n[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-product-identifier/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-identifier/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-identifier/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-identifier/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-identifier/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-identifier/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-identifier/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-identifier/updates/release-notes)\n\nProduct Identifier\n\nProduct Identifier app is responsible for showing a product identifier, such as: product reference, product ID, sku EAN or sku reference.\n\n\n\n## Configuration\n\nAdd the `vtex.product-identifier` app to your theme's dependencies in the `manifest.json` file, as in:\n\n`1\n\n\"dependencies\": { \n\n2\n\n \"vtex.product-identifier\": \"0.x\" \n\n3\n\n} \n\n`\n\nAdd `product-identifier.product` block to your store as a child of `product-summary.shelf`.\n\n`1\n\n\"product-identifier.product\": { \n\n2\n\n \"props\": { \n\n3\n\n \"label\": \"default\", //'default' | 'custom' | 'hide' \n\n4\n\n \"customLabel\": \"teste\", // text if label is custom \n\n5\n\n \"idField\": \"skuReferenceId\" //'itemId' | 'productId' | 'productReference' | 'skuEan' | 'skuReferenceId' \n\n6\n\n } \n\n7\n\n}, \n\n`\n\nThe `product-identifier` interface is available is also available within the admin's CMS where you can configure this component to show other identifiers, such as:\n\n* Product Reference\n* Product ID\n* SKU EAN\n* SKU Reference ID\n* Item ID\n\nIt's also possible to hide the component label or customize its text. Notice that, in the following example, the \"Reference\" text was substituted by \"Foo\".\n\n\n\n## Customization\n\nTo apply CSS customization in this and other blocks, follow the instructions given in the recipe on [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).\n\n| CSS Handles |\n| ------------------------------- |\n| product-identifier |\n| product-identifier\\_\\_label |\n| product-identifier\\_\\_separator |\n| product-identifier\\_\\_value |\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/basic-components/vtex-product-identifier.md)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-identifier/docs/guides/vtex-product-identifier%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-identifier/docs/guides/vtex-product-identifier%23customization)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/basic-components/vtex-product-identifier.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-identifier/docs/guides/vtex-product-identifier%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-identifier/docs/guides/vtex-product-identifier%23customization)\n\nOn this page\n\n[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=)"
}
] |
doc_4a722556
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore molecules tag in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/components-index)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-overview)\n\nTag\n\nInteractive badges.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/Tag)\n\nThe `Tag` component is an interactive `Badge`. By default, its have a close button.\n\nExample\n\nCode\n\nTag\n\nWarning Tag\n\nDanger Tag\n\nNeutral & Big\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { Tag } from '@faststore/ui' \n\n`\n\n### Import styles\n\nTo apply styles, include the following in your stylesheet:\n\n`1\n\n@import '@faststore/ui/src/components/molecules/Tag/styles.scss'; \n\n`\n\nFor details, see [Importing FastStore UI component styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles).\n\n---\n\n## Design tokens\n\n| Local token | Default value/Global token linked |\n| --------------------------- | --------------------------------- |\n| \\--fs-tag-text-color | var(--fs-color-text) |\n| \\--fs-tag-icon-size | var(--fs-spacing-4) |\n| \\--fs-tag-icon-stroke-width | var(--fs-spacing-4) |\n\n---\n\n## Data attributes\n\nYou can target and override `Tag` styles using the following data attributes:\n\n`data-fs-tag`\n\n`data-fs-tag-label`\n\n`data-fs-tag-icon-button`\n\nThis component inherits [Badge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-badge) CSS selectors and styles.\n\n---\n\n## Props\n\n| Name | Type | Description | Default | | | | | | |\n| ------------------- | ----------------------- | -------------------------------------------------------------------------------------------------- | --------- | --------- | ------------------------ | -------------------------------- | ------------------- | ----------- | --------------------------------------------------- |\n| **testId** | string | ID to find this component in testing tools (e.g.: cypress, testing library, and jest). | fs-tag | | | | | | |\n| **label\\*** | string | The text displayed inside the tag. | | | | | | | |\n| **icon** | string \\| number | false | true | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | A React component that will be rendered as an icon. |\n| **iconButtonLabel** | string | For accessibility purposes, provide an ARIA label to the Icon button | | | | | | | |\n| **onClose\\*** | () => void | Function called when Icon button is clicked. | | | | | | | |\n| **size** | \"small\" \\| \"big\" | Specifies the size variant. | | | | | | | |\n| **variant** | \"info\" \\| \"highlighted\" | \"success\" | \"neutral\" | \"warning\" | \"danger\" | Specifies the component variant. | | | |\n| **counter** | false \\| true | Enables counter badge. | | | | | | | |\n| **aria-label** | string | For accessibility purposes, adds an ARIA label to the element when \\`counter\\` is set to \\`true\\`. | | | | | | | |\n\n---\n\n## Best Practices\n\n### ✅ Do's\n\n* Be cautious about the tag's positioning, writing, shape, and color to avoid any confusion with components similar in appearance.\n\n### ❌ Don'ts\n\n* Don't use long texts in tags.\n* Don't use color alone to convey information. If color is needed to convey meaning, ensure there is a text alternative for that meaning as well.\n\n---\n\n## Accessibility\n\n* Text elements must have sufficient color contrast against the background.\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/aliceoq)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/molecules/tag.mdx)\n\n[Table« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-table)[TextareaFieldNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-textarea-field)\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/aliceoq)\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-tag%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-tag%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-tag%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-tag%23design-tokens)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-tag%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-tag%23props)\n\n[Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-tag%23best-practices)\n\n[✅ Do's](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-tag%23-dos)[❌ Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-tag%23-donts)\n\n[Accessibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-tag%23accessibility)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/molecules/tag.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-tag%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-tag%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-tag%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-tag%23design-tokens)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-tag%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-tag%23props)\n\n[Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-tag%23best-practices)\n\n[✅ Do's](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-tag%23-dos)[❌ Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-tag%23-donts)\n\n[Accessibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag/docs/guides/faststore/molecules-tag%23accessibility)\n\nOn this page\n\n[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=)"
}
] |
doc_66c1c8c4
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides pagination in the master data api in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/master-data-best-practices)\n\n[Extracting data from Master Data with search and scroll](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/extracting-data-from-master-data-with-search-and-scroll)\n\n[Pagination in the Master Data API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/pagination-in-the-master-data-api)\n\n[Avoiding CORS in Master Data requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/avoiding-cors-in-master-data-requests)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/master-data-v1)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/master-data-best-practices)\n\n[Extracting data from Master Data with search and scroll](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/extracting-data-from-master-data-with-search-and-scroll)\n\n[Pagination in the Master Data API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/pagination-in-the-master-data-api)\n\n[Avoiding CORS in Master Data requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/avoiding-cors-in-master-data-requests)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/master-data-v1)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides)\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/master-data-best-practices)\n\n[Pagination in the Master Data API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/pagination-in-the-master-data-api)\n\nPagination in the Master Data API\n\nWhen working with the Master Data API, whether you're using v1 or v2, you may need to handle a large volume of data. Pagination breaks down these large datasets into smaller, manageable parts. This guide will walk you through using pagination in the search and scroll endpoints in the Master Data API.\n\n> Learn more about [Extracting data from Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll) using the search and scroll endpoints.\n\n## Search pagination\n\nWhen using the search endpoint, the results are paginated by specifying a range in the `REST-Range` header. This method allows you to define the subset of documents you want to retrieve from the dataset.\n\nSee the search endpoint reference according to the Master Data version you are using:\n\n* [Master Data API v1 - Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23get-/api/dataentities/-acronym-/search)\n* [Master Data API v2 - Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23get-/api/dataentities/-dataEntityName-/search)\n\n### Setting up pagination\n\nTo paginate your results using the search endpoint, include the `REST-Range` header in your request. The value of this header should follow the format: `resources={x}-{y}`.\n\n* **`x`**: The index of the first document in the returned array.\n* **`y`**: The index of the last document in the returned array + 1.\n\nFor example, `resources=0-100` would return the first 100 documents from index 0 to 99\\. Note that you are limited to retrieving 100 documents per query.\n\n> When paginating, the `_sort` parameter is recommended. The API does not guarantee a specific order by default; therefore, omitting the `_sort` parameter may lead to duplicate documents or return unexpected pages.\n\n### Retrieving subsequent pages\n\nTo retrieve the next set of results, adjust the `x` and `y` values accordingly. For example, to get the next 100 documents after the first set, your `REST-Range` header would look like this: `resources=100-200`.\n\n### Checking if more pages are available\n\nThe `REST-Content-Range` response header provides information about the range of documents returned in the current response and the total number of documents available. It follows this format: `resources={x}-{y}/{total}`.\n\n* **`x`**: The index of the first document in the returned array.\n* **`y`**: The index of the last document in the returned array + 1.\n* **`total`**: The total number of documents that match the query.\n\nFor example, `resources=0-100/250` indicates that the response contains documents from index 0 to 99 out of 250\\. If `y` is less than `total`, you can retrieve more pages.\n\n## Scroll pagination\n\nThe scroll endpoint is used when you need to retrieve a large dataset that might exceed the typical pagination limits since it allows you to retrieve up to 1000 documents per request.\n\nSee the scroll endpoint reference according to the Master Data version you are using:\n\n* [Master Data API v1 - Scroll](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23get-/api/dataentities/-acronym-/scroll)\n* [Master Data API v2 - Scroll](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23get-/api/dataentities/-dataEntityName-/scroll)\n\n### Setting up pagination\n\nPagination with the scroll endpoint is managed using three parameters:\n\n* `_size`: Specifies the number of documents returned per request. The maximum value is 1000.\n* `_token`: A unique token returned in the `X-VTEX-MD-TOKEN` header of the first request. This token is passed as a query parameter in subsequent requests to retrieve the next page of results. It expires in 20 minutes.\n\nIn the initial request, you should only use `_size` to determine the number of results per page, as you will obtain the `_token` value in the `X-VTEX-MD-TOKEN` response header.\n\nExample of an initial request:\n\n`GET /api/dataentities/{data_entity}/scroll?_size={page_size}`\n\n> You can only define the page size in the first request. It cannot be changed in subsequent requests.\n\n### Retrieving subsequent pages\n\nUse the `X-VTEX-MD-TOKEN` header returned from the previous request as the `_token` query parameter in your next request to retrieve the subsequent pages. You can repeat this request until the response body is empty, indicating that there are no more documents to retrieve.\n\nSubsequent requests to retrieve additional pages:\n\n`GET /api/dataentities/{data_entity}/scroll?_token={X-VTEX-MD-TOKEN}`\n\n### Checking if more pages are available\n\nThe `REST-Content-Total` response header provides the total number of documents that match your query, allowing you to calculate the number of pages available based on the `_size` parameter.\n\nFor example, if the response header is `REST-Content-Total: 5000` and you are retrieving 1000 documents per page (`_size=1000`), you know that there are 5 pages of data available.\n\nYou can use this information to determine if there are more pages to retrieve and to set up logic in your application to continue retrieving data until all pages are processed.\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/master-data-best-practices/pagination-in-the-master-data-api.md)\n\n[Extracting data from Master Data with search and scroll« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api//docs/guides/extracting-data-from-master-data-with-search-and-scroll)[Avoiding CORS in Master Data requestsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api//docs/guides/avoiding-cors-in-master-data-requests)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Search pagination](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/pagination-in-the-master-data-api%23search-pagination)\n\n[Setting up pagination](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/pagination-in-the-master-data-api%23setting-up-pagination)[Retrieving subsequent pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/pagination-in-the-master-data-api%23retrieving-subsequent-pages)[Checking if more pages are available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/pagination-in-the-master-data-api%23checking-if-more-pages-are-available)\n\n[Scroll pagination](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/pagination-in-the-master-data-api%23scroll-pagination)\n\n[Setting up pagination](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/pagination-in-the-master-data-api%23setting-up-pagination)[Retrieving subsequent pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/pagination-in-the-master-data-api%23retrieving-subsequent-pages)[Checking if more pages are available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/pagination-in-the-master-data-api%23checking-if-more-pages-are-available)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/master-data-best-practices/pagination-in-the-master-data-api.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Search pagination](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/pagination-in-the-master-data-api%23search-pagination)\n\n[Setting up pagination](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/pagination-in-the-master-data-api%23setting-up-pagination)[Retrieving subsequent pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/pagination-in-the-master-data-api%23retrieving-subsequent-pages)[Checking if more pages are available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/pagination-in-the-master-data-api%23checking-if-more-pages-are-available)\n\n[Scroll pagination](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/pagination-in-the-master-data-api%23scroll-pagination)\n\n[Setting up pagination](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/pagination-in-the-master-data-api%23setting-up-pagination)[Retrieving subsequent pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/pagination-in-the-master-data-api%23retrieving-subsequent-pages)[Checking if more pages are available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api/docs/guides/pagination-in-the-master-data-api%23checking-if-more-pages-are-available)\n\nOn this page\n\n[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=)"
}
] |
doc_31b45345
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation integrating frontend app with site editor in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[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-integrating-frontend-app-with-site-editor/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/api-reference)\n\n[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-integrating-frontend-app-with-site-editor/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/storefront-development)\n\n[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-integrating-frontend-app-with-site-editor/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/troubleshooting)\n\n[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-integrating-frontend-app-with-site-editor/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/store-framework-working-with-site-editor)\n\n[Integrating a frontend app with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor)\n\n[Making a custom component available in Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor)\n\n[Site Editor schema examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/vtex-io-documentation-site-editor-schema-examples)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/store-framework-working-with-site-editor)\n\n[Integrating a frontend app with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor)\n\n[Making a custom component available in Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor)\n\n[Site Editor schema examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/vtex-io-documentation-site-editor-schema-examples)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/store-framework)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/store-framework-working-with-site-editor)\n\n[Integrating a frontend app with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor)\n\nIntegrating a frontend app with Site Editor\n\nLearn how to integrate a frontend app with Site Editor.\n\nOnce you have developed a [frontend app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io) using [VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io), the next step is to declare this app in the [dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-dependencies) of the Store Theme app. This step is essential to make your custom frontend app available in [Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor).\n\nIn this guide, you will learn how to integrate your custom frontend app with Site Editor.\n\n## Before you begin\n\n* Create your frontend app following the guide [Creating the new app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app).\n* Develop a [Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme) for your store, following the [Storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3) guide.\n* Check if your Store Theme has the [Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders) properly installed. You must have at least the following builders configured: \n * [store builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-builder): Enables the development of Store Framework storefronts. \n * [react builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-react-builder): Used to develop apps with [React](https://read.calvincode.net/reader?url=https://react.dev/) when your project requires customized frontend solutions.\n\n## Instructions\n\n### Step 1 - Declaring your app in Store Theme dependencies\n\nFollow the steps below to update your Store Theme dependencies with the name and version of your frontend app.\n\n1. Open the Store Theme app folder in your local files using the code editor of your choice, such as Visual Studio Code.\n2. In the Store Theme `manifest.json` file, add your app to `dependencies`, following this pattern: `\"{accountName}.{appName}\": \"{appVersion}\"`. See the example below: \n`1 \n\"dependencies\": { \n2 \n \"{accountName}.{appName}\": \"{appVersion}\", \n3 \n \"vtex.store\": \"2.x\", \n4 \n \"vtex.store-header\": \"2.x\", \n5 \n \"vtex.product-summary\": \"2.x\", \n6 \n \"vtex.store-footer\": \"2.x\", \n7 \n \"vtex.store-components\": \"3.x\", \n8 \n \"vtex.styleguide\": \"9.x\", \n9 \n \"vtex.slider\": \"0.x\", \n10 \n \"vtex.carousel\": \"2.x\", \n11 \n... \n12 \n} \n`\n\n### Step 2 - Using a component of your frontend app within a store page\n\nConsider your frontend app has a component named `CustomComponent`, which is declared in a block [interface](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface) as `custom-component`:\n\nfrontend-app/store/interfaces.json\n\n`1\n\n{ \n\n2\n\n \"custom-component\": { \n\n3\n\n \"component\": \"CustomComponent\" \n\n4\n\n } \n\n5\n\n} \n\n`\n\nTo use this component on the store’s main page, for example, declare the `custom-component` block within the `home` block:\n\nstore-theme/store/blocks/home/home.jsonc\n\n`1\n\n{ \n\n2\n\n \"store.home\": { \n\n3\n\n \"blocks\": [\"custom-component\"] \n\n4\n\n } \n\n5\n\n} \n\n`\n\n### Step 3 - Making your component available in Site Editor\n\nBy [linking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app) the Store Theme app, your component will be available to visualize and test in Site Editor within the corresponding [development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace).\n\n> Learn how to create a custom component within your Store Theme app and make it editable directly in Site Editor by following the guide [Making a custom component available in Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor).\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/concepts-1/vtex-io-documentation-integrating-frontend-app-with-site-editor.md)\n\n[Working with Site Editor« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor//docs/guides/store-framework-working-with-site-editor)[Making a custom component available in Site EditorNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor//docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor)\n\nSee also\n\n[Storefront appsGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)[Developing custom storefront componentsGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/vtex-io-documentation-developing-custom-storefront-components)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor%23instructions)\n\n[Step 1 - Declaring your app in Store Theme dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor%23step-1-declaring-your-app-in-store-theme-dependencies)[Step 2 - Using a component of your frontend app within a store page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor%23step-2-using-a-component-of-your-frontend-app-within-a-store-page)[Step 3 - Making your component available in Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor%23step-3-making-your-component-available-in-site-editor)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/concepts-1/vtex-io-documentation-integrating-frontend-app-with-site-editor.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor%23instructions)\n\n[Step 1 - Declaring your app in Store Theme dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor%23step-1-declaring-your-app-in-store-theme-dependencies)[Step 2 - Using a component of your frontend app within a store page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor%23step-2-using-a-component-of-your-frontend-app-within-a-store-page)[Step 3 - Making your component available in Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor%23step-3-making-your-component-available-in-site-editor)\n\nOn this page\n\n[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=)"
}
] |
doc_57172e95
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex accessibe in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-accessibe/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-accessibe/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-accessibe/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-accessibe/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-accessibe/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-accessibe/docs/troubleshooting)\n\n[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-accessibe/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-accessibe/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-accessibe/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-accessibe/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-accessibe/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-accessibe/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-accessibe/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-accessibe/updates/release-notes)\n\naccessiBe\n\nThis app adds pixel code to your VTEX IO store to show a component in the storefront, enabling users to modify your site’s UI, design, and readability to meet their individual needs following ADA and WCAG accessibility guidelines.\n\n## Installation\n\nTo install the accessiBe app:\n\n1. Open the VTEX App store.\n2. Look for the accessiBe app.\n3. Click on **GET APP**.\n4. Type your account name.\n5. Click on **CONFIRM**.\n\nYou will be redirected to your store’s accessiBe settings page. To setup your accessiBe account, please go to <https://accessibe.com/a/lbbihws>, log in to your accessibe account, and add your VTEX store URL as one of the managed sites. Accessibility parameters can be managed directly through the accessiBe platform after installing and configuring the app.\n\n> _You need to have an accessiBe paid account to be able to use the app_\n\nAfter installing and adding your VTEX store URL on the accessiBe website, the accessibility button will be available on your store with the default configuration.\n\n## Configuration\n\nYou can configure the accessiBe button and interface. To configure the accessiBe app in your store:\n\n1. Log in to Admin.\n2. On _ACCOUNT SETTINGS_, click on **Apps**.\n3. Search for accessiBe.\n4. Click on **Settings**.\n5. Fill in the screen fields listed below according to your needs and click on **Save**. \n * **Accessibility Statement Link**: as an accessiBe client, you get a statement indicating remediations your website has undergone to achieve compliance. When this field is left blank, this default statement is shown in the component. You can either edit accessiBe’s statement with your information (see [this accessiBe documentation](https://read.calvincode.net/reader?url=https://accessibe.com/support/account/how-can-i-edit-website-owner-information-for-the-accessibility-statement) on learning how to edit it) or insert a link to another published statement. \n * **Feedback Form Link**: add a feedback form. \n * **Interface Footer**: present your brand/company in the footer. \n * **Interface Language**: choose the different language options available for your interface. The default option is English. \n * **Interface Lead Color**: change the color of the interface to match your style. This field accepts hash color codes. \n * **Trigger Button Color**: change the color of the accessibility button that is used to open the interface. This field accepts hash color codes. \n * **Interface Position**: change the location of the interface. The default option is _Left_. \n * **Hide on mobile?**: choose whether to show the interface on mobile. The default option is _Show_. \n * **Trigger horizontal position**: choose the horizontal positioning of the accessibility button. The default option is _Left_. \n * **Trigger vertical position**: choose the vertical positioning of the accessibility button. The default option is _Bottom_. \n * **Mobile trigger horizontal position**: choose the horizontal positioning of the accessibility button on mobile. The default option is _Left_. \n * **Mobile trigger vertical position**: choose the vertical positioning of the accessibility button on mobile. The default option is _Center_. \n * **Trigger button size**: choose the size of the accessibility button. The default option is _Medium_. \n * **Mobile trigger size**: choose the size of the accessibility button on mobile. The default option is _Small_. \n * **Trigger button shape**: change the shape of the accessibility button. The default option is _Round_. \n * **Trigger mobile shape**: change the shape of the accessibility button. The default option is _Square_. \n * **Hide trigger button**: you can choose to hide the accessibility button, though accessiBe will still be present on your site. The default option is _Show_. \n * **Trigger button icon**: choose from a variety of symbols to represent the accessibility button on your site. \n * **Trigger horizontal offset**: make additional horizontal orientation adjustments for the accessibility button. The default option is _20_. \n * **Trigger vertical offset**: make additional vertical orientation adjustments for the accessibility button. The default option is _20_. \n * **Mobile trigger horizontal offset**: make additional horizontal orientation adjustments for the accessibility button on mobile. The default option is _0_. \n * **Mobile trigger vertical offset**: make additional vertical orientation adjustments for the accessibility button on mobile. The default option is _0_. \n * **Useful Website Links**: add a helpful website link. Click on _\\+ ADD MORE_, insert a label and the form URL.\n\nOnce saved, all your configuration choices will be applied to the component in your store.\n\n## Deletion and uninstall\n\nYou can uninstall and/or delete the accessiBe app from your store. When doing so, consider that:\n\n* **If the app is uninstalled without being deleted**: the app will be removed from the workspace, but all saved settings will remain protected, meaning that if you reinstall, all previous settings will be applied.\n* **If the app is deleted**: all saved configurations will be deleted from all workspaces, and the app will also be uninstalled.\n\nTo delete the app:\n\n1. Log in to Admin.\n2. On _ACCOUNT SETTINGS_, click on **Apps**.\n3. Search for accessiBe.\n4. Click on **Settings**.\n5. Click on the **DELETE** button on the upper right portion of the screen.\n6. Wait for the dialog box to appear.\n7. Confirm the deletion by clicking on **DELETE**.\n\nTo uninstall the app:\n\n1. Log in to Admin.\n2. On \\_ ACCOUNT SETTINGS\\_, click on **Apps**.\n3. Search for accessiBe.\n4. Click on **Settings**.\n5. Click on the **UNINSTALL** button on the upper right portion of the screen.\n6. Wait for the dialog box to appear.\n7. Confirm by clicking on **UNINSTALL**.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/pixel-apps/vtex-accessibe.md)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-accessibe/docs/guides/vtex-accessibe%23installation)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-accessibe/docs/guides/vtex-accessibe%23configuration)\n\n[Deletion and uninstall](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-accessibe/docs/guides/vtex-accessibe%23deletion-and-uninstall)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/pixel-apps/vtex-accessibe.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-accessibe/docs/guides/vtex-accessibe%23installation)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-accessibe/docs/guides/vtex-accessibe%23configuration)\n\n[Deletion and uninstall](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-accessibe/docs/guides/vtex-accessibe%23deletion-and-uninstall)\n\nOn this page\n\n[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=)"
}
] |
doc_ef7e1f94
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore storefront features displaying content for authenticated users in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-overview)\n\n[Adding third-party scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-handling-third-party-scripts)\n\n[Building navigation menus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-building-navigation-menus)\n\n[Displaying content for authenticated users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users)\n\n[Implementing regionalization features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-implementing-regionalization-features)\n\n[Implementing search features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-implementing-search-features)\n\n[Managing product images in specific contexts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-managing-product-images-in-specific-contexts)\n\n[Implementing Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/delivery-promise-implementation)\n\n[Implementing Live Shopping for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-overview)\n\n[Adding third-party scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-handling-third-party-scripts)\n\n[Building navigation menus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-building-navigation-menus)\n\n[Displaying content for authenticated users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users)\n\n[Implementing regionalization features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-implementing-regionalization-features)\n\n[Implementing search features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-implementing-search-features)\n\n[Managing product images in specific contexts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-managing-product-images-in-specific-contexts)\n\n[Implementing Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/delivery-promise-implementation)\n\n[Implementing Live Shopping for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-overview)\n\nDisplaying content for authenticated users\n\nAuthenticated content is a feature that restricts access to specific store content based on whether a user is logged in. This ensures that only registered and logged-in users can view exclusive content, like prices, detailed product descriptions, and special offers. Non-logged-in users will see generic content instead.\n\n| Before log in | After log in |\n| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n|  |  |\n\nAuthenticated content fosters a more controlled and secure shopping environment for stores and customers, enhancing the shopping experience. For example, in B2B settings, this allows for customized access to product catalogs, ensuring that businesses only see relevant products and pricing. For segmented promotions, authenticated content enables merchants to tailor special offers and discounts to specific customer segments, increasing engagement and conversion rates.\n\nIn this guide, learn how to create an authenticated component using the [Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero) component as an example.\n\n## Before you begin\n\n### Update the `@faststore/core` package\n\nEnsure your store is using `@faststore/core@v3.0.39` or later. To benefit from this feature, follow the steps below:\n\n1. Update your store’s `@faststore/core` package to the `v3.0.39` by running the following command: \n`1 \nyarn add @faststore/core@3.0.39 \n`\n2. Run `yarn dev` to apply the changes to your project.\n\n### Understand Section Override\n\nMake sure you understand the concepts of [Section Override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview) to follow along.\n\n## Instructions\n\n### Step 1 - Override a component\n\nChoose the component you want to restrict access to. To check the available components, refer to the [UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index) guide.\n\nOnce you have chosen the component, you will need to override the component using the feature [Section Override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview). In this guide we will use the [Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero) component as an example.\n\n1. In `src/components/overrides` create the `Hero.tsx` file.\n2. Add the following to the `Hero.tsx` file: \n`1 \nimport { SectionOverride } from \"@faststore/core\"; \n2 \nimport { HeroHeader, HeroImage } from \"@faststore/ui\"; \n3 \n \n4 \nconst SECTION = \"Hero\" as const; \n5 \n \n6 \nconst override: SectionOverride = { \n7 \nsection: SECTION, \n8 \ncomponents: { \n9 \n HeroImage: { \n10 \n Component: (props) => ( \n11 \n <HeroImage {...props} /> \n12 \n ), \n13 \n }, \n14 \n}, \n15 \n}; \n16 \n \n17 \nexport { override }; \n` \nThe code above overrides the `HeroImage` component to not show any images.\n3. Open the terminal and run `yarn dev`.\n4. Access your store's local development URL (localhost). So far, you will have the following `Hero`: \n\n\nAt this point, the Hero component will not display an image, and logging in won't change that.\n\n### Step 2 - Wrap the component with `ProfileChallenge`\n\nThe `ProfileChallenge` component checks if a user is logged in and has sales channel access. If both conditions are met, it displays your customized version (the overridden component). Otherwise, it displays the default Hero component or your [fallback component](#step-3-create-a-component-fallback-optional).\n\n1. In the `Hero.tsx` file, add the following code: \n`1 \nimport { SectionOverride } from \"@faststore/core\"; \n2 \nimport { ProfileChallenge_unstable as ProfileChallenge } from \"@faststore/core/experimental\"; \n3 \n \n4 \nimport { HeroHeader, HeroImage } from \"@faststore/ui\"; \n5 \n \n6 \nconst SECTION = \"Hero\" as const; \n7 \n \n8 \nconst override: SectionOverride = { \n9 \nsection: SECTION, \n10 \ncomponents: { \n11 \n HeroImage: { \n12 \n Component: (props) => ( \n13 \n <ProfileChallenge> \n14 \n <HeroImage {...props} /> \n15 \n </ProfileChallenge> \n16 \n ), \n17 \n }, \n18 \n}, \n19 \n}; \n20 \n \n21 \nexport { override }; \n` \n * The code above imports the `ProfileChallenge` component. \n * The `override` object defines the section (`Hero`) and the components to be overridden. \n * Inside `components`, the `HeroImage` component is being overridden. \n * The overridden `HeroImage` is wrapped with `ProfileChallenge`. \n * When `ProfileChallenge` renders the `HeroImage`, it checks for user login status and sales channel access.\n2. Run `yarn dev` to sync the changes locally.\n3. To test the changes, access your store's local development URL (localhost).\n4. On the store home page, click on **Sign in** to enter your account.\n5. Once you are logged in, you will be able to see the customized Hero section: \n\n\n### Step 3 - Create a component fallback\n\nThe `ProfileChallenge` has a property called `fallback`. This property allows you to display a custom component when a user is not logged in. If not provided, the default component with the original content will be displayed.\n\n1. To create a fallback component, open the override component file, in this case, `Hero.tsx`, and add the following:\n\n`1\n\nimport { SectionOverride } from \"@faststore/core\"; \n\n2\n\nimport { ProfileChallenge_unstable as ProfileChallenge } from \"@faststore/core/experimental\"; \n\n3\n\n \n4\n\nimport { HeroHeader, HeroImage } from \"@faststore/ui\"; \n\n5\n\n \n6\n\nconst SECTION = \"Hero\" as const; \n\n7\n\n \n8\n\nconst override: SectionOverride = { \n\n9\n\n section: SECTION, \n\n10\n\n components: { \n\n11\n\n HeroImage: { \n\n12\n\n Component: (props) => ( \n\n13\n\n <ProfileChallenge> \n\n14\n\n <HeroImage {...props} /> \n\n15\n\n </ProfileChallenge> \n\n16\n\n ), \n\n17\n\n }, \n\n18\n\n HeroHeader: { \n\n19\n\n Component: (props) => { \n\n20\n\n return ( \n\n21\n\n <ProfileChallenge \n\n22\n\n fallback={ \n\n23\n\n <HeroHeader \n\n24\n\n title=\"🔒 Auth Hero\" \n\n25\n\n subtitle=\"You should be logged in to see this content\" \n\n26\n\n /> \n\n27\n\n } \n\n28\n\n > \n\n29\n\n <HeroHeader {...props} /> \n\n30\n\n </ProfileChallenge> \n\n31\n\n ); \n\n32\n\n }, \n\n33\n\n }, \n\n34\n\n }, \n\n35\n\n}; \n\n36\n\n \n37\n\nexport { override }; \n\n`\n\n* Inside the `components` section, specific components (`HeroImage` and `HeroHeader`) are targeted for customization.\n* HeroImage Override: \n * A new component function is defined that wraps the original `HeroImage` component with `ProfileChallenge`. This ensures `ProfileChallenge` logic is applied to `HeroImage`.\n* HeroHeader Override: \n * A new component function is defined for `HeroHeader`. \n * It uses `ProfileChallenge` with a `fallback` property. \n * The `fallback` property defines what to display if the user isn't logged in. \n * Inside the `fallback`, a custom `HeroHeader` component is created with two editable properties, title (`Auth Hero`), and subtitle (`You should be logged in to see this content`). \n * If the user is logged in, the original `HeroHeader` content is displayed.\n1. Run `yarn dev` to sync the changes locally.\n2. Access the localhost available in the terminal, and without signing in to your account, you will see the following: \n\n\n### Step 3 - Promoting your changes\n\nAfter testing locally, you can promote your changes to production by doing the following:\n\n1. In your local store code, create a new branch with the changes you made.\n2. Push the changes to the new branch and publish it.\n3. Open a pull request in the store repository.\n4. If the checks and reviews are all good, merge the branch with the main one.\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/storefront-features/displaying-content-for-authenticated-users.mdx)\n\n[Building navigation menus« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-building-navigation-menus)[Implementing regionalization featuresNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-implementing-regionalization-features)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users%23before-you-begin)\n\n[Update the @faststore/core package](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users%23update-the-faststorecore-package)[Understand Section Override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users%23understand-section-override)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users%23instructions)\n\n[Step 1 - Override a component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users%23step-1-override-a-component)[Step 2 - Wrap the component with ProfileChallenge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users%23step-2-wrap-the-component-with-profilechallenge)[Step 3 - Create a component fallback](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users%23step-3-create-a-component-fallback)[Step 3 - Promoting your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users%23step-3-promoting-your-changes)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/storefront-features/displaying-content-for-authenticated-users.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users%23before-you-begin)\n\n[Update the @faststore/core package](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users%23update-the-faststorecore-package)[Understand Section Override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users%23understand-section-override)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users%23instructions)\n\n[Step 1 - Override a component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users%23step-1-override-a-component)[Step 2 - Wrap the component with ProfileChallenge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users%23step-2-wrap-the-component-with-profilechallenge)[Step 3 - Create a component fallback](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users%23step-3-create-a-component-fallback)[Step 3 - Promoting your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users%23step-3-promoting-your-changes)\n\nOn this page\n\n[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=)"
}
] |
doc_9d636152
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides configure the price history control in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n[Migrating your storefront from Legacy CMS Portal to Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io)\n\n[Can I order my product as I want?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/can-i-order-my-product-as-i-want)\n\n[List of controls for templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/list-of-controls-for-templates)\n\n[Setting up the zoom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/setting-up-the-zoom)\n\n[Creating gift lists](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/creating-gift-lists)\n\n[Validating a layout before moving it to production](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/validating-a-layout-before-moving-it-to-production)\n\n[How to use the page title control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/how-to-use-the-page-title-control)\n\n[How product name control works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/how-product-name-control-works)\n\n[Configure the price history control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/configure-the-price-history-control)\n\n[Shelf template controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/shelf-template-controls)\n\n[Control to disable the canonical tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/control-to-disable-the-canonical-tag)\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n[Migrating your storefront from Legacy CMS Portal to Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io)\n\n[Can I order my product as I want?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/can-i-order-my-product-as-i-want)\n\n[List of controls for templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/list-of-controls-for-templates)\n\n[Setting up the zoom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/setting-up-the-zoom)\n\n[Creating gift lists](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/creating-gift-lists)\n\n[Validating a layout before moving it to production](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/validating-a-layout-before-moving-it-to-production)\n\n[How to use the page title control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/how-to-use-the-page-title-control)\n\n[How product name control works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/how-product-name-control-works)\n\n[Configure the price history control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/configure-the-price-history-control)\n\n[Shelf template controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/shelf-template-controls)\n\n[Control to disable the canonical tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/control-to-disable-the-canonical-tag)\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/storefront-development)\n\n(Legacy) CMS Portal\n\n[Configure the price history control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/configure-the-price-history-control)\n\nConfigure the price history control\n\nThe past price control in VTEX is intended to show the lowest price invoiced for an item per month. In other words, it can show the lowest price for selling a particular item in your store.\n\n## Configuration\n\nThe control should be included in the product page's template as follows:\n\n`1\n\n \n2\n\n<b style={{ fontFamily: \"Inconsolata, monospace\", }}><vtex.cmc:StockKeepingUnitPriceHistory Months=\"6\" Percentile=\"100\"/> \n\n`\n\nSee the complete list of template controls [here](https://read.calvincode.net/reader?url=http://help.vtex.com/tutorial/lista-de-controles-para-templates/).\n\n## Behavior\n\nThe default exhibition method for the values looks like the image below. The year, month, and lowest amount invoiced this month are shown in sequence.\n\n\n\nIf you want to show these details in another way, you must get a layout agency to customize the model.\n\n### The _Months_ and _Percentile_ parameters\n\nTo allow more flexibility in showing values on the product page, you can use the **Months** parameter to define the number of months to be taken into account by the control.\n\nIf the parameter is \"6\", for example, the control will show the lowest amount invoiced for the item in each of the last six months.\n\nIn addition, it can happen that the lowest amount invoiced for the item is below the price usually applied by the store, for example, because of a specific promotion. You can use the parameter _**Percentile**_ to avoid showing this value.\n\nThis allows you to ignore peripheral values. For example, using the parameter with a value of 95 (Percentile=\"95\"), 5% of the amounts are ignored.\n\nUsing the parameter with a value of 90 (Percentile=\"90\"), 10% of the amounts are ignored.\n\nIn such cases, prices much below those normally applied will not be shown.\n\nIf there are price variations in a particular month, the control shows the lowest value invoiced for the item during the month.\n\nIf there were no sales of an item during the month, the control will not show a value for it.\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/acnmello)\n\n[](https://github.com/jumeyermattosarruda)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/legacy-cms/configure-the-price-history-control.md)\n\n[How product name control works« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control//docs/guides/how-product-name-control-works)[Shelf template controlsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control//docs/guides/shelf-template-controls)\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/acnmello)\n\n[](https://github.com/jumeyermattosarruda)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/configure-the-price-history-control%23configuration)\n\n[Behavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/configure-the-price-history-control%23behavior)\n\n[The Months and Percentile parameters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/configure-the-price-history-control%23the-months-and-percentile-parameters)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/legacy-cms/configure-the-price-history-control.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/configure-the-price-history-control%23configuration)\n\n[Behavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/configure-the-price-history-control%23behavior)\n\n[The Months and Percentile parameters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configure-the-price-history-control/docs/guides/configure-the-price-history-control%23the-months-and-percentile-parameters)\n\nOn this page\n\n[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=)"
}
] |
doc_1d0f11bc
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides weni by vtex cli command reference in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\nWeni by VTEX CLI\n\n[Using the Weni by VTEX CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/using-the-weni-by-vtex-cli)\n\n[Weni by VTEX CLI Command Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/weni-by-vtex-cli-command-reference)\n\n[Authenticating with your Weni by VTEX account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/authenticating-with-your-weni-by-vtex-account)\n\n[Managing your Weni by VTEX projects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/managing-your-weni-by-vtex-projects)\n\n[Understanding the core concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/weni-by-vtex-understanding-the-core-concepts)\n\n[Working with Weni by VTEX agents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/working-with-weni-by-vtex-agents)\n\n[Fetching and filtering logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/weni-by-vtex-fetching-and-filtering-logs)\n\n[Using Weni Run to execute tool tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/using-weni-run-to-execute-tool-tests)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\nWeni by VTEX CLI\n\n[Using the Weni by VTEX CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/using-the-weni-by-vtex-cli)\n\n[Weni by VTEX CLI Command Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/weni-by-vtex-cli-command-reference)\n\n[Authenticating with your Weni by VTEX account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/authenticating-with-your-weni-by-vtex-account)\n\n[Managing your Weni by VTEX projects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/managing-your-weni-by-vtex-projects)\n\n[Understanding the core concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/weni-by-vtex-understanding-the-core-concepts)\n\n[Working with Weni by VTEX agents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/working-with-weni-by-vtex-agents)\n\n[Fetching and filtering logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/weni-by-vtex-fetching-and-filtering-logs)\n\n[Using Weni Run to execute tool tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/using-weni-run-to-execute-tool-tests)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides)\n\nWeni by VTEX\n\nWeni by VTEX CLI\n\n[Weni by VTEX CLI Command Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/weni-by-vtex-cli-command-reference)\n\nWeni by VTEX CLI Command Reference\n\nLearn the command reference for the Weni by VTEX CLI.\n\nThis documentation includes the default commands available in [Weni by VTEX CLI](weni-byvtex-guide.md).\n\n## Default commands\n\nBelow is a brief description of the default commands available in Weni by VTEX CLI. For detailed information about each command, click on the respective command name. You can also get this information in your terminal by adding `--help` or `-h` after the command name.\n\n| Command name | Description |\n| -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| weni | Displays the main features and available commands directly in the terminal. |\n| weni --version | Displays the current version of the Weni by VTEX CLI installed on your system. |\n| weni init | Creates an initial setup ready for use and learning with Weni by VTEX. |\n| weni login | Authenticates with your Weni by VTEX platform account. |\n| weni project list | Lists existing projects in your account. |\n| weni project list --org <org\\_uuid> | Lists only projects from the specified organization UUID. |\n| weni project use \\[project\\_uuid\\] | Sets the active project by providing its UUID. |\n| weni project current | Identifies the project you are currently working with. |\n| weni project push \\[agent\\_definition\\_file\\] \\[--force-update\\] | Deploys/updates your agents using the specified agent definition file. |\n| weni run \\[agent\\_definition\\_file\\] \\[agent\\_key\\] \\[tool\\_key\\] \\[-f FILE\\] \\[-v\\] | Runs a specific tool from an agent locally. Specify a test file with \\-f/--file. If omitted, the CLI looks for test\\_definition.yaml in the tool folder. You can use \\-v to enable verbose logs. |\n| weni logs --agent <agent\\_key> --tool <tool\\_key> \\[--start-time ISO8601\\] \\[--end-time ISO8601\\] \\[--pattern TEXT\\] | Fetches tool execution logs. Supports pagination and ISO 8601 date formats (e.g. 2024-01-01T00:00:00). |\n\nContributors\n\n1\n\n[](https://github.com/mariananantua)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Weni-by-VTEX/CLI/weni-by-vtex-cli-command-reference.md)\n\n[Using the Weni by VTEX CLI« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference//docs/guides/using-the-weni-by-vtex-cli)[Authenticating with your Weni by VTEX accountNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference//docs/guides/authenticating-with-your-weni-by-vtex-account)\n\nContributors\n\n1\n\n[](https://github.com/mariananantua)\n\nON THIS PAGE\n\n[Default commands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/weni-by-vtex-cli-command-reference%23default-commands)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Weni-by-VTEX/CLI/weni-by-vtex-cli-command-reference.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Default commands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/weni-by-vtex-cli-command-reference/docs/guides/weni-by-vtex-cli-command-reference%23default-commands)\n\nOn this page\n\n[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=)"
}
] |
doc_80d1f52f
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides get cart installments information in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Simulate a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/simulate-a-shopping-cart)\n\n[Get current or create a new cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/create-a-new-cart)\n\n[Get cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/get-cart-information-by-id)\n\n[Remove all items from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/remove-all-items-from-cart)\n\n[Remove all personal data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/remove-all-personal-data)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/add-cart-items)\n\n[Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/update-cart-items)\n\n[Change the price of an SKU in a cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/change-price)\n\n[Ignore profile data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/ignore-profile-data)\n\n[Get cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/get-cart-installments-information)\n\n[Add coupons to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/add-coupons-to-the-cart)\n\n[Add a service (offering) to a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/add-service-to-the-cart)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Simulate a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/simulate-a-shopping-cart)\n\n[Get current or create a new cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/create-a-new-cart)\n\n[Get cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/get-cart-information-by-id)\n\n[Remove all items from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/remove-all-items-from-cart)\n\n[Remove all personal data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/remove-all-personal-data)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/add-cart-items)\n\n[Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/update-cart-items)\n\n[Change the price of an SKU in a cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/change-price)\n\n[Ignore profile data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/ignore-profile-data)\n\n[Get cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/get-cart-installments-information)\n\n[Add coupons to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/add-coupons-to-the-cart)\n\n[Add a service (offering) to a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/add-service-to-the-cart)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/checkout-api-overview)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Get cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/get-cart-installments-information)\n\nGet cart installments information\n\nThe shopping cart is where the information on the products chosen by the customer while browsing a store is gathered. This data may include item prices, shipping value, payment, and delivery methods, among others.\n\nThis guide will describe how to obtain information about the number of installments and their respective amounts from an existing payment method in the shopping cart.\n\n> Before starting the search for information about installments, make sure that there is already payment information (`paymentData`) assigned to the chosen cart (`orderFormId`).\n\n## Getting shopping cart information\n\nThe first step is to get the `orderFormId` of the shopping cart information that you want to obtain information about the amount of installments. For more information, access the [Get cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/get-cart-information-by-id) guide.\n\n## Accessing cart installments information\n\nWith the `orderFormId` information available, you must use the [Cart installments](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getcartinstallments) endpoint to send the following information through the URL:\n\n* **Path Param**: `orderFormId` value.\n* **Query Param**: `paymentSystem`. Payment method Id in which the installments information will be consulted.\n\nSee a URL example below:\n\n`https://{accountname}.{environment.com.br}/api/checkout/pub/orderForm/9420cbb7ebc34ca68a86621428816c5a?paymentSystem=2`\n\nAfter sending the request, the endpoint will return the response body containing the installments information, as shown in the example below:\n\n`1\n\n... \n\n2\n\n{ \n\n3\n\n \"paymentSystem\": \"2\", \n\n4\n\n \"bin\": null, \n\n5\n\n \"paymentName\": null, \n\n6\n\n \"paymentGroupName\": null, \n\n7\n\n \"value\": 6940, \n\n8\n\n \"installments\": [ \n\n9\n\n { \n\n10\n\n \"count\": 1, \n\n11\n\n \"hasInterestRate\": false, \n\n12\n\n \"interestRate\": 0, \n\n13\n\n \"value\": 6940, \n\n14\n\n \"total\": 6940, \n\n15\n\n \"sellerMerchantInstallments\": [ \n\n16\n\n { \n\n17\n\n \"id\": \"COSMETICS2\", \n\n18\n\n \"count\": 1, \n\n19\n\n \"hasInterestRate\": false, \n\n20\n\n \"interestRate\": 0, \n\n21\n\n \"value\": 6940, \n\n22\n\n \"total\": 6940 \n\n23\n\n } \n\n24\n\n ] \n\n25\n\n } \n\n26\n\n ] \n\n27\n\n} \n\n28\n\n... \n\n`\n\n> ️ For more information about the meaning of each of the fields available in the shopping cart, access the [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) overview.\n\n## Error codes\n\nThe following errors may appear as a message in the response body.\n\n### 400 - Bad Request\n\n* **Message error example (code ORD002)**: `\"Invalid order form\"`. The `orderFormId` information is not valid.\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"ORD002\", \n\n5\n\n \"message\": \"Invalid order form\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"d6a5b535-68b4-49f7-a783-93762974554b\" \n\n9\n\n} \n\n`\n\n* **Message error example (code CHK0152)**: `\"Orderform does not have installment options\"`. This shopping cart does not have any payment information (`paymentData`).\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"CHK0152\", \n\n5\n\n \"message\": \"Orderform does not have installment options\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"6d8408b4-3adf-4fc7-b708-8d322b3e021f\" \n\n9\n\n} \n\n`\n\n### 404 - Not Found\n\n* **Message error example**: `\"The requested URL was not found on the server\"`. Check that the URL data is correct.\n\n`1\n\n<body> \n\n2\n\n <h1>404 Not Found</h1> \n\n3\n\n <p>The requested URL was not found on this server.</p> \n\n4\n\n</body> \n\n`\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/shopping-cart-section-api-quick-start-guides/get-cart-installments-information.md)\n\n[Ignore profile data from cart« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information//docs/guides/ignore-profile-data)[Add coupons to the cartNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information//docs/guides/add-coupons-to-the-cart)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Getting shopping cart information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/get-cart-installments-information%23getting-shopping-cart-information)\n\n[Accessing cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/get-cart-installments-information%23accessing-cart-installments-information)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/get-cart-installments-information%23error-codes)\n\n[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/get-cart-installments-information%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/get-cart-installments-information%23404-not-found)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/shopping-cart-section-api-quick-start-guides/get-cart-installments-information.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Getting shopping cart information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/get-cart-installments-information%23getting-shopping-cart-information)\n\n[Accessing cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/get-cart-installments-information%23accessing-cart-installments-information)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/get-cart-installments-information%23error-codes)\n\n[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/get-cart-installments-information%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-installments-information/docs/guides/get-cart-installments-information%23404-not-found)\n\nOn this page\n\n[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=)"
}
] |
doc_fe5edbd5
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore styling overview in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/styling-overview)\n\n[Themes reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/themes-overview)\n\n[Global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/global-tokens-overview)\n\n[Iconography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/styling-icons)\n\n[Using themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/using-themes-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/styling-overview)\n\n[Themes reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/themes-overview)\n\n[Global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/global-tokens-overview)\n\n[Iconography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/styling-icons)\n\n[Using themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/using-themes-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore)\n\nStyling\n\nLearn how to style and customize your FastStore storefront.\n\nThe Styling section provides guides and best practices for customizing the look and feel of your FastStore storefront. Whether you want to apply a custom theme, adjust component styles, or leverage advanced CSS techniques, this category will help you in creating a brand-consistent ecommerce experience.\n\n[Global TokensLearn about design tokens for colors, spacing, typography, and more.See more](./global-tokens/overview)[IconsHow to use and customize icons in your FastStore project.See more](./icons)[ThemesExplore available themes and how to apply them to your storefront.See more](./themes/overview)[Using ThemesGuides for importing, customizing, and using themes and UI components.See more](./using-themes/overview)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/styling/overview.mdx)\n\n[Updating the @fastore/cli package version« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/developer-tools-updating-the-cli-package-version)[Themes referenceNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-overview/docs/guides/faststore/themes-overview)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/styling/overview.mdx)\n\nCopy page\n\nOn this page\n\nOn this page\n\n[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=)"
}
] |
doc_2d80097d
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides services 6 graphql retrieving data from master data in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/vtex-io-documentation-service)\n\n[Developing services on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/developing-services-on-vtex-io)\n\n[1\\. Getting started with the boilerplate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/services-1-getting-started-with-the-boilerplate)\n\n[2\\. Handling and receiving events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/services-2-handling-and-receiving-events)\n\n[3\\. Using the Analytics client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/services-3-using-the-analytics-client)\n\n[4\\. Using events as triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/services-4-using-events-as-triggers)\n\n[5\\. Using the Master Data client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/services-5-using-the-master-data-client)\n\n[6\\. Using GraphQL to retrieve data from Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/services-6-graphql-retrieving-data-from-master-data)\n\n[7\\. Using GraphiQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/services-7-using-graphiql)\n\n[Services - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/services-conclusion)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/vtex-io-documentation-clients)\n\nHandling events\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/service-path-patterns)\n\n[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/configuring-dynamic-routes-in-vtex-io-services)\n\n[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/vtex-io-documentation-developing-service-configuration-apps)\n\n[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/node-builder-7x-migration-guide)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/vtex-io-documentation-service)\n\n[Developing services on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/developing-services-on-vtex-io)\n\n[1\\. Getting started with the boilerplate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/services-1-getting-started-with-the-boilerplate)\n\n[2\\. Handling and receiving events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/services-2-handling-and-receiving-events)\n\n[3\\. Using the Analytics client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/services-3-using-the-analytics-client)\n\n[4\\. Using events as triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/services-4-using-events-as-triggers)\n\n[5\\. Using the Master Data client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/services-5-using-the-master-data-client)\n\n[6\\. Using GraphQL to retrieve data from Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/services-6-graphql-retrieving-data-from-master-data)\n\n[7\\. Using GraphiQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/services-7-using-graphiql)\n\n[Services - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/services-conclusion)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/vtex-io-documentation-clients)\n\nHandling events\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/service-path-patterns)\n\n[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/configuring-dynamic-routes-in-vtex-io-services)\n\n[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/vtex-io-documentation-developing-service-configuration-apps)\n\n[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/node-builder-7x-migration-guide)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/app-development)\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/vtex-io-documentation-service)\n\n[Developing services on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/developing-services-on-vtex-io)\n\n[6\\. Using GraphQL to retrieve data from Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/services-6-graphql-retrieving-data-from-master-data)\n\n6\\. Using GraphQL to retrieve data from Master Data\n\nNow that we have updated the product count, we need to retrieve the top N most viewed products. To do so, we can use Master Data to retrieve the product page view data and sort by the `count` field. We can also limit the length of retrieved products, creating a customized size rank of most-visited products.\n\nTo achieve this objective, we'll employ [GraphQL](https://read.calvincode.net/reader?url=https://graphql.org/), the technology used by VTEX IO for data retrieval and interface between services and front-end applications. GraphQL allows implementing queries for fetching the exact data you need via types, schemas, and resolvers.\n\n## Using the `graphql` builder\n\nTo enable the use of [GraphQL](https://read.calvincode.net/reader?url=https://graphql.org/) in your VTEX IO app, add the `graphql` builder to the app's `manifest.json` file.\n\n## Creating the GraphQL type\n\nWithin the `service-course-template/graphql` folder, create a folder named `types`. Inside this folder, create the `productView.graphql` file to declare the type of the product list we intend to retrieve.\n\n## Creating the GraphQL schema\n\nStill within the `service-course-template/graphql` folder, define the schema in the `schema.graphql` file. This schema outlines the structure of our query and the data to be retrieved.\n\n> Optionally, [directives](https://read.calvincode.net/reader?url=https://graphql.org/learn/queries/%23directives) can be included for scenarios like obtaining user tokens or utilizing cookies. Check out the [graphql-example](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/graphql-example) app for advanced usage examples.\n\n## Creating the GraphQL resolver\n\nWith the schema, types, and query defined, create the query's resolver. The resolver determines the actions executed when a query is invoked. In our case, we want to perform a [scroll](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries) on Master Data, ordering by the count (to obtain the top most viewed products) and limiting the page size (the top N).\n\nBack to our `node` implementation, define the resolver by creating a `node/resolvers` folder. In this new folder, add a file named `products.ts` and populate it with the code presented in the right panel.\n\n## Using the GraphQL resolver\n\nImport the resolver into the `node/index.ts` file and set up the `graphql` section, connecting your defined queries with the underlying data retrieval logic (`productList`).\n\nNote that resolvers act as the glue between your GraphQL schema and the actual data-fetching logic. When a GraphQL query is executed, the resolver associated with each field in the query is invoked to obtain the corresponding data. In this case, when the `productList` query is executed, the `productList` resolver function (`products.ts`) is triggered to fetch the top N most viewed products from Master Data.\n\n## Linking the app\n\nFinally, run `vtex link` and access the provided GraphQL route.\n\nservice-course-template/manifest.json\n\n`1\n\n{ \n\n2\n\n \"name\": \"backend-course\", \n\n3\n\n \"vendor\": \"vtex\", \n\n4\n\n \"version\": \"0.0.2\", \n\n5\n\n \"title\": \"Backend Course\", \n\n6\n\n \"description\": \"Reference app for the Backend Course\", \n\n7\n\n \"builders\": { \n\n8\n\n \"graphql\": \"1.x\", \n\n9\n\n \"node\": \"7.x\" \n\n10\n\n }, \n\n11\n\n \"scripts\": { \n\n12\n\n \"prereleasy\": \"bash lint.sh\" \n\n13\n\n }, \n\n14\n\n \"credentialType\": \"absolute\", \n\n15\n\n \"policies\": [ \n\n16\n\n { \n\n17\n\n \"name\": \"ADMIN_DS\" \n\n18\n\n }, \n\n19\n\n { \n\n20\n\n \"name\": \"outbound-access\", \n\n21\n\n \"attrs\": { \n\n22\n\n \"host\": \"api.vtex.com\", \n\n23\n\n \"path\": \"/dataentities/*\" \n\n24\n\n } \n\n25\n\n } \n\n26\n\n ], \n\n27\n\n \"dependencies\": { \n\n28\n\n \"vtex.events-example\": \"0.x\" \n\n29\n\n }, \n\n30\n\n \"$schema\": \"https://raw.githubusercontent.com/vtex/node-vtex-api/master/gen/manifest.schema\" \n\n31\n\n} \n\n`\n\nContributors\n\n2\n\n[](https://github.com/henriquessb)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/services/services-6-graphql-retrieving-data-from-master-data.mdx)\n\n[5\\. Using the Master Data client« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data//docs/guides/services-5-using-the-master-data-client)[7\\. Using GraphiQLNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data//docs/guides/services-7-using-graphiql)\n\nContributors\n\n2\n\n[](https://github.com/henriquessb)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Using the graphql builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/services-6-graphql-retrieving-data-from-master-data%23using-the-graphql-builder)\n\n[Creating the GraphQL type](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/services-6-graphql-retrieving-data-from-master-data%23creating-the-graphql-type)\n\n[Creating the GraphQL schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/services-6-graphql-retrieving-data-from-master-data%23creating-the-graphql-schema)\n\n[Creating the GraphQL resolver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/services-6-graphql-retrieving-data-from-master-data%23creating-the-graphql-resolver)\n\n[Using the GraphQL resolver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/services-6-graphql-retrieving-data-from-master-data%23using-the-graphql-resolver)\n\n[Linking the app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/services-6-graphql-retrieving-data-from-master-data%23linking-the-app)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/services/services-6-graphql-retrieving-data-from-master-data.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Using the graphql builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/services-6-graphql-retrieving-data-from-master-data%23using-the-graphql-builder)\n\n[Creating the GraphQL type](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/services-6-graphql-retrieving-data-from-master-data%23creating-the-graphql-type)\n\n[Creating the GraphQL schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/services-6-graphql-retrieving-data-from-master-data%23creating-the-graphql-schema)\n\n[Creating the GraphQL resolver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/services-6-graphql-retrieving-data-from-master-data%23creating-the-graphql-resolver)\n\n[Using the GraphQL resolver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/services-6-graphql-retrieving-data-from-master-data%23using-the-graphql-resolver)\n\n[Linking the app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-6-graphql-retrieving-data-from-master-data/docs/guides/services-6-graphql-retrieving-data-from-master-data%23linking-the-app)\n\nOn this page\n\n[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=)"
}
] |
doc_121d7bdd
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX alexa certify code app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/troubleshooting)\n\n[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.alexa-certify-code/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/vtex-io-apps)\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/guides/pixel-apps)\n\nAlexa Certify\n\nOfficial extension\n\nVersion: 1.0.0\n\nLatest version: 1.0.0\n\nThis app adds the [Alexa Certify Code](https://read.calvincode.net/reader?url=https://support.alexa.com/hc/en-us/sections/200063374-Certified-Site-Metrics) to your store.\n\n## Configuration\n\n[Installing the app](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/store/installing-an-app) running the following command:\n\n`1\n\nvtex install vtex.alexa-certify@1.x \n\n`\n\nNext, open the app settings on your admin and fill the form with your Alexa Account and Domain.\n\n[Pixel Apps« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/guides/pixel-apps)[AudaraNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.audara)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.alexa-certify-code/docs/apps/vtex.alexa-certify-code%23configuration)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_de39f8b8
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore molecules icon button in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/components-index)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-overview)\n\nIconButton\n\nUse icons instead of labels in buttons.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/IconButton)\n\nThe `IconButton` is an icon that trigger some sort of action, such as adding an item to the cart.\n\nExample\n\nCode\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { IconButton } from '@faststore/ui' \n\n`\n\n### Import styles\n\nTo apply styles, include the following in your stylesheet:\n\n`1\n\n@import '@faststore/ui/src/components/atoms/Button/styles.scss'; \n\n`\n\nFor details, see [Importing FastStore UI component styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles).\n\n---\n\n## Data attributes\n\nYou can target and override `IconButton` styles using the following data attributes:\n\n`data-fs-icon-button`\n\nThis component inherits [Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button) CSS selectors and styles.\n\n---\n\n## Props\n\n| Name | Type | Description | Default | | | | | | |\n| ---------------- | ------------------------ | -------------------------------------------------------------------------------------- | -------------------------------------- | -- | ------------------------ | --------------------------- | ------------------- | ----------- | --------------------------------------------------- |\n| **testId** | string | ID to find this component in testing tools (e.g.: cypress, testing library, and jest). | fs-icon-button | | | | | | |\n| **icon\\*** | string \\| number | false | true | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | A React component that will be rendered as an icon. |\n| **aria-label\\*** | string | A Label should be provided. | | | | | | | |\n| **variant** | \"primary\" \\| \"secondary\" | \"tertiary\" | Specifies the component color variant. | | | | | | |\n| **size** | \"small\" \\| \"regular\" | Specifies the size variant. | regular | | | | | | |\n| **inverse** | false \\| true | Defines the use of inverted colors. | | | | | | | |\n| **disabled** | false \\| true | Specifies that this button should be disabled. | | | | | | | |\n| **loading** | false \\| true | Boolean that represents a loading state. | | | | | | | |\n| **loadingLabel** | string | Specifies a label for loading state. | | | | | | | |\n| **iconPosition** | \"left\" \\| \"right\" | Specifies where the icon should be positioned | | | | | | | |\n\n---\n\n## Best practices\n\n### ✅ Do's\n\n* Use icon-only buttons only for widespread actions with highly standardized icons, such as a cross for close.\n* Use the `aria-label` attribute to provide a textual alternative for icon-only buttons.\n\n### ❌ Don'ts\n\n* Don't rely on icons to communicate complex actions.\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/aliceoq)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/molecules/icon-button.mdx)\n\n[Gift« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-gift)[InputFieldNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-input-field)\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/aliceoq)\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-icon-button%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-icon-button%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-icon-button%23import-styles)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-icon-button%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-icon-button%23props)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-icon-button%23best-practices)\n\n[✅ Do's](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-icon-button%23-dos)[❌ Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-icon-button%23-donts)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/molecules/icon-button.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-icon-button%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-icon-button%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-icon-button%23import-styles)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-icon-button%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-icon-button%23props)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-icon-button%23best-practices)\n\n[✅ Do's](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-icon-button%23-dos)[❌ Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button/docs/guides/faststore/molecules-icon-button%23-donts)\n\nOn this page\n\n[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=)"
}
] |
doc_22aa1fda
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Explain the VTEX api reference checkout api API and how to use it."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/checkout-api/)\n\nShopping cart\n\nCart attachments\n\nCustom data\n\nConfiguration\n\nFulfillment\n\nOrder placement\n\nRegion\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/checkout-api/)\n\nShopping cart\n\nCart attachments\n\nCustom data\n\nConfiguration\n\nFulfillment\n\nOrder placement\n\nRegion\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[GeGet Gift List« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/catalog-api%23get-/api/addon/pvt/giftlist/get/-listId-)[PoCart simulationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForms/simulation)\n\n[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=)"
}
] |
doc_52e9275f
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides get a list of the possible facets for a specific search in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n[How search parameters work](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/how-search-parameters-work)\n\n[Search Control – fulltextSearchBox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/search-control-fulltextsearchbox)\n\n[Consult store search terms information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/consult-store-search-terms-information)\n\n[Consult product search information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/consult-product-search-information)\n\n[Get banner list for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/get-banner-list-for-a-specific-search)\n\n[Get a list of the possible facets for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search)\n\n[Segmenting the search result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/vtex-io-documentation-segmenting-the-search-result)\n\n[Access Control List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/access-control-list)\n\n[Delivery promise for headless stores (Beta)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/delivery-promise-for-headless-stores)\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n[How search parameters work](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/how-search-parameters-work)\n\n[Search Control – fulltextSearchBox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/search-control-fulltextsearchbox)\n\n[Consult store search terms information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/consult-store-search-terms-information)\n\n[Consult product search information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/consult-product-search-information)\n\n[Get banner list for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/get-banner-list-for-a-specific-search)\n\n[Get a list of the possible facets for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search)\n\n[Segmenting the search result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/vtex-io-documentation-segmenting-the-search-result)\n\n[Access Control List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/access-control-list)\n\n[Delivery promise for headless stores (Beta)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/delivery-promise-for-headless-stores)\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides)\n\nSearch\n\n[Get a list of the possible facets for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search)\n\nGet a list of the possible facets for a specific search\n\nFacets represent the combination of filters that are selected in a search. To retrieve a list of possible facets for a specific search, use the [Get list of the possible facets for a given query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api%23get-/facets/-facets-) endpoint. You can filter the endpoint response by defining the search's `facets` and the term's `locale` and `query`.\n\nA facet value is only returned in the response if at least one of the products returned in the query has this value.\n\nAll information is synced with the Catalog. Therefore, if a specification is configured non-filterable, it will not be returned by the Search API.\n\n**Response body example:**\n\n`1\n\n{ \n\n2\n\n \"facets\": [ \n\n3\n\n { \n\n4\n\n \"type\": \"TEXT\", \n\n5\n\n \"name\": \"string\", \n\n6\n\n \"hidden\": false, \n\n7\n\n \"quantity\": 0, \n\n8\n\n \"values\": [ \n\n9\n\n { \n\n10\n\n \"id\": \"string\", \n\n11\n\n \"quantity\": 0, \n\n12\n\n \"name\": \"string\", \n\n13\n\n \"key\": \"string\", \n\n14\n\n \"value\": \"string\", \n\n15\n\n \"selected\": false \n\n16\n\n } \n\n17\n\n ] \n\n18\n\n } \n\n19\n\n ], \n\n20\n\n \"sampling\": false, \n\n21\n\n \"breadcrumb\": [ \n\n22\n\n { \n\n23\n\n \"name\": \"string\", \n\n24\n\n \"href\": \"string\" \n\n25\n\n } \n\n26\n\n ], \n\n27\n\n \"queryArgs\": { \n\n28\n\n \"query\": \"string\", \n\n29\n\n \"selectedFacets\": [ \n\n30\n\n { \n\n31\n\n \"key\": \"string\", \n\n32\n\n \"value\": \"string\" \n\n33\n\n } \n\n34\n\n ] \n\n35\n\n } \n\n36\n\n} \n\n`\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Search/get-a-list-of-the-possible-facets-for-a-specific-search.md)\n\n[Get banner list for a specific search« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search//docs/guides/get-banner-list-for-a-specific-search)[Segmenting the search resultNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search//docs/guides/vtex-io-documentation-segmenting-the-search-result)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Search/get-a-list-of-the-possible-facets-for-a-specific-search.md)\n\nCopy page\n\nOn this page\n\nOn this page\n\n[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=)"
}
] |
doc_152140c4
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX checkout ui custom app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/troubleshooting)\n\n[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.checkout-ui-custom/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.checkout-ui-custom)\n\n[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.messages)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/guides/affiliates-program-app)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.checkout-ui-custom)\n\n[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.messages)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/guides/affiliates-program-app)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/vtex-io-apps)\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/guides/functional-apps)\n\nCheckout UI Custom\n\nOfficial extension\n\nVersion: 0.20.1\n\nLatest version: 0.20.1\n\n## ⚠️ Maintenance ⚠️\n\n_Starting June 1st 2023, this application will no longer be maintained by VTEX._\n\n---\n\nThe Checkout UI Custom app is responsible for customizing your store's Checkout UI through the admin's interface.\n\n\n\n## Configuration\n\n1. Using your terminal and the [VTEX IO Toolbelt](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/development/vtex-io-cli-installment-and-command-reference), log into the desired VTEX account.\n2. Run `vtex install vtex.checkout-ui-custom` on the account you're working on.\n3. Access your VTEX account's admin.\n4. Access **Store Setup** and then **Checkout UI Custom**.\n5. Make the desired changes using the interface and click on `Publish`.\n\nℹ️ \\_Once the app is installed in your account, the `checkout6-custom.js` and `checkout6-custom.css` files will be replaced by the ones generated by this app.\\*\n\n## Modus Operandi\n\nIf you access your VTEX account's admin using a [Development workspace](https://read.calvincode.net/reader?url=https://vtex.io/docs/concepts/workspace/) and publish your changes, the configurations performed using the app will only be applied into the workspace you are working in and not in your store Checkout.\n\nHowever, notice the following: **you should not perform any changes in your account's Master workspace to make your Checkout UI configurations publicly available**. Instead, you should use a Development workspace and the **History** tab displayed on the admin app.\n\nThe `History` tab enables you to load app change history and, therefore, helps your checkout UI coding by reusing configurations performed in previous workspaces.\n\nLet's assume you were working in a [Development workspace](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/development/creating-a-development-workspace) called `testredcolor`, and now want your changes to be public. According to how workspaces work in the platform, your changes first need to be applied in a [Production workspace](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/development/creating-a-production-workspace) that, in turn, will be [promoted to Master](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/development/promoting-a-workspace-to-master) later.\n\nFor this purpose, you can access the `History` tab using the desired Production workspace, load your last changes from `testredcolor` and then click on `Publish`, copying your configurations to the Production workspace you are currently working in.\n\n⚠️ _The Header and Footer HTMLs are still configured using the admin's Portal (`/admin/portal/#/sites`). In order to properly use the Checkout UI Custom app, it is strongly recommended to use the HTMLs stated below:_\n\n* **Header HTML:**\n\n`1\n\n<header class=\"main-header\"> \n\n2\n\n <div class=\"container\"> \n\n3\n\n <div class=\"header-link\"> \n\n4\n\n <a href=\"/\" title=\"add more products\" class=\"buy-more-link link\" \n\n5\n\n >Continue shopping</a \n\n6\n\n > \n\n7\n\n <a \n\n8\n\n href=\"/checkout/#/cart\" \n\n9\n\n title=\"back to cart\" \n\n10\n\n class=\"back-cart-link link\" \n\n11\n\n >Back to Cart</a \n\n12\n\n > \n\n13\n\n </div> \n\n14\n\n <a href=\"/\" title=\"Go to homepage\" class=\"logo\">{logo.image}</a> \n\n15\n\n </div> \n\n16\n\n</header> \n\n`\n\nIf you want to insert other contents, make sure of include the class `.v-custom-mhide` to hide it on mobile resolutions. For example:\n\n`1\n\n<header class=\"main-header\"> ... </header> \n\n2\n\n<div class=\"promobar v-custom-mhide> ... </div> \n\n`\n\n* **Footer HTML:**\n\n`1\n\n<footer class=\"main-footer\"> \n\n2\n\n <div class=\"container\"> \n\n3\n\n <a class=\"credits-vtex\" href=\"http://www.vtex.com/\" target=\"_blank\" \n\n4\n\n ><img src=\"http://brand.vtex.com/static/media/VTEX_pink_RGB.751a9fb5.svg\" \n\n5\n\n /></a> \n\n6\n\n </div> \n\n7\n\n</footer> \n\n`\n\nIf you are yet using the classic CMSYou can create a workspace and install the app by there. While using the app, you will need apply your changes and copy/paste the content of the files to your portal.\n\n## For VTEX Developers\n\nWhen developing a new version of Checkout UI Custom, take care to compile the checkout files prior to opening a PR and/or publishing a new version of the app. This can be done by running `yarn app` in your CLI, inside the app's `/checkout-ui-custom/` subfolder.\n\nDuring implementation, you will need to run `vtex link` on the root folder and also watch assets by running `yarn watch` in the `/checkout-ui-custom/` subfolder\n\n❗Note that during implementation, avoid publishing changes to the workspace. As this will permanently add the changes to the workspace and any changes to the app will not be shown.\n\n# \n\n[Catalog Images« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.catalog-images)[Checkout UI SettingsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.checkout-ui-settings)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[⚠️ Maintenance ⚠️](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.checkout-ui-custom%23-maintenance-)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.checkout-ui-custom%23configuration)\n\n[Modus Operandi](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.checkout-ui-custom%23modus-operandi)\n\n[For VTEX Developers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-custom/docs/apps/vtex.checkout-ui-custom%23for-vtex-developers)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_a0d452bb
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides change order in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n[Feed v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/orders-feed)\n\n[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/order-modifications)\n\n[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/change-seller)\n\n[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/order-canceling-improvements)\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/actions-orders)\n\nSubscriptions\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n[Feed v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/orders-feed)\n\n[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/order-modifications)\n\n[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/change-seller)\n\n[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/order-canceling-improvements)\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/actions-orders)\n\nSubscriptions\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides)\n\nOrders\n\n[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/order-modifications)\n\nOrder modifications\n\nOrder modification is a feature that allows your store to modify the items or prices of an order. With this feature, the store can handle potential changes in orders due to customer mistakes, product unavailability, and the inclusion of discounts, among other reasons. Learn more about how it works and its restrictions in the article [Changing items from a completed order](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/changing-items-from-a-complete-order--tutorials%5F190).\n\n> We recommend that you use the [Create order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23patch-/api/order-system/orders/-changeOrderId-/changes) endpoint to modify an order.\n\n> The [Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23patch-/api/order-system/orders/-changeOrderId-/changes) feature is not applicable to the Catalog API - Seller Portal.\n\n> Learn more about [Order replacement](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/order-replacement--2IK9mwQjBKseQmE8K8saO8) and how to enable your customers to request order changes.\n\n## Implementation\n\nThe [Register modifications on order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/changes) endpoint in the Orders API allows you to create a discount, change an item, or increase the price of an order.\n\n> When removing or adding items to an order, the inventory of the affected SKUs is not updated automatically. You should update it [using the Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23put-/logistics/pvt/inventory/skus/-skuId-/warehouses/-warehouseId-).\n\nModifications made this way can be confirmed using the `changesAttachment` field in the response of the [Get order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/oms/pvt/orders/-orderId-) endpoint. Alternatively, you may search for the order in the **Orders > Orders management > All orders** section of your Admin panel and see the item modification history in the order details.\n\n> Increasing the price of an order is only available for credit card purchases. The connector must also be able to handle purchases without the CVV, as well as duplicate sequences.\n\n### Errors in Change v1\n\nSee below which API errors can be returned when attempting to [modify an order via Change v1 API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/changes) and how to avoid or work around them.\n\n#### Request errors\n\nThese errors happen when there are one or more errors in the information sent in the request.\n\n| Error | Description |\n| ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| The modification value needs to be greater or equal than zero | discountValue or incrementValue is less than 0. |\n| Invalid modification for order | All of these conditions are true: \\- incrementValue is equal to discountValue. \\- itemsAdded is empty. \\- itemsRemoved is empty. |\n| Invalid id for item | The request body contains either an itemsAdded or itemsRemoved object that has an empty id. |\n| Field reason not set | Empty reason field. |\n\n#### Restriction errors\n\nThese are errors returned when the request is correct but the order cannot be modified due to [order change restrictions](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/changing-items-from-a-complete-order--tutorials%5F190%23restrictions).\n\n| Error | Description |\n| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| It is only allowed to register an order modification when the order is in handling: status = handling, waiting for fulfillment or ready for invoicing | The fulfillment order is not in a status that allows changes (handling, waiting for fulfillment and ready-for-invoice). |\n| It is not allowed to make modifications to chain orders | The order has a chain origin. |\n| It is only allowed to register a modification in the order when the payment is approved - status = payment-approved | The marketplace order is not in the status payment-approved. |\n| The value of the modification exceeds the order's price | discountValue is greater than the total order price. |\n| Impossible cancel order {0} - Payment not found | Order is complete, but transaction id is empty or null. |\n| Workflow not found for order {0} | Order has an empty or null workflowInstanceId. |\n| Max allowed modifications for order exceeded: {0} | More than 50 registered modification requests for a single order. |\n| 404 Not Found | At least one of these conditions is true: \\- The removed item does not exist in the order. \\- The added item does not exist in the catalog. |\n| Invalid quantity to remove from item {0} | An item's quantity would be reduced to less than 0 after the modification. |\n| It's not allowed to make modifications in orders without a credit card payment, promissory card, cash, or credit control | All of these conditions are true: \\- An attempt to increase order price was made. \\- The payment method does not support value changes. \\- The payment method is not credit card payment, promissory card, cash, or credit control. Consult your payment gateway to see which methods allow for order value changes. |\n| Modification cannot be done. Possible reason: settlement directly done by API | All of these conditions are true: \\- An attempt to reduce order price. \\- The payment method does not support value modifications. Consult your payment gateway to see which methods allow for order value modifications. |\n| The value of the modification exceeds the order's price | discountValue is greater than the amount allowed for the order transaction. |\n| 500 Internal Server Error | There is an issue with the payment gateway. |\n\n### Errors in Change v2\n\nSee below which API errors can be returned when attempting to [modify an order via Change v2 API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/changes) and how to avoid or work around them.\n\n#### Errors with exception codes\n\n| Error code | Error message | Description |\n| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| CHK0022 | Invalid id for item. | The item id is not valid or does not exist. |\n| CHK0023 | Invalid quantity for item. | The item quantity is not allowed (e.g., less than 1). |\n| CHK0034 | The value of the change exceed the order's price. | The modification value is greater than the total order price. |\n| CHK0095 | Changes in chain orders are not allowed. | Chain orders do not support modifications. |\n| CHK0096 | Change cannot be done. Possible reason: settlement directly done by API. | The change operation is not allowed, possibly due to a direct settlement. |\n| CHK0098 | The change value needs to be greater or equal than zero. | The value for the change operation must not be negative. |\n| CHK0124 | Invalid change for order. | The requested modification is not valid for the current order state or data. **Allowed order states for order modification:** handling, waiting-for-fulfillment, and ready-for-invoicing. |\n| CHK0196 | Cannot cancel order {0} - Payment not found. | The order cannot be canceled because no payment was found. |\n| CHK0199 | OrderGroup {0} not found. | The order group does not exist. |\n| CHK0201 | Order {0} not found. | The order does not exist. Please verify the order ID in your operation. |\n| CHK0229 | Workflow not found for order {0}. | No workflow was found for the order. |\n| CHK0289 | Change order request {0} not found. | The modification order request does not exist. |\n| CHK00342 | Change order cannot increase the value for this payment method. | Increasing the order value is not allowed for the selected payment method. |\n| SalesOrderSystem008 | Cannot Change Cancelled Order. | Changes cannot be made to orders that have already been canceled. |\n| SalesOrderSystem010 | It's not possible to remove the item of ID {0} from the original order. Validate your {1} operation items IDs. | The specified item id cannot be removed from the original order. Please verify the item id in your operation. |\n| SalesOrderSystem011 | It's not possible to remove more than {0} quantities of the item of ID {1} from the original order. Validate your items quantities at Remove or Replace From operations. | The quantity being removed exceeds the quantity available in the order. Please verify the item quantity in your operation. |\n| SalesOrderSystem012 | The logistics information couldn't be determined for the item due to the presence of multiple options. | The order contains multiple logistics options, so the system cannot infer which one to use. Please verify the logisticsInfo field in your operation. |\n| SalesOrderSystem013 | The logistics information provided was not found on the order. | The logistics details given do not match any information in the order. Please verify the logisticsInfo field in your operation. |\n| SalesOrderSystem014 | Change In Progress. | A change operation is currently in progress for this order. You can try making a new operation once the change in progress is finalized. |\n| SalesOrderSystem015 | A Change V1 has already been applied to this order. Orders can only contain one Change Order version at a time. | Only one type of order change (v1 or v2) can be applied. A v1 change already exists. |\n| SalesOrderSystem016 | Cannot Retry Change. | The change operation cannot be retried since the workflow status is done or canceled. |\n| SalesOrderSystem017 | Change process was automatically canceled after failed retries. | The modification was canceled by the system after several failed retry attempts. You should use the [Create order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23patch-/api/order-system/orders/-changeOrderId-/changes?endpoint=patch-/api/order-system/orders/-changeOrderId-/changes) endpoint. |\n| SalesOrderSystem018 | Unable to communicate with Participants Client. | The system could not reach the Participants Client service. |\n| SalesOrderSystem019 | Cannot Update Change Order Settings. | Settings are being updated by another request. You can try again later. |\n| SalesOrderSystem026 | Unable to match an item to the information provided. Try providing the item's uniqueId for identification. | The item could not be identified with the given data. Try using the item's uniqueId. |\n| SalesOrderSystem027 | Change Settings Not Found. | Change order settings could not be found for this configuration. |\n| SalesOrderSystem029 | Cannot Add New Products At Change Order When Order Has Multiple Address. | When the order has multiple delivery addresses, you can only modify the existing items, not add new ones. |\n| SalesOrderSystem035 | The {0} is not a valid Agreement Type. | The agreement type is not recognized or supported. **Allowed:** Acknowledgment or Confirmation. |\n| SalesOrderSystem045 | Invalid address. | The address is invalid. Please verify the addressId field in your operation. |\n| SalesOrderSystem046 | The order change is not allowed after the item invoice has been issued. | Order modification is not allowed after the invoice has been issued. |\n| SalesOrderSystem047 | The address change is not allowed. | The address modification is not allowed. |\n| SalesOrderSystem048 | The address change is not allowed when there are packages associated. | The address modification is not allowed when there are packages associated. |\n| SalesOrderSystem051 | Change order not allowed with tax hub and multiple delivery docks. | Order modification is not allowed with tax hub and multiple delivery docks. |\n| SalesOrderSystem055 | Item modification is not allowed when the measurement unit differs from the original. | Item modification is not allowed when the measurement unit differs from the original. To change the measurement unit, try using the replace array and modifying its to and from objects. |\n\nContributors\n\n2\n\n[](https://github.com/mariananantua)\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/erp-integration-guide/order-modifications.md)\n\n[Feed v3« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order//docs/guides/orders-feed)[Change sellerNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order//docs/guides/change-seller)\n\nContributors\n\n2\n\n[](https://github.com/mariananantua)\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/order-modifications%23implementation)\n\n[Errors in Change v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/order-modifications%23errors-in-change-v1)[Errors in Change v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/order-modifications%23errors-in-change-v2)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/erp-integration-guide/order-modifications.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/order-modifications%23implementation)\n\n[Errors in Change v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/order-modifications%23errors-in-change-v1)[Errors in Change v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/order-modifications%23errors-in-change-v2)\n\nOn this page\n\n[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=)"
}
] |
doc_8238d590
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore feature search in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-overview)\n\n[Adding third-party scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-handling-third-party-scripts)\n\n[Building navigation menus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-building-navigation-menus)\n\n[Displaying content for authenticated users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users)\n\n[Implementing regionalization features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-implementing-regionalization-features)\n\n[Implementing search features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-implementing-search-features)\n\n[Managing product images in specific contexts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-managing-product-images-in-specific-contexts)\n\n[Implementing Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/delivery-promise-implementation)\n\n[Implementing Live Shopping for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-overview)\n\n[Adding third-party scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-handling-third-party-scripts)\n\n[Building navigation menus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-building-navigation-menus)\n\n[Displaying content for authenticated users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users)\n\n[Implementing regionalization features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-implementing-regionalization-features)\n\n[Implementing search features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-implementing-search-features)\n\n[Managing product images in specific contexts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-managing-product-images-in-specific-contexts)\n\n[Implementing Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/delivery-promise-implementation)\n\n[Implementing Live Shopping for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-overview)\n\nImplementing search features\n\nThis feature enables customers to find their search easier.\n\nThe Search feature is based on the Autocomplete functionality to enhance user search experiences. Autocomplete dynamically displays relevant search suggestions based on current and past search queries. The feature includes four different lists, which can be presented collectively or individually based on user interaction preferences. The existing sections within Autocomplete are as follows:\n\n* **Last Searches:** Displays a list of the user's most recent search queries.\n* __Search Suggestions: Offers real-time suggestions based on the user's current input._\n* **Product suggestion:** Provides relevant product recommendations based on the search query.\n* **Most searched terms:** Highlights popular and frequently searched terms.\n\nRefer to the [Autocomplete in VTEX Intelligent Search](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/4gXFsEWjF7QF7UtI2GAvhL) for more information.\n\n---\n\n## Usage\n\nTo integrate the `<SearchInput />` component, refer to the provided example in the [FastStore Core](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/core/src/components/search/SearchInput).\n\n> You can add this component to your store where you need it, with the Navbar being a recommended location.\n\n---\n\n## Components\n\n* History \nClear History \n 1. [Headphone](#) \n 2. [Audio & Video](#) \n 3. [mh-7000](#) \nSearch History \nResponsible for showing the latest terms searched by a user. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/molecules-search-history)\n* Top Search \n 1. [1Notebooks](#) \n 2. [2Laser Printer](#) \n 3. [3Bluetooth Keyboard](#) \nSearch Top \nDisplays the most searched terms by customers. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/molecules-search-top)\n* 1. [appl**e airpods**](#) \n 2. [appl**e tv**](#) \nSearch Auto Complete \nList of auto completing suggestions based on the searched term. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/molecules-search-auto-complete)\n* Suggested Products \n 1. [Apple Magic MouseOriginal price:$999Price:$950.04](#) \n 2. [Apple Magic MouseOriginal price:$999Price:$950.04](#) \nSearch Products \nList of `SearchProductItem` to show details of the suggested products. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/molecules-search-products)\n* History \nClear History \n 1. [Headphone](#) \n 2. [Audio & Video](#) \n 3. [mh-7000](#) \nTop Search \n 1. [1Notebooks](#) \n 2. [2Laser Printer](#) \n 3. [3Bluetooth Keyboard](#) \nSearch Dropdown \nCombine `SearchHistory`, `SearchTop` `SearchAutoComplete` and `SearchProducts` to show all options in `SearchInput`. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/molecules-search-dropdown)\n* Search Input Field \nAn `InputField` with a search button. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/molecules-search-input-field)\n* Search Input \nThe `SearchInput` is responsible for receiving, searching and displaying suggestions. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/organisms-search-input)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/storefront-features/implementing-search-features.mdx)\n\n[Implementing regionalization features« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-implementing-regionalization-features)[Managing product images in specific contextsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-managing-product-images-in-specific-contexts)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-implementing-search-features%23usage)\n\n[Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-implementing-search-features%23components)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/storefront-features/implementing-search-features.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-implementing-search-features%23usage)\n\n[Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-implementing-search-features%23components)\n\nOn this page\n\n[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=)"
}
] |
doc_a658774a
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides services 3 using the analytics client in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-service)\n\n[Developing services on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/developing-services-on-vtex-io)\n\n[1\\. Getting started with the boilerplate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-1-getting-started-with-the-boilerplate)\n\n[2\\. Handling and receiving events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-2-handling-and-receiving-events)\n\n[3\\. Using the Analytics client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client)\n\n[4\\. Using events as triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-4-using-events-as-triggers)\n\n[5\\. Using the Master Data client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-5-using-the-master-data-client)\n\n[6\\. Using GraphQL to retrieve data from Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-6-graphql-retrieving-data-from-master-data)\n\n[7\\. Using GraphiQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-7-using-graphiql)\n\n[Services - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-conclusion)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-clients)\n\nHandling events\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/service-path-patterns)\n\n[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/configuring-dynamic-routes-in-vtex-io-services)\n\n[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-developing-service-configuration-apps)\n\n[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/node-builder-7x-migration-guide)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-service)\n\n[Developing services on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/developing-services-on-vtex-io)\n\n[1\\. Getting started with the boilerplate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-1-getting-started-with-the-boilerplate)\n\n[2\\. Handling and receiving events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-2-handling-and-receiving-events)\n\n[3\\. Using the Analytics client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client)\n\n[4\\. Using events as triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-4-using-events-as-triggers)\n\n[5\\. Using the Master Data client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-5-using-the-master-data-client)\n\n[6\\. Using GraphQL to retrieve data from Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-6-graphql-retrieving-data-from-master-data)\n\n[7\\. Using GraphiQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-7-using-graphiql)\n\n[Services - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-conclusion)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-clients)\n\nHandling events\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/service-path-patterns)\n\n[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/configuring-dynamic-routes-in-vtex-io-services)\n\n[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-developing-service-configuration-apps)\n\n[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/node-builder-7x-migration-guide)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/app-development)\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-service)\n\n[Developing services on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/developing-services-on-vtex-io)\n\n[3\\. Using the Analytics client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client)\n\n3\\. Using the Analytics client\n\nNow that we have successfully set up event listening, our next objective is to gain insights into the live number of views for each product page in our store whenever an event is triggered.\n\nTo achieve this, we will implement a [custom client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-how-to-create-and-use-clients) with analytics capabilities. This client will be responsible for retrieving information about a product's number of views from mocked data.\n\nIn VTEX IO, a [client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients) is responsible for establishing connections with external APIs and other VTEX services. The Analytics client, which will be developed in this step, will execute a REST request, fetching valuable information about product views.\n\n## Developing a custom client\n\nNavigate to the `service-course-template/node/clients/analytics.ts` file. This is where the Analytics client will be implemented. Observe that the `Analytics` client extends the `AppClient` class from the `@vtex/api` package, ensuring secure communication configurations within your app.\n\n### Defining a constructor\n\nThe client includes a constructor, a special method invoked when an object is instantiated from a class. Its primary purpose is to initialize the object's properties and perform any necessary setup, ensuring that the Analytics client can interact effectively with other parts of the app and the `vtex.mocked-analytics` app.\n\n> The [vtex.mocked-analytics](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/mocked-analytics) app provides mocked live products data via the `/_v/live-products` endpoint.\n\n### Implementing the client's method\n\nProceed to implement the `getLiveUsers` method, responsible for making an HTTP GET request to the `_v/live-products` endpoint. This method returns a promise for fetching an array, with each element of type `LiveUsersProduct` \\- an object containing `slug` (product ID) and `liveUsers` (quantity of users viewing the product).\n\n### Exporting the custom client\n\nExpose the custom client by extending the default `Clients` implementation. Open the `node/clients/index.ts` file, import the analytics client, and update the `Clients` class as highlighted.\n\n## Using the custom client\n\n### Defining the handler function\n\nWith our new analytics client, let's update its handler function to display the output of the analytics client's `getLiveUsers` method. Go to the `node/handlers/analytics.ts` file and replace the content of `ctx.body` with the method developed in the previous steps (`ctx.analytics.getLiveUsers()`).\n\n### Defining the service route\n\nGo to the `node/service.json` file, and define a public route named `analytics` with the path `/_v/app/analytics/realTime`.\n\n### Relating a route to a handler\n\nUpdate the `node/index.ts` file to relate a route to a handler. Note that the `routes` section associates the `analytics` route with the `analytics` handler function. The `GET` method is associated with the `analytics` handler.\n\nTherefore, when a GET request is made to the `analytics` route previously defined, it triggers the `analytics` handler function, which, in turn, executes the `getLiveUsers()` method of the Analytics client, providing real-time insights into product views.\n\n## Linking the app\n\nTo test the Analytics client, link your app using `vtex link`. Then, use [Postman](https://read.calvincode.net/reader?url=https://www.postman.com/) or `curl` to send a `GET` request to the designated route, replacing `{workspace}` with your workspace name and `{accountName}` with your VTEX account name.\n\nThe request should return status `200 OK` and data in the same format as the example in the right.\n\nservice-course-template/node/clients/analytics.ts\n\n`1\n\nimport { AppClient, InstanceOptions, IOContext } from '@vtex/api' \n\n2\n\n \n3\n\nexport default class Analytics extends AppClient { \n\n4\n\n constructor(context: IOContext, options?: InstanceOptions) { \n\n5\n\n super('vtex.mocked-analytics@0.x', context, options) \n\n6\n\n } \n\n7\n\n \n8\n\n public getLiveUsers(): Promise<LiveUsersProduct[]> { \n\n9\n\n return this.http.get('_v/live-products') \n\n10\n\n } \n\n11\n\n} \n\n12\n\n \n13\n\ninterface LiveUsersProduct { \n\n14\n\n slug: string \n\n15\n\n liveUsers: number \n\n16\n\n} \n\n`\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/services/services-3-using-the-analytics-client.mdx)\n\n[2\\. Handling and receiving events« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client//docs/guides/services-2-handling-and-receiving-events)[4\\. Using events as triggersNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client//docs/guides/services-4-using-events-as-triggers)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Developing a custom client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23developing-a-custom-client)\n\n[Defining a constructor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23defining-a-constructor)[Implementing the client's method](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23implementing-the-clients-method)[Exporting the custom client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23exporting-the-custom-client)\n\n[Using the custom client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23using-the-custom-client)\n\n[Defining the handler function](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23defining-the-handler-function)[Defining the service route](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23defining-the-service-route)[Relating a route to a handler](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23relating-a-route-to-a-handler)\n\n[Linking the app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23linking-the-app)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/services/services-3-using-the-analytics-client.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Developing a custom client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23developing-a-custom-client)\n\n[Defining a constructor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23defining-a-constructor)[Implementing the client's method](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23implementing-the-clients-method)[Exporting the custom client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23exporting-the-custom-client)\n\n[Using the custom client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23using-the-custom-client)\n\n[Defining the handler function](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23defining-the-handler-function)[Defining the service route](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23defining-the-service-route)[Relating a route to a handler](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23relating-a-route-to-a-handler)\n\n[Linking the app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23linking-the-app)\n\nOn this page\n\n[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=)"
}
] |
doc_e0f0eaea
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX store components autocompleteresults app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/troubleshooting)\n\n[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.store-components/autocompleteresults/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/store-components)\n\n[Autocomplete Result List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/autocompleteresults)\n\n[Availability Subscriber](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/availabilitysubscriber)\n\n[Back To Top Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/backtotopbutton)\n\n[Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/image)\n\n[Info Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/infocard)\n\n[Logo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/logo)\n\n[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/notification)\n\n[Product Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/productbrand)\n\n[Product Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/productdescription)\n\n[Product Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/productimages)\n\n[Product Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/productname)\n\n[Product SKU Attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/productskuattributes)\n\n[Search Bar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/searchbar)\n\n[Share](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/share)\n\n[Shipping Simulator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/shippingsimulator)\n\n[SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/skuselector)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/store-components)\n\n[Autocomplete Result List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/autocompleteresults)\n\n[Availability Subscriber](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/availabilitysubscriber)\n\n[Back To Top Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/backtotopbutton)\n\n[Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/image)\n\n[Info Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/infocard)\n\n[Logo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/logo)\n\n[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/notification)\n\n[Product Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/productbrand)\n\n[Product Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/productdescription)\n\n[Product Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/productimages)\n\n[Product Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/productname)\n\n[Product SKU Attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/productskuattributes)\n\n[Search Bar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/searchbar)\n\n[Share](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/share)\n\n[Shipping Simulator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/shippingsimulator)\n\n[SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/skuselector)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/vtex-io-apps)\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/store-components)\n\nAutocomplete Result List\n\n[vtex.store-components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components)\n\nVersion: 3.178.5\n\nLatest version: 3.178.5\n\nThe `autocomplete-result-list` component displays the autocomplete functionality in the search bar. This component serves mainly to ease the creation of custom autocomplete components for search engines.\n\n\n\n## Configuration\n\n1. Import the `vtex.store-components` app to your theme's dependencies in the `manifest.json` file as in the following example:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.store-components\": \"3.x\" \n\n3\n\n } \n\n`\n\n1. Add the `autocomplete-result-list` block into the `search-bar` component. For example:\n\n`1\n\n \"search-bar\": { \n\n2\n\n \"blocks\": [ \n\n3\n\n+ \"autocomplete-result-list\" \n\n4\n\n ] \n\n5\n\n } \n\n`\n\n1. Then, declare the `autocomplete-result-list` block using the props stated in the [Props](#props) table.\n\n### Props\n\n> Info\n> \n> The `autocomplete-result-list` block is commonly used with [Downshift](https://read.calvincode.net/reader?url=https://github.com/downshift-js/downshift). Hence, some of its props are directly related to it.\n\n| Prop name | Type | Description | Default value |\n| ---------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |\n| attemptPageTypeSearch | Boolean | Uses the input term to try to navigate to the proper page type (e.g. a department, a brand, a category) if true. | \\- |\n| classes | CustomCSSClasses | Overrides default CSS handles. To better understand how this prop works, check [this document](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/css-handles%23usecustomclasses). Note that this is only helpful if you're using this block as a React component. | undefined |\n| closeMenu (Downshift) | Function | Closes the menu. | \\- |\n| customSearchPageUrl | String | Template for a custom URL. It accepts a substring ${term} as placeholder to interpolate the searched term (e.g., /search?query=${term}). | \\- |\n| data | Object | Graphql data response. | {} |\n| highlightedIndex (Downshift) | Number | The index that should be highlighted. | \\- |\n| getItemProps (Downshift) | Function | Returns the props for every menu item element being rendered. | \\- |\n| getMenuProps (Downshift) | Function | Returns the props for the ul or root element of your menu. | \\- |\n| inputValue | String | Search query. | \\- |\n| onClearInput | Function | Clears the input. | \\- |\n| isOpen | Boolean | Identifies if the autocomplete should be opened. | \\- |\n\n## Customization\n\nTo apply CSS customizations in this and other blocks, follow the [Using CSS handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization) guide.\n\n| CSS Handles |\n| --------------------- |\n| resultsItem |\n| resultsItemImage |\n| resultsItemName |\n| resultsList |\n| searchTerm |\n| spinnerContainer |\n| spinnerInnerContainer |\n\n[Store Components« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/store-components)[Availability SubscriberNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/availabilitysubscriber)\n\nSee also\n\n[Vtex.store ComponentsVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/autocompleteresults%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/autocompleteresults%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/autocompleteresults%23customization)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_5456eace
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Explain the VTEX api reference card token vault api API and how to use it."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/card-token-vault-api/)\n\nCard tokens operations\n\nCard tokens import\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/card-token-vault-api/)\n\nCard tokens operations\n\nCard tokens import\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[PuUpdate specific website comunication protocol« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/legacy-cms-portal-api%23put-/api/catalog%5Fsystem/pvt/virtualfolder/site/-websiteId-/changeurischema/-protocol-)[PoCreate card tokenNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/card-token-vault-api/docs/api-reference/card-token-vault-api%23post-/api/card-token-vault/tokens)\n\n[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=)"
}
] |
doc_1487ba81
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation publishing an app in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[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-publishing-an-app/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/api-reference)\n\n[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-publishing-an-app/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/storefront-development)\n\n[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-publishing-an-app/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/troubleshooting)\n\n[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-publishing-an-app/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n[Releasing a new app version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-releasing-a-new-app-version)\n\n[Publishing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-publishing-an-app)\n\n[Deploying the app's stable version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-deploying-the-app-stable-version)\n\n[Promoting a workspace to Master](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n[Releasing a new app version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-releasing-a-new-app-version)\n\n[Publishing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-publishing-an-app)\n\n[Deploying the app's stable version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-deploying-the-app-stable-version)\n\n[Promoting a workspace to Master](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/app-development)\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n[Publishing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-publishing-an-app)\n\nPublishing an app\n\nAfter [releasing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-releasing-a-new-app-version) an app version, you must publish your app so that you can install it in certain accounts to perform A/B tests and validate your changes. In other words, you must turn your app into a **candidate version**.\n\nA candidate version of an app is a build distributed internally for **testing purposes only**. It's intended to check, before deployment, whether any critical problems have gone undetected earlier during development. Ideally, there shouldn't be many differences between your app's last candidate version and its final build.\n\n## Before you begin\n\nBefore proceeding any further, make sure the app you are about to publish has already been [released](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-releasing-a-new-app-version).\n\nNotice that publishing an app is one of the steps to **making your new app version publicly available**. Please refer to [this](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available) guide for more information.\n\n## Instructions\n\n### Step 1 - Publishing a candidate version\n\nUntil now, your app version exists only in a local environment. To make it possible to install it in specific accounts and run tests, you must first turn it into a candidate version.\n\n1. Open the terminal and log in to the account responsible for the app development, i.e., the account specified as the app's `vendor` in the [Manifest](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-manifest) file.\n2. Change to your app's root folder.\n3. Publish your app by running the following command:\n\n`1\n\nvtex publish \n\n`\n\n### Step 2 - Validating the candidate version\n\nBefore deploying your candidate version, you must install it in a new Production workspace and perform tests to check your app's behavior. Notice that production workspaces are ready to receive traffic and be accessed by other users.\n\n1. Change to a new [Production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace):\n* _Remember to replace the values between the curly brackets according to your scenario._\n\n`1\n\nvtex use {workspaceName} --production \n\n`\n\n1. Install the candidate version by indicating the new app's exact version:\n* _Remember to replace the values between the curly brackets according to your scenario._\n\n`1\n\nvtex install {appvendor}.{appname}@{appversion} \n\n`\n\n1. Start an A/B test to test your candidate version. Please refer to [this](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing) guide for more information.\n\nFrom this point onwards, you won't be able to link apps or make any code changes in your app's current version. Hence, if you need to make any modifications to your app, you will need to retreat and work on it in a development workspace.\n\n> If you are developing a new Store Theme major, follow the steps in the [Migrating CMS settings after a theme major update](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update) guide before proceeding any further. Otherwise, you may lose page templates set up via the Admin.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/vtex-io-documentation-making-your-new-app-version-publicly-available/vtex-io-documentation-publishing-an-app.md)\n\n[Releasing a new app version« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app//docs/guides/vtex-io-documentation-releasing-a-new-app-version)[Deploying the app's stable versionNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app//docs/guides/vtex-io-documentation-deploying-the-app-stable-version)\n\nSee also\n\n[Deploying the app's stable versionApp Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-deploying-the-app-stable-version)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-publishing-an-app%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-publishing-an-app%23instructions)\n\n[Step 1 - Publishing a candidate version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-publishing-an-app%23step-1-publishing-a-candidate-version)[Step 2 - Validating the candidate version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-publishing-an-app%23step-2-validating-the-candidate-version)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/vtex-io-documentation-making-your-new-app-version-publicly-available/vtex-io-documentation-publishing-an-app.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-publishing-an-app%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-publishing-an-app%23instructions)\n\n[Step 1 - Publishing a candidate version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-publishing-an-app%23step-1-publishing-a-candidate-version)[Step 2 - Validating the candidate version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/docs/guides/vtex-io-documentation-publishing-an-app%23step-2-validating-the-candidate-version)\n\nOn this page\n\n[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=)"
}
] |
doc_4b20c7cd
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides checking which user is currently authenticated in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/api-usage)\n\n[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/getting-started-list-of-rest-apis)\n\n[Making your first request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/making-your-first-request)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/authentication)\n\n[API authentication using API keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/api-authentication-using-api-keys)\n\n[Rotating VTEX API tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/rotating-vtex-api-tokens)\n\n[App authentication using auth tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/app-authentication-using-auth-tokens)\n\n[API authentication using user tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/api-authentication-using-user-tokens)\n\n[Checking which user is currently authenticated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/checking-which-user-is-currently-authenticated)\n\n[Expiring a shopper's password](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/expiring-a-shoppers-password)\n\n[Refresh token flow for headless implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/refresh-token-flow-for-headless-implementations)\n\n[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/api-response-codes)\n\nError handling and best practices\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/api-usage)\n\n[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/getting-started-list-of-rest-apis)\n\n[Making your first request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/making-your-first-request)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/authentication)\n\n[API authentication using API keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/api-authentication-using-api-keys)\n\n[Rotating VTEX API tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/rotating-vtex-api-tokens)\n\n[App authentication using auth tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/app-authentication-using-auth-tokens)\n\n[API authentication using user tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/api-authentication-using-user-tokens)\n\n[Checking which user is currently authenticated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/checking-which-user-is-currently-authenticated)\n\n[Expiring a shopper's password](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/expiring-a-shoppers-password)\n\n[Refresh token flow for headless implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/refresh-token-flow-for-headless-implementations)\n\n[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/api-response-codes)\n\nError handling and best practices\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides)\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/api-usage)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/authentication)\n\n[Checking which user is currently authenticated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/checking-which-user-is-currently-authenticated)\n\nChecking authenticated users via authorization cookies\n\nLearn how to check which user is currently authenticated in your store using their authentication token and VTEX APIs.\n\nIn this guide, you will learn how to verify if a user is currently authenticated in your store using their authentication token stored in cookies. Additionally, you will learn how to retrieve identifying information, such as their user ID and email, using VTEX's API.\n\n## Authentication cookies overview\n\nWhen a user logs into your store, cookies are created to store the authorization token. From that point onward, these cookies are automatically included in all requests to VTEX servers, enabling the system to identify the user performing the action.\n\nIn situations other than API requests to VTEX, you may need to check whether the user is logged in or retrieve identifying information, such as their email or user ID. These actions can also be accomplished using the authentication cookies.\n\n> Note that these cookies have the `HTTP Only` and `Secure` options enabled. This means they cannot be accessed via JavaScript and will only be sent over secure HTTPS requests.\n\n## Instructions\n\n### Sending the request to verify user authentication\n\nTo check the authenticated user, send a request to the indicated API endpoint, replacing `VtexIdclientAutCookie` with the user's authorization token.\n\n### Analyzing the API response\n\n#### Authenticated user\n\nIf the user is authenticated, the API will return a JSON object with the following structure:\n\n* `userId`: The unique user ID within VTEX services.\n* `user`: The user's email address.\n* `userType`: Internal VTEX user type identifier (for VTEX use only).\n\n#### Non-authenticated user\n\nIf the user is not authenticated, the response body will be empty (`null`), and the HTTP status will be either `200 (OK)` or `401 (Unauthorized)`.\n\nRequest\n\n`1\n\nGET \n\n2\n\nhttps://{accountName}.{environment}.com.br/api/vtexid/pub/authenticated/user?authToken={VtexIdclientAutCookie} \n\n`\n\n200-Response\n\n`1\n\n{ \n\n2\n\n \"userId\": \"88888888-8888-8888-8888-888888888888\", \n\n3\n\n \"user\": \"user@mail.com\", \n\n4\n\n \"userType\": \"F\" \n\n5\n\n} \n\n`\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/PedroAntunesCosta)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Getting-Started/authentication/checking-which-user-is-currently-authenticated.md)\n\n[API authentication using user tokens« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated//docs/guides/api-authentication-using-user-tokens)[Expiring a shopper's passwordNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated//docs/guides/expiring-a-shoppers-password)\n\nSee also\n\n[API authentication using user tokensGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/api-authentication-using-user-tokens)\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/PedroAntunesCosta)\n\nON THIS PAGE\n\n[Authentication cookies overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/checking-which-user-is-currently-authenticated%23authentication-cookies-overview)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/checking-which-user-is-currently-authenticated%23instructions)\n\n[Sending the request to verify user authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/checking-which-user-is-currently-authenticated%23sending-the-request-to-verify-user-authentication)[Analyzing the API response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/checking-which-user-is-currently-authenticated%23analyzing-the-api-response)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Getting-Started/authentication/checking-which-user-is-currently-authenticated.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Authentication cookies overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/checking-which-user-is-currently-authenticated%23authentication-cookies-overview)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/checking-which-user-is-currently-authenticated%23instructions)\n\n[Sending the request to verify user authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/checking-which-user-is-currently-authenticated%23sending-the-request-to-verify-user-authentication)[Analyzing the API response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-which-user-is-currently-authenticated/docs/guides/checking-which-user-is-currently-authenticated%23analyzing-the-api-response)\n\nOn this page\n\n[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=)"
}
] |
doc_6f8adeb5
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides managing application logs in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n[Managing application logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-documentation-managing-application-logs)\n\n[Running IO scripts in non-IO VTEX stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores)\n\n[Creating an interface for your app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings)\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n[Managing application logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-documentation-managing-application-logs)\n\n[Running IO scripts in non-IO VTEX stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores)\n\n[Creating an interface for your app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings)\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/app-development)\n\nDevelopment guides\n\n[Managing application logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-documentation-managing-application-logs)\n\nManaging application logs\n\nVTEX IO provides a logging service that allows developers to keep track of app errors, warnings, and informative events. The VTEX IO Logging Service collects data from the cloud infrastructure where VTEX applications run and delivers them via the VTEX IO CLI.\n\nIn the following section, you'll learn how to implement the VTEX IO Logging Service in your apps and how to retrieve their respective logs.\n\n> The VTEX IO Logging Service is currently available for Node apps only.\n\n---\n\n## Before you begin\n\nTo follow this guide, you must have the VTEX IO CLI installed on your machine. For more information, please see [this document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install).\n\n---\n\n## Instructions\n\n### Implementing the VTEX IO Logging Service\n\n1. Open your Node app in the code editor of your choice.\n2. Define an object with the `Context` interface as a parameter in a function where you want to provide logging messages. See the following example:\n\n`1\n\nconst helloWorld = (ctx: Context) => { \n\n2\n\n const { vtex: { logger } } = ctx \n\n3\n\n \n4\n\n logger.info('Hello World!') \n\n5\n\n} \n\n`\n\nIn this example, the `helloWorld` function receives an object with a [**Context**](https://read.calvincode.net/reader?url=https://github.com/vtex/node-vtex-api/blob/master/src/service/worker/runtime/typings.ts%23L34) interface as a parameter.\n\n> The `Context` interface contains many implementations inherent to the VTEX IO platform. One of those implementations is called `vtex` — an object containing all [VTEX IO infrastructure](https://read.calvincode.net/reader?url=https://github.com/vtex/node-vtex-api/blob/master/src/service/worker/runtime/typings.ts%23L116) related metadata, such as `account`, `workspace`, `tenant`, `settings`, and some service implementations. In the previous example, we used the `logger` service, an implementation inside `vtex` that generates log messages.\n\n1. [Destructure](https://read.calvincode.net/reader?url=https://www.typescriptlang.org/docs/handbook/variable-declarations.html%23destructuring) the `logger` object from the `vtex` context and use its methods (`error`, `warn`, `info`, and `debug`) to provide error, warning, debugging, or informative messages in the log. See the following example:\n\n`1\n\nconst helloWorld = (ctx: Context) => { \n\n2\n\n const { vtex: { logger } } = ctx \n\n3\n\n \n4\n\n logger.warn('Warning the world!') \n\n5\n\n \n6\n\n logger.error('Error!!!') \n\n7\n\n \n8\n\n logger.debug('Verbose debug message!') \n\n9\n\n} \n\n`\n\n> Every exception that happens in a VTEX IO service app is intercepted and automatically logged with a `logger.error` implementation.\n\n### Retrieving app logs\n\nEvery log written by a running app with the VTEX IO Logging Service is collected and stored for later retrieval.\n\nYou can retrieve the logs using the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference) by following the steps:\n\n1. Log in to your VTEX account.\n2. Install the Logs plugin for the VTEX IO CLI by running the following command:\n\n`1\n\nvtex plugins add logs \n\n`\n\n1. Check if the installation of the Logs plugin was successful by running `vtex logs --help`.\n2. Retrieve logs from all apps installed in your account by running the following command:\n\n`1\n\nvtex logs --all \n\n`\n\nThe output should be a message similar to the following:\n\n`1\n\nvtex logs --all \n\n2\n\n18:15:26.779 - info: Connecting to logs stream for store components \n\n3\n\n18:15:26.782 - info: Press CTRL+C to abort \n\n4\n\n \n5\n\n18:15:43.856 - info: Listening to store components logs \n\n6\n\n \n7\n\n info: { status: 403, \n\n8\n\n code: 'FORBIDDEN', \n\n9\n\n name: 'ForbiddenError', \n\n10\n\n level: 'error', \n\n11\n\n message: 'This username is already registered with another email', \n\n12\n\n stack: \n\n13\n\n 'ForbiddenError: This username is already registered with another email[ErrorStack...] \n\n14\n\n routeId: 'login' } \n\n`\n\n> You can also retrieve logs from a specific app installed in your account by running the following command: `vtex logs {serviceAppExample}`. Replace `serviceAppExample` with the desired app name.\n\nWe suggest running `vtex logs --all > {mylogfile.logs}` to save the log messages in a local file. Replace `{mylogfile.logs}` with a name that fits your environment.\n\nIf you want to see log messages that you have previously retrieved, run `vtex logs --past`.\n\n## Log storage and retention limits\n\nVTEX limits the storage size and retention period of logs to guarantee the stability and performance of the platform. The limits are:\n\n* Logs are stored for 7 days at most.\n* Each app can have up to 1 GB of logs stored per account. If an app generates more than 1 GB of logs in one account in 7 days or less, the oldest logs are deleted.\n\nIf you need more than 1 GB of logs per week for an app, we recommend retrieving and storing your logs before they reach the storage limit. You can check the size of the logs from the size of the retrieved files in your local environment. See the instructions in the [Retrieving app logs](#retrieving-app-logs) section.\n\n> VTEX may change the storage limits of app logs without additional notice. Check this documentation for the updated limit values.\n\nContributors\n\n2\n\n[](https://github.com/henriquessb)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/configuring-workspaces/vtex-io-documentation-managing-application-logs.md)\n\n[Deprecating an app« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs//docs/guides/vtex-io-documentation-deprecating-an-app)[Running IO scripts in non-IO VTEX storesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs//docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores)\n\nContributors\n\n2\n\n[](https://github.com/henriquessb)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-documentation-managing-application-logs%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-documentation-managing-application-logs%23instructions)\n\n[Implementing the VTEX IO Logging Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-documentation-managing-application-logs%23implementing-the-vtex-io-logging-service)[Retrieving app logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-documentation-managing-application-logs%23retrieving-app-logs)\n\n[Log storage and retention limits](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-documentation-managing-application-logs%23log-storage-and-retention-limits)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/configuring-workspaces/vtex-io-documentation-managing-application-logs.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-documentation-managing-application-logs%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-documentation-managing-application-logs%23instructions)\n\n[Implementing the VTEX IO Logging Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-documentation-managing-application-logs%23implementing-the-vtex-io-logging-service)[Retrieving app logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-documentation-managing-application-logs%23retrieving-app-logs)\n\n[Log storage and retention limits](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs/docs/guides/vtex-io-documentation-managing-application-logs%23log-storage-and-retention-limits)\n\nOn this page\n\n[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=)"
}
] |
doc_fbcb3384
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX google tag manager app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/troubleshooting)\n\n[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.google-tag-manager/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/vtex-io-apps)\n\nGoogle Tag Manager\n\nOfficial extension\n\nVersion: 3.5.4\n\nLatest version: 3.5.4\n\n[](#contributors-)\n\nThe VTEX Google Tag Manager (GTM) app is a first party integration to the [Google Tag Manager solution](https://read.calvincode.net/reader?url=https://tagmanager.google.com).\n\n\n\n## Installing the Google Tag Manager app\n\n1. Access the **Apps** section in your account's admin page and look for the Google Tag Manager box;\n2. Then, click on the **Install** button;\n3. You'll see a warning message about needing to enter the necessary configurations. Scroll down and type in your **GTM ID** in the `Google Tag Manager` field.\n4. Click on **Save**.\n\n> Access the [Google Tag Manager page](https://read.calvincode.net/reader?url=https://tagmanager.google.com/) and log in to your account in order to find out what is your account **GTM ID**. Use the number provided by the `Container ID` column.\n\n### Step 2 - Creating Google Analytics variables\n\nTo set up Google Tag Manager in your store, you must create and set up all necessary variables, triggers, and tags. Follow the [Setting up Google Tag Manager documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-setting-up-google-tag-manager) to create them.\n\n### Step 3 - Persisting campaign data throughout a user session\n\nTo prevent GTM from creating additional session identifiers every time a user navigates the website, you must add the variables `originalLocation` and `originalReferrer` to your GTM container and configure your store’s Google Analytics tags. Notice that this is important to persist campaign data throughout a user session and avoid providing inconsistent campaign data to Google Analytics (GA).\n\n> The `originalLocation` and `originalReferrer` variables are available for VTEX IO Google Tag Manager versions `2.x` and `3.x`.\n\n#### Creating the variables Original Location and Original Referrer\n\n1. Log in to your [GTM account](https://read.calvincode.net/reader?url=https://tagmanager.google.com) and click on the GTM container you want to work with. \n\n2. On the container page, click on **Variables**.\n3. In the **Built-In Variables** section, check if the `Page URL` and `Page Path` variables are enabled. Otherwise, click on `Configure` and select `Page URL` and `Page Path` to enable them.\n4. Go to the **User-Defined Variables** section and click on `New`. A side popup will open.\n5. Replace the `Untitled Variable` value with `Original Location`.\n6. Click on **Variable Configuration**.\n7. On **Page Variables**, click on **Data Layer Variable**.\n8. In the `Data Layer Variable Name` field, type `originalLocation`.\n9. Enable the `Set Default Value` option and fill in the `Default Value` field with the following value: \n`1 \n{{Page URL}} \n` \n\n10. Click `Save`. Once you have saved the `originalLocation` variable, create the `originalReferrer` as described in the steps below.\n11. In the **User-Defined Variables** section, click on `New`. A side popup will open.\n12. Replace the `Untitled Variable` value with `Original Referrer`.\n13. Click on **Variable Configuration**.\n14. On **Page Variables**, click on **Data Layer Variable**.\n15. In the `Data Layer Variable Name` field, type `originalReferrer`.\n16. Enable the `Set Default Value` option and fill in the `Default Value` field with the following value: \n`1 \n{{Referrer}} \n` \n\n17. Click `Save`.\n\n#### Updating Google Analytics Settings variables and tags\n\nNow, let's configure every Google Analytics Settings variable that fires the `originalLocation` and `originalReferrer` variables.\n\n1. Go to the **Variables** section;\n2. On **User-Defined Variables**, click on the name of one of the Google Analytics Settings variables \n\n3. Click on the **Variable Configuration** box;\n4. Go to **More Settings > Fields to Set**;\n5. Click on `Add Field`;\n6. Set the `Field Name` field as `location` and `Value` as `{{Original Location}}`;\n7. Then, click on `Add Field` again;\n8. Set the `Field Name` field as `referrer` and `Value` as `{{Original Referrer}}`;\n9. Click on `Save`.\n\nIf you have any Google Analytics tags using the Google Analytics Settings variables you have changed, apply the same changes above directly on the tags that need it.\n\n#### Publishing your changes\n\nOnce you have set up the Google Analytics variables and tags, follow Google's official guide on [how to submit and publish your store’s container](https://read.calvincode.net/reader?url=https://support.google.com/tagmanager/answer/6107163).\n\n## Restrictions\n\nIn order to avoid performance problems and unforeseen behavior, our VTEX IO Google Tag Manager solution uses the native GTM **blacklist** feature. You can read more about this feature on the [Google Developer Guide](https://read.calvincode.net/reader?url=https://developers.google.com/tag-manager/web/restrict).\n\nWe, by default, blacklist the `html` ID, which automatically blocklists all the tags, variables, and triggers of the type `customScripts`. The main consequence of this blocklist is that **Custom HTML tags will not be triggered**.\n\n> The HTML blacklist is the VTEX Google Tag Manager app's default. If you want to disable this restriction, go to `https://{accountName}.myvtex.com/admin/apps/vtex.google-tag-manager@2.x/setup` and check the toggle below.\n\n \n\nMost of the widely used Custom HTML tags are integrations with third-party services, like Customer Chat, Analytics, Remarketing, and Pixel tags. If your store needs a Custom HTML for one of those cases, the integration can either be done by transforming the tags into a [VTEX IO Pixel App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pixel-apps) or by removing this restriction.\n\nCheck below the full list of tags and variables that are blocked, by default, in the VTEX IO Google Tag Manager solution.\n\n### Blocked tags\n\n* Custom HTML Tag - `html`\n* Eulerian Analytics Tag - `ela`\n* SaleCycle JavaScript Tag - `scjs`\n* Upsellit Global Footer Tag - `uslt`\n* Upsellit Confirmation Tag - `uspt`\n\n### Blocked variables\n\n* Custom JavaScript Variable - `jsm`\n\nCheck out a list with all the GTM available tags on the [Google Developer Guide](https://read.calvincode.net/reader?url=https://developers.google.com/tag-manager/devguide).\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Installing the Google Tag Manager app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/apps/vtex.google-tag-manager%23installing-the-google-tag-manager-app)\n\n[Step 2 - Creating Google Analytics variables](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/apps/vtex.google-tag-manager%23step-2-creating-google-analytics-variables)[Step 3 - Persisting campaign data throughout a user session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/apps/vtex.google-tag-manager%23step-3-persisting-campaign-data-throughout-a-user-session)\n\n[Restrictions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/apps/vtex.google-tag-manager%23restrictions)\n\n[Blocked tags](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/apps/vtex.google-tag-manager%23blocked-tags)[Blocked variables](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager/docs/apps/vtex.google-tag-manager%23blocked-variables)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_4553c303
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore headless cms multiple page template in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/headless-cms-overview)\n\n[Managing content with 'scopes' and 'requiredScopes'](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes)\n\n[Multiple page templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/headless-cms-multiple-page-template)\n\n[Previewing Headless CMS in development mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode)\n\n[Widgets for Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/headless-cms-widgets)\n\n[Customizing pages with Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/dynamic-content-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/headless-cms-overview)\n\n[Managing content with 'scopes' and 'requiredScopes'](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes)\n\n[Multiple page templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/headless-cms-multiple-page-template)\n\n[Previewing Headless CMS in development mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode)\n\n[Widgets for Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/headless-cms-widgets)\n\n[Customizing pages with Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/dynamic-content-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/headless-cms-overview)\n\nMultiple page templates\n\nMultiple page templates allow the creation of flexible layouts for Product Details and Product Listing Pages (PDPs and PLPs) in Headless CMS. This feature allows you to create and manage pages hierarchically, leveraging product information, user context, product type, brand specifications, and template hierarchy.\n\nThis document outlines the implementation details, usage instructions, and template hierarchy logic for integrating the templates into your FastStore project.\n\n## Before you begin\n\nTo use this feature, update your FastStore project to `v3.0.17` or higher. To do this, follow these steps:\n\n1. Open your project in a code editor.\n2. Open a terminal and run the following command to update the FastStore packages to the latest version:\n\n`1\n\nyarn upgrade -L --scope @faststore \n\n`\n\n1. Run `yarn dev` to apply the changes to your project.\n\n## Creating a multiple page template\n\nTo add multiple templates to your FastStore project, follow the steps below:\n\n1. Go to the VTEX Admin and navigate to **Storefront > Headless CMS**.\n2. Select your FastStore project.\n3. Click `Create Document` and choose between `Product Page` and `Product List Page`.\n4. Now that you have created the template, check the \\[Template hierarchy logic\\] section to learn how to use and edit the template.\n\n> To learn how to edit the name, publish, duplicate, or delete the template, see the [Managing pages in the Headless CMS](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/managing-pages--3DO6rBhZ1p3zndnFu5BgRt) guide.\n\n## Template hierarchy logic\n\nBoth PDPs and PLPs use a similar logic for selecting the appropriate template to render. This logic prioritizes templates based on various criteria, starting with the most specific and moving to more generic templates, like department or generic PDP/PLP.\n\nHere's the difference between Product Details and Product Listing Page template hierarchy:\n\n| Feature | PDP hierarchy logic | PLP hierarchy logic |\n| ------------------------------- | -------------------------------------------------------------- | ---------------------------------------------------------- |\n| Matching Criteria | Slug, Subcategory, Category, Department, Generic. | Slug (subcategory, category, department implied), Generic. |\n| Reliance on Product Information | Considers product details (subcategory, category, department). | Ignores product details beyond the slug. |\n\n### PDP template selection criteria\n\nThe template selection process follows a specific hierarchy, starting with the most specific template and progressing towards a generic one if no exact match is found.\n\nFastStore checks for templates in the following order:\n\nStart\n\nSKU Template exists?\n\nYes\n\nUse SKU Template\n\nNo\n\nProduct Slug match?\n\nYes\n\nUse matching template\n\nNo\n\nProduct Subcategory match?\n\nYes\n\nUse matching template\n\nNo\n\nProduct Category match?\n\nYes\n\nUse matching template\n\nNo\n\nProduct Department match?\n\nYes\n\nUse matching template\n\nNo\n\nUse generic template\n\nThe system first searches for a template named after the product slug. For example, if the product slug is `/blue-shirts/p`, FastStore will look for a template named `/blue-shirts/p`.\n\n1. If an SKU template is available, it takes precedence over the product template. For example, if a template is available for slugs containing the SKU ID (e.g., `/blue-shirts-99988212/p`), this template will take precedence over a more generic product template for `/blue-shirts/p`.\n2. If no SKU template is available, the system searches for one template based on the product slug.\n3. If no template matches the slug, FastStore searches for a template based on the product subcategory. For example, if the subcategory is `summer clothing`, the system might look for `/clothing/shirts/summer-clothing/`.\n4. Following the subcategory, the system checks for a template matching the product category. For example, if the category is `shirts`, the system might look for `/clothing/shirts/`.\n5. If no match is found at the category level, FastStore searches for a template based on the product department. For example, if the department is `clothing`, the system might look for `/clothing/`.\n6. If none of the above criteria match, the generic Product Page template is used. This template has an empty Template section value in the settings.\n\n\n\n### PLP template selection criteria\n\nPLP templates are selected in FastStore based on URL slug matching.\n\nThe PLP template selection process follows this order:\n\n1. FastStore system first checks for a template that matches the exact requested slug, such as `/office/chairs`. If a match is found, this template is used.\n2. If no exact slug match exists, the system checks for a template matching the main department template slug (e.g., `/office` applies to `/office/chairs`). If a department template is found, it applies to all subcategory under that department by default. (e.g., `/office/chairs`, `/office/desks`).\n3. If no department or category template matches, the generic PLP template with an empty template value in Headless CMS is applied.\n4. If no template is found at any of these levels, the system uses the first available PLP template.\n\nFor example, you define the following in Headless CMS:\n\nIf there is a category named `computers` in your catalog, and two subcategory under `computers` named `tools` and `accessories`:\n\n* Template value `/computers`: applies to both `/computers` and any slug under it unless overridden (e.g., `/computers/tools`).\n* Template value `/computers/accessories`: applies only to `/computers/accessories`.\n* Template value left empty: default template used if neither previous options match.\n\nResulting behavior:\n\n* Visiting `/computers` uses the department template.\n* Visiting `/computers/accessories` uses the category template.\n* Visiting `/computers/laptop` (with no template defined for it) inherits the `/computers` template.\n* Any slug not matched by the above uses the generic PLP template.\n\nThe table below summarizes the template selection logic:\n\n| URL slug | Template Defined For | Applied Template |\n| ---------------------- | ---------------------- | ------------------------------------------------------- |\n| /computers | /computers | Department template (exact match). |\n| /computers/laptops | None | Inherits /computers (falls back to department). |\n| /computers/accessories | /computers/accessories | Category template (overrides main department template). |\n| /unknown-slug | None | Default template (no matches, uses fallback). |\n\n#### Using Rewrites with PLP template\n\nFastStore allows you to create custom routes using [Next.js rewrites](https://read.calvincode.net/reader?url=https://nextjs.org/docs/app/api-reference/next-config-js/rewrites). It is possible to enable the multiple page template feature for the custom route as well by adding your rewrites function into the `discovery.config.js` file as suggested in the [Next.js documentation](https://read.calvincode.net/reader?url=https://nextjs.org/docs/app/api-reference/next-config-js/rewrites):\n\n1. Add your rewrite function to discovery.config.js:\n\n`` 1\n\nasync rewrites() { \n\n2\n\n return [ \n\n3\n\n { \n\n4\n\n source: '/my-office', \n\n5\n\n destination: `/office`, \n\n6\n\n }, \n\n7\n\n ] \n\n8\n\n}, \n\n ``\n\nThis rewrites the URL `/my-office` to the existing route `/office`, effectively using the `/office` template without modifying the displayed URL. This allows you to map the template in the Headless CMS to the `/office` route.\n\n1. Alternatively, use the extended format:\n\n`` 1\n\nasync rewrites() { \n\n2\n\n return { \n\n3\n\n beforeFiles: [ \n\n4\n\n { \n\n5\n\n source: '/my-office', \n\n6\n\n destination: `/office`, \n\n7\n\n }, \n\n8\n\n ], \n\n9\n\n afterFiles: [], \n\n10\n\n fallback: [], \n\n11\n\n } \n\n12\n\n}, \n\n ``\n\nThis format offers more flexibility for advanced rewrite scenarios.\n\nFrom version `3.0.61` of the `@faststore/core` package, it's also possible to use the `source` route in the Headless CMS to map the template. To update your store's `@faststore/core` package to the `3.0.61`, run the following command:\n\n`1\n\nyarn add @faststore/core@3.0.61 \n\n`\n\n### Key difference between PDP and PLP template selection criteria\n\nTo sum up, here's the difference between the two template hierarchies:\n\n| Feature | PDP Hierarchy logic | PLP Hierarchy logic |\n| ------------------------------- | -------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |\n| Matching Criteria | Slug, Subcategory, Category, Department, Generic. | Slug, fallback to main department, generic/default, fallback to first available PLP template. |\n| Reliance on Product Information | Considers product details (subcategory, category, department). | Ignores product details and uses URL slug only. |\n\n## Examples of template selection\n\nThe following examples illustrate different scenarios for selecting PDP and PLP templates.\n\n### PDP template selection example\n\nFor this example, we will explore three template scenarios to render in Headless CMS for the Apple Magic Mouse product:\n\n* [Slug](#slug-template): Matches the product slug, e.g., `/apple-magic-mouse/p`. It offers the highest level of specificity.\n* [Department](#department-template): Applies to products within a specific department category, such as `/technology/`, if no slug template is defined.\n* [Generic PDP Template](#generic-pdp-template): Fallback template used if no other specific template matches.\n\n#### Slug template\n\nWhen using PDPs, this type of page template is recognized by the slug pattern. In the example, we will use the [Apple Magic Mouse product page](https://read.calvincode.net/reader?url=https://starter.vtex.app/apple-magic-mouse/p), which has the slug `/apple-magic-mouse/p`.\n\n\n\nAdding the slug to this template makes it specific, prompting FastStore to prioritize it for rendering on the product page.\n\n#### Department template\n\nProducts in [catalog](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/catalog-overview--77M8ItLhDXs6aBdQTqToVe) fall under a [category tree](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-a-category--6HV4Q3E2FauUoOQoiCCgCg), typically `/department/category/subcategory/`. For example, the product we’ve been using is in the `Technology department`, allowing you to create a department-specific template.\n\n\n\nIf this product is under a [subcategory](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-a-subcategory--2cb0aRkG3i6AeiAMM24iwY?%26utm%5Fsource=autocomplete), you can create a corresponding template. The category tree is used in the template input, separated by slashes.\n\n\n\nYou can also see the category hierarchy through the breadcrumb.\n\n\n\n#### Generic PDP template\n\nIf no matches are found for the slug or department, the generic template will be used to render the PDP. In this case, create a Headless CMS document with the `Product Page` option, leaving the **Template** field empty in the **Sections** tab.\n\n\n\n### Product Listing Page (PLP) template selection example\n\nFor PLPs, we will go over the following possible templates:\n\n* [Slug](#slug-template-plp)\n* [Generic PLP](#generic-plp-template).\n\nWhen using PLPs, this type of page template is recognized by the slug pattern. In the example, we will use the [office/chairs slug](https://read.calvincode.net/reader?url=https://starter.vtex.app/office/chairs) to render the PLP template.\n\n#### Slug template (PLP)\n\nProducts in the catalog are organized within a category tree, structured as `/department/category/subcategory`. If a slug template exists for any of these options, it will be rendered accordingly.\n\nFor example, if you want to render a specific template for products inside a [department](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-a-department--22rKjmYWVmmKAK8CWa8yKw?%26utm%5Fsource=autocomplete) without considering the category or subcategory, you can create a Department template [/office](https://read.calvincode.net/reader?url=https://starter.vtex.app/office/chairs).\n\n\n\nIf this product were under a `subcategory`, it would still be possible to create a template representing this scenario. The category tree is used in the template slug input, as in the image below.\n\n\n\n> If a more specific template, such as `/office/chairs`, exists, it will take precedence when the slug matches the same pattern.\n\n#### Generic PLP\n\nIf no matches are found for the slug, the generic template will be used to render the PLP. In this case, create a Headless CMS page with the `Product List Page` option, leaving the Template field empty in the **Sections** tab.\n\n\n\nContributors\n\n3\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/eduardoformiga)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/headless-cms/multiple-page-template.mdx)\n\n[Managing content with 'scopes' and 'requiredScopes'« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes)[Previewing Headless CMS in development modeNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode)\n\nContributors\n\n3\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/eduardoformiga)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/headless-cms-multiple-page-template%23before-you-begin)\n\n[Creating a multiple page template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/headless-cms-multiple-page-template%23creating-a-multiple-page-template)\n\n[Template hierarchy logic](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/headless-cms-multiple-page-template%23template-hierarchy-logic)\n\n[PDP template selection criteria](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/headless-cms-multiple-page-template%23pdp-template-selection-criteria)[PLP template selection criteria](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/headless-cms-multiple-page-template%23plp-template-selection-criteria)[Key difference between PDP and PLP template selection criteria](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/headless-cms-multiple-page-template%23key-difference-between-pdp-and-plp-template-selection-criteria)\n\n[Examples of template selection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/headless-cms-multiple-page-template%23examples-of-template-selection)\n\n[PDP template selection example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/headless-cms-multiple-page-template%23pdp-template-selection-example)[Product Listing Page (PLP) template selection example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/headless-cms-multiple-page-template%23product-listing-page-plp-template-selection-example)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/headless-cms/multiple-page-template.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/headless-cms-multiple-page-template%23before-you-begin)\n\n[Creating a multiple page template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/headless-cms-multiple-page-template%23creating-a-multiple-page-template)\n\n[Template hierarchy logic](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/headless-cms-multiple-page-template%23template-hierarchy-logic)\n\n[PDP template selection criteria](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/headless-cms-multiple-page-template%23pdp-template-selection-criteria)[PLP template selection criteria](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/headless-cms-multiple-page-template%23plp-template-selection-criteria)[Key difference between PDP and PLP template selection criteria](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/headless-cms-multiple-page-template%23key-difference-between-pdp-and-plp-template-selection-criteria)\n\n[Examples of template selection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/headless-cms-multiple-page-template%23examples-of-template-selection)\n\n[PDP template selection example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/headless-cms-multiple-page-template%23pdp-template-selection-example)[Product Listing Page (PLP) template selection example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-multiple-page-template/docs/guides/faststore/headless-cms-multiple-page-template%23product-listing-page-plp-template-selection-example)\n\nOn this page\n\n[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=)"
}
] |
doc_b64713d7
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore organisms image gallery in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-overview)\n\n[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-banner-text)\n\n[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-cart-sidebar)\n\n[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-empty-state)\n\n[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-filter-slider)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-filter)\n\n[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-hero)\n\n[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery)\n\n[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-navbar-slider)\n\n[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-navbar)\n\n[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-newsletter)\n\n[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-out-of-stock)\n\n[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-payment-methods)\n\n[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-price-range)\n\n[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-product-grid)\n\n[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-product-shelf)\n\n[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-region-modal)\n\n[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-search-input)\n\n[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-shipping-simulation)\n\n[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-slide-over)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-overview)\n\n[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-banner-text)\n\n[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-cart-sidebar)\n\n[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-empty-state)\n\n[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-filter-slider)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-filter)\n\n[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-hero)\n\n[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery)\n\n[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-navbar-slider)\n\n[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-navbar)\n\n[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-newsletter)\n\n[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-out-of-stock)\n\n[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-payment-methods)\n\n[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-price-range)\n\n[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-product-grid)\n\n[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-product-shelf)\n\n[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-region-modal)\n\n[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-search-input)\n\n[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-shipping-simulation)\n\n[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-slide-over)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/components-index)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-overview)\n\nImageGallery\n\nUsed when you want to display a series of photos in a gallery on a post or page.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/organisms/ImageGallery)\n\nThe `ImageGallery` is used when you want to display a series of photos in a gallery on a post or page.According to the quantity of `Image` to be displayed, the `ImageGallerySelector` will be displayed.\n\n> Add the `data-fs-image` attribute in all `<img>` tags to ensure they work as expected. You can find an example in the `Code` tab below for reference.\n\nExample\n\nCode\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { \n\n2\n\n ImageGallery, \n\n3\n\n ImageGallerySelector, \n\n4\n\n ImageGalleryViewer, \n\n5\n\n} from \"@faststore/ui\"; \n\n`\n\n### Import styles\n\nTo apply styles, include the following in your stylesheet:\n\n`1\n\n@import \"@faststore/ui/src/components/organisms/ImageGallery/styles.scss\"; \n\n`\n\nFor details, see [Importing FastStore UI component styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles).\n\n---\n\n## Examples\n\n### With Selector (More than 1 Image)\n\nExample\n\nCode\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n### Without Selector\n\nExample\n\nCode\n\n\n\n---\n\n## Design tokens\n\n| Local token | Default value/Global token linked |\n| --------------------------------------- | ------------------------------------------ |\n| \\--fs-image-gallery-width | calc(100% + (2 \\* var(--fs-grid-padding))) |\n| \\--fs-image-gallery-transition-timing | var(--fs-transition-timing) |\n| \\--fs-image-gallery-transition-function | var(--fs-transition-function) |\n| \\--fs-image-gallery-gap-mobile | var(--fs-spacing-2) |\n| \\--fs-image-gallery-gap-notebook | var(--fs-spacing-3) |\n\n### Controls\n\n| Local token | Default value/Global token linked |\n| ------------------------------------------------------- | --------------------------------- |\n| \\--fs-image-gallery-selector-control-bkg-color | var(--fs-control-bkg) |\n| \\--fs-image-gallery-selector-control-border-radius | var(--fs-border-radius-circle) |\n| \\--fs-image-gallery-selector-control-shadow | var(--fs-shadow-darker) |\n| \\--fs-image-gallery-selector-control-gradient-bkg-color | var(--fs-color-body-bkg) |\n\n### Current Selected Image\n\n| Local token | Default value/Global token linked |\n| ----------------------------------------- | --------------------------------- |\n| \\--fs-image-gallery-current-height | 33.125rem |\n| \\--fs-image-gallery-current-border-radius | var(--fs-border-radius) |\n\n### Selector\n\n| Local token | Default value/Global token linked |\n| --------------------------------------- | -------------------------------------- |\n| \\--fs-image-gallery-selector-max-height | var(--fs-image-gallery-current-height) |\n\n#### Selector Elements\n\n| Local token | Default value/Global token linked |\n| ------------------------------------------------------ | ------------------------------------------ |\n| \\--fs-image-gallery-selector-elements-gap | var(--fs-spacing-1) |\n| \\--fs-image-gallery-selector-elements-gap-notebook | var(--fs-spacing-2) |\n| \\--fs-image-gallery-selector-elements-padding-mobile | var(--fs-spacing-0) var(--fs-grid-padding) |\n| \\--fs-image-gallery-selector-elements-padding-notebook | var(--fs-spacing-0) 0 |\n\n#### Selector Thumbnail\n\n| Local token | Default value/Global token linked |\n| ------------------------------------------------------------ | --------------------------------------------------------- |\n| \\--fs-image-gallery-selector-thumbnail-width-mobile | 3.5rem |\n| \\--fs-image-gallery-selector-thumbnail-height-mobile | var(--fs-image-gallery-selector-thumbnail-width-mobile) |\n| \\--fs-image-gallery-selector-thumbnail-width-notebook | 4.5rem |\n| \\--fs-image-gallery-selector-thumbnail-height-notebook | var(--fs-image-gallery-selector-thumbnail-width-notebook) |\n| \\--fs-image-gallery-selector-thumbnail-border-radius | var(--fs-border-radius) |\n| \\--fs-image-gallery-selector-thumbnail-border-width | var(--fs-border-width-thick) |\n| \\--fs-image-gallery-selector-thumbnail-selected-border-color | var(--fs-border-color-active) |\n| \\--fs-image-gallery-selector-thumbnail-selected-border-width | var(--fs-border-width-thickest) |\n| \\--fs-image-gallery-selector-thumbnail-image-border-radius | var(--fs-border-radius-small) |\n\n---\n\n## Data attributes\n\nYou can target and override `ImageGallery` styles using the following data attributes:\n\n`data-fs-image-gallery`\n\n`data-fs-image-gallery=\"with-selector | without-selector\"`\n\n`data-fs-image-gallery-selector`\n\n`data-fs-image-gallery-selector-control`\n\n`data-fs-image-gallery-selector-control-button`\n\n`data-fs-image-gallery-selector-elements`\n\n`data-fs-image-gallery-selector-thumbnail`\n\n---\n\n## Props\n\n### ImageGallery\n\n| Name | Type | Description | Default |\n| ------------------------- | --------------------- | -------------------------------------------------------------------------------------- | ---------------- |\n| **testId** | string | ID to find this component in testing tools (e.g.: cypress, testing-library, and jest). | fs-image-gallery |\n| **images\\*** | ImageElementData\\[\\] | List of images that should be rendered. | |\n| **ImageComponent\\*** | ImageComponentType | Function that returns a React component that will be used to render images. | |\n| **selectedImageIdx\\*** | number | The currently active thumbnail. | |\n| **setSelectedImageIdx\\*** | (idx: number) => void | Event handler for clicks on each thumbnail. | |\n\n### ImageGallerySelector\n\n| Name | Type | Description | Default |\n| ---------------------------------- | -------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------- |\n| **testId** | string | ID to find this component in testing tools (e.g.: cypress, testing-library, and jest). | fs-image-gallery-selector |\n| **currentImageIdx\\*** | number | The currently active thumbnail. | |\n| **aria-label** | string | For accessibility purposes, define a string that labels the current element. | |\n| **navigationButtonLeftAriaLabel** | string | For accessibility purposes, define a string that labels the left navigation icon button. | Backward slide image selector |\n| **navigationButtonRightAriaLabel** | string | For accessibility purposes, define a string that labels the right navigation button icon. | Forward slide image selector |\n| **onSelect\\*** | (imageIdx: number) => void | Event handler for clicks on each thumbnail. | |\n| **images\\*** | ImageElementData\\[\\] | List of images that should be rendered. | |\n| **ImageComponent\\*** | ImageComponentType | Function that returns a React component that will be used to render images. | |\n\n### ImageElementData\n\n| Name | Type | Description | Default |\n| ------------------- | ------ | ------------------------------------------ | ------- |\n| **url\\*** | string | Image URL. | |\n| **alternateName\\*** | string | Alternative text description of the image. | |\n\nContributors\n\n3\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/aliceoq)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/organisms/image-gallery.mdx)\n\n[Hero« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-hero)[NavbarSliderNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-navbar-slider)\n\nContributors\n\n3\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/aliceoq)\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery%23examples)\n\n[With Selector (More than 1 Image)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery%23with-selector-more-than-1-image)[Without Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery%23without-selector)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery%23design-tokens)\n\n[Controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery%23controls)[Current Selected Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery%23current-selected-image)[Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery%23selector)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery%23props)\n\n[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery%23imagegallery)[ImageGallerySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery%23imagegalleryselector)[ImageElementData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery%23imageelementdata)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/organisms/image-gallery.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery%23examples)\n\n[With Selector (More than 1 Image)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery%23with-selector-more-than-1-image)[Without Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery%23without-selector)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery%23design-tokens)\n\n[Controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery%23controls)[Current Selected Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery%23current-selected-image)[Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery%23selector)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery%23props)\n\n[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery%23imagegallery)[ImageGallerySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery%23imagegalleryselector)[ImageElementData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery/docs/guides/faststore/organisms-image-gallery%23imageelementdata)\n\nOn this page\n\n[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=)"
}
] |
doc_ff16d5bc
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX search didyoumean app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/troubleshooting)\n\n[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.search/didyoumean/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/guides/basic-components)\n\nDidYouMean\n\n[vtex.search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search)\n\nVersion: 2.18.8\n\nLatest version: 2.18.8\n\n`DidYouMean` is a component used to suggest a possible misspelling correction to the current query.\n\n## Before you begin\n\nMake sure you have added the `search` app to your theme dependencies in the `manifest.json` as shown below:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.search\": \"2.x\" \n\n3\n\n } \n\n`\n\nCheck the [Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search) app documentation for more details on this step.\n\n## Usage\n\nAdd the `did-you-mean` block to the `search-result-layout.desktop` or `search-result-layout.mobile`. For example:\n\n`1\n\n\"search-result-layout.desktop\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"flex-layout.row#didyoumean\", \n\n4\n\n ], \n\n5\n\n \"flex-layout.row#didyoumean\": { \n\n6\n\n \"children\": [\"did-you-mean\"] \n\n7\n\n } \n\n8\n\n} \n\n`\n\n## Customization\n\nIn order to apply CSS customizations in this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization).\n\n| CSS Handles |\n| ---------------- |\n| didYouMeanPrefix |\n| didYouMeanTerm |\n\n[Suggestions« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.search/suggestions)[Search ResultNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.search-result)\n\nSee also\n\n[Vtex.searchVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.search)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.search/didyoumean%23before-you-begin)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.search/didyoumean%23usage)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/didyoumean/docs/apps/vtex.search/didyoumean%23customization)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_9d8ce1da
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore security enabling refresh token in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/sdk-overview)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/analytics-overview)\n\n[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/cart-overview)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/search-overview)\n\n[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/session-overview)\n\n[Enabling refresh token on FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/session-enabling-refresh-token)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/sdk-overview)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/analytics-overview)\n\n[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/cart-overview)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/search-overview)\n\n[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/session-overview)\n\n[Enabling refresh token on FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/session-enabling-refresh-token)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/sdk-overview)\n\n[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/session-overview)\n\nEnabling refresh token on FastStore\n\nAutomatically refresh user sessions without re-logging in by enabling the refresh token flow in your FastStore project.\n\n[Refresh token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations) is a security mechanism that allows users to obtain a new, short-lived access token without requiring them to log in again.\n\nThe [FastStore SDK Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview%23session) includes built-in support for the [refresh token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations) flow. It automatically manages token renewal, session management, and error handling. As a FastStore user, you only need to enable the refresh token in your project configuration. The SDK will manage the process automatically, without requiring you to implement a custom flow.\n\nIn this guide, you'll learn how to enable the refresh token in a FastStore store.\n\n> For details about how the refresh tokens work, check the [Refresh token flow for headless implementations guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations).\n\n## Before you begin\n\n### Update your FastStore project\n\nMake sure your project is updated to the latest version. To do so, follow these steps:\n\n1. Open your project in a code editor.\n2. Open a terminal and run the following command to update the FastStore packages to the latest version:\n\n`1\n\nyarn upgrade -L --scope @faststore \n\n`\n\n### Request refresh token activation\n\nOpen a ticket with [VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support) to request refresh token activation and an expiration time (1, 7, or 30 days). Include the account name(s) in your request to enable the feature. Without this activation, you won’t be able to enable the refresh token in your account.\n\n## Instructions\n\n1. Open your FastStore project in a code editor.\n2. In the `discovery.config.js` file, under the `experimental` section, add the `refreshToken` flag and set its value to `true`: \ndiscovery.config.js \n`1 \nexperimental: { \n2 \n … \n3 \n refreshToken: true \n4 \n} \n`\n3. Commit and push your changes to the main branch to deploy the changes to production.\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/sdk/session/enabling-refresh-token.mdx)\n\n[Session« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/session-overview)[Developing and overriding UI componentsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/developing-and-overriding-components-overview)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/session-enabling-refresh-token%23before-you-begin)\n\n[Update your FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/session-enabling-refresh-token%23update-your-faststore-project)[Request refresh token activation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/session-enabling-refresh-token%23request-refresh-token-activation)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/session-enabling-refresh-token%23instructions)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/sdk/session/enabling-refresh-token.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/session-enabling-refresh-token%23before-you-begin)\n\n[Update your FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/session-enabling-refresh-token%23update-your-faststore-project)[Request refresh token activation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/session-enabling-refresh-token%23request-refresh-token-activation)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token/docs/guides/faststore/session-enabling-refresh-token%23instructions)\n\nOn this page\n\n[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=)"
}
] |
doc_1e775b3f
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore override use cases adding an image to the alert component in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component/docs/storefront-development)\n\nAdding an image to the Alert component\n\nThis guide illustrates an advanced use case for [getOverriddenSection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function) in FastStore. It focuses on customizing the [Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-list-of-native-sections%23alert) section's icon to display a custom image as an icon instead.\n\n> For detailed instructions on overriding components, refer to [Overriding native component’s props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props) and [Overriding a native component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-native-component).\n\n## Context\n\n* The native [Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-list-of-native-sections%23alert) section provides an `icon` prop for customization. It only accepts predefined icons, but you want more control and flexibility over the displayed content.\n* You want to display a custom image as the icon alongside the text in your alert messages.\n\n## Implementation\n\nBy leveraging `getOverriddenSection`, you can create a custom component called `AlertWithImage` that achieves the desired functionality. Follow the steps below:\n\n1. In the `src/components/sections` folder, create the folder `AlertWithImage` folder.\n2. In the `AlertWithImage` folder, create the `AlertWithImage.tsx` file.\n3. Import the following to the `AlertWithImage.tsx` file: \n`1 \nimport { getOverriddenSection } from \"@faststore/core\"; \n2 \nimport Image from \"next/image\"; \n3 \nimport { useMemo } from \"react\"; \n`\n4. Define the `AlertWithImageProps` interface: \n`1 \nimport { getOverriddenSection } from \"@faststore/core\"; \n2 \nimport Image from \"next/image\"; \n3 \nimport { useMemo } from \"react\"; \n4 \n \n5 \ninterface AlertWithImageProps \n6 \n extends Omit<React.ComponentProps<typeof AlertSection>, \"icon\"> { \n7 \n src: string; \n8 \n alt: string; \n9 \n} \n` \n * This interface defines the props accepted by the `AlertWithImage` component. \n * It inherits all props from the native Alert component, excluding the icon prop, which we intend to replace with an image. \n * It adds a new prop named `src`, which specifies the image source URL.\n5. Create the `AlertWithImage` component: \n`1 \nimport { useMemo } from \"react\"; \n2 \nimport { AlertSection, getOverriddenSection } from \"@faststore/core\"; \n3 \nimport { Image_unstable as Image } from \"@faststore/core/experimental\"; \n4 \n \n5 \ninterface AlertWithImageProps \n6 \n extends Omit<React.ComponentProps<typeof AlertSection>, \"icon\"> { \n7 \n src: string; \n8 \n alt: string; \n9 \n} \n10 \n \n11 \nexport default function AlertWithImage(props: AlertWithImageProps) { \n12 \n const { src, alt, ...otherProps } = props; \n13 \n \n14 \n const OverriddenAlert = useMemo( \n15 \n () => \n16 \n getOverriddenSection({ \n17 \n Section: AlertSection, \n18 \n className: styles.alertWithImage, \n19 \n components: { \n20 \n Icon: { \n21 \n Component: () => ( \n22 \n <Image \n23 \n src={props.src} \n24 \n alt={props.alt} \n25 \n width={24} \n26 \n height={24} \n27 \n /> \n28 \n ), \n29 \n }, \n30 \n }, \n31 \n }), \n32 \n [] \n33 \n ); \n34 \n \n35 \n return <OverriddenAlert {...otherProps} icon=\"\" />; \n36 \n} \n` \n * This function receives the `AlertWithImageProps`. \n * It destructures the `src` prop containing the image source and remaining props using the spread operator (`...otherProps`). \n * The core functionality lies within the `useMemo` hook. \n * It defines the `OverriddenAlert` constant using `getOverriddenSection`. \n * The override options specify: \n * **`Section`:** The section to be overridden (Alert). \n * **`components`:** An object containing the override for the Icon component. \n * Inside the Icon override: \n * **`Component`:** A function returning an `Image` component. This displays the image specified by the `src` prop. \n * **`width`** and **`height`:** Optional props to set the size of the image. \n * The use of `useMemo` ensures this override is only created once, improving performance. \n * The function returns the `OverriddenAlert` component, spreading the `otherProps` and setting the `icon` prop to `noop` (effectively disabling the default icon behavior). \n> For further details on code implementation, see the [AlertWithImage](https://read.calvincode.net/reader?url=https://github.com/vtex-sites/playground.store/tree/main/src/components/sections/AlertWithImage) folder available in the [playground.store](https://read.calvincode.net/reader?url=https://github.com/vtex-sites/playground.store) repository.\n6. Add the section to the Headless CMS by following the instructions available in [syncing components to the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms). \nThe following schema was used as an example in [cms/faststore/sections.json](https://read.calvincode.net/reader?url=https://github.com/vtex-sites/playground.store/blob/main/cms/faststore/sections.json%23L58-L101): \n`1 \n[ \n2 \n { \n3 \n \"name\": \"AlertWithImage\", \n4 \n \"schema\": { \n5 \n \"title\": \"Alert with image\", \n6 \n \"description\": \"Add an Alert that has an Image as an icon\", \n7 \n \"type\": \"object\", \n8 \n \"required\": [ \n9 \n \"src\", \n10 \n \"content\", \n11 \n \"dismissible\" \n12 \n ], \n13 \n \"properties\": { \n14 \n \"src\": { \n15 \n \"type\": \"string\", \n16 \n \"title\": \"Image source\", \n17 \n \"description\": \"Source of the Alert icon image\" \n18 \n }, \n19 \n \"content\": { \n20 \n \"type\": \"string\", \n21 \n \"title\": \"Content\" \n22 \n }, \n23 \n \"link\": { \n24 \n \"title\": \"Link\", \n25 \n \"type\": \"object\", \n26 \n \"properties\": { \n27 \n \"text\": { \n28 \n \"type\": \"string\", \n29 \n \"title\": \"Link Text\" \n30 \n }, \n31 \n \"to\": { \n32 \n \"type\": \"string\", \n33 \n \"title\": \"Action link\" \n34 \n } \n35 \n } \n36 \n }, \n37 \n \"dismissible\": { \n38 \n \"type\": \"boolean\", \n39 \n \"default\": false, \n40 \n \"title\": \"Is dismissible?\" \n41 \n } \n42 \n } \n43 \n } \n44 \n } \n45 \n] \n`\n\n> For further details on code implementation, see the [sections.json](https://read.calvincode.net/reader?url=https://github.com/vtex-sites/playground.store/blob/main/cms/faststore/sections.json%23L58-L101) file available in the [playground.store](https://read.calvincode.net/reader?url=https://github.com/vtex-sites/playground.store/tree/main) repository.\n\n## Results\n\nOnce you have [set your development mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode) to see the changes locally, you can see the image as an icon in the alert:\n\n* **Before** \nThe native Alert displays one of the default icons, the `BellRinging`, following the sentence `Get 15% off today: NEW15! Buy now`. \n\n* **After** \nThe native Alert was replaced with the custom one, which features a pink image in the form of an icon added through Headless CMS. \n\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/developing-and-overriding-components/override-use-cases/adding-an-image-to-the-alert-component.mdx)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component%23context)\n\n[Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component%23implementation)\n\n[Results](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component%23results)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/developing-and-overriding-components/override-use-cases/adding-an-image-to-the-alert-component.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component%23context)\n\n[Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component%23implementation)\n\n[Results](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component/docs/guides/faststore/override-use-cases-adding-an-image-to-the-alert-component%23results)\n\nOn this page\n\n[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=)"
}
] |
doc_37cb7368
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation 3 settingyourstoretheme in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[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-3-settingyourstoretheme/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/api-reference)\n\n[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-3-settingyourstoretheme/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/storefront-development)\n\n[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-3-settingyourstoretheme/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/troubleshooting)\n\n[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-3-settingyourstoretheme/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/getting-started-3)\n\n[1\\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-1-basicsetup)\n\n[2\\. Configuring your account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-2-prerequesites)\n\n[3\\. Creating a Store Theme project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-3-settingyourstoretheme)\n\n[4\\. Configuring templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-4-configuringtemplates)\n\n[5\\. Defining styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-5-definingstyles)\n\n[6\\. Building your own store theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-6-buildingyourownstoretheme)\n\n[7\\. Making your store theme public](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-making-your-theme-content-public)\n\n[Glossary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/store-framework-glossary)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/getting-started-3)\n\n[1\\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-1-basicsetup)\n\n[2\\. Configuring your account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-2-prerequesites)\n\n[3\\. Creating a Store Theme project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-3-settingyourstoretheme)\n\n[4\\. Configuring templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-4-configuringtemplates)\n\n[5\\. Defining styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-5-definingstyles)\n\n[6\\. Building your own store theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-6-buildingyourownstoretheme)\n\n[7\\. Making your store theme public](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-making-your-theme-content-public)\n\n[Glossary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/store-framework-glossary)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/store-framework)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/getting-started-3)\n\n[3\\. Creating a Store Theme project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-3-settingyourstoretheme)\n\n3\\. Creating a Store Theme project\n\nDiscover how to create your very first Store Framework storefront.\n\nThis guide explains how to start building a [Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme), a VTEX IO project that uses the [store builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-builder) and Store Framework blocks to create the storefront of a VTEX store. The Store Theme defines the store's visual and interactive elements, including layout, colors, typography, icons, and animations.\n\nTo kickstart our storefront project, we'll use a pre-defined [Store Theme boilerplate app](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-theme), which simplifies the process of creating a custom Store Theme by providing pre-defined templates and styles. For more information about available themes, see the guide [Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme).\n\n## Before you begin\n\n### Have the Edtion Store app\n\nMake sure your VTEX account has the Store Edition app installed, as recommended in this track's second step [Configuring your account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites). Otherwise, you won't be able to successfully implement the VTEX Store Framework.\n\n### Learn about the Store Theme app’s structure\n\nFamiliarize yourself with the Store Theme’s structure. Understanding the purpose of each file and folder will help you configure the store’s templates and visual theme according to your needs. Learn about in [Project structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme%23project-structure).\n\n## Instructions\n\n### Step 1 - Downloading the Store Theme app\n\nThe VTEX IO CLI provides pre-defined app templates to simplify the creation of a new VTEX IO project. Follow these steps to set up a Store Theme project:\n\n1. Open your terminal and run the following command to create a new project: \n`1 \nvtex init \n`\n2. When prompted, select `store`. The CLI will ask for confirmation before cloning the `minimum-boilerplate-theme`. Type `y` to proceed. \n\n3. Open the `minimum-boilerplate-theme` in your preferred code editor.\n4. Go to the `manifest.json` file and replace the predefined `vendor` value with your store's account name. This ensures you can publish your Store Theme app correctly.\n\n### Step 2 - Linking your local code to the VTEX IO platform\n\nSince the Store Theme boilerplate app already includes a default theme, you can immediately see how this theme affects your website frontend by following the instructions below:\n\n1. Open the terminal and log in to your VTEX account.\n\n`1\n\n vtex login {accountName} \n\n`\n\n> Replace `{accountName}` with the name of your VTEX account.\n\n1. Create a [development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace) by running the following command:\n\n`1\n\n vtex use {workspaceName} \n\n`\n\n> Replace `{workspaceName}` based on your scenario.\n\n1. Change to the `store-theme` directory.\n2. Link the Store Theme app to the current workspace by running the following command:\n\n`1\n\n vtex link \n\n`\n\nThe `vtex link` command sends your code to the platform, allowing you to see your changes in real time.\n\n\n\nBy successfully running this command in your terminal, your local code is sent to the VTEX IO cloud-native infrastructure and reflected in the development workspace you're currently working in. Any changes made to your Store Theme app files will now be automatically reflected on your website in real time.\n\n### Step 3 - Checking out your new Store Theme\n\nTo view your new Store Theme in action on your store's website, run the following command in your terminal:\n\n`1\n\n vtex browse \n\n`\n\nThis command will open your browser with the workspace you're working on. Alternatively, you can navigate directly to `https://{workspaceName}--{accountName}.myvtex.com`, replacing the placeholders with your development workspace and VTEX account name.\n\nOnce you're logged in, you should see the following Store Theme rendered on your store's website:\n\n\n\nNow that your store is using a default theme code, you can start configuring the Store Theme app to match your store needs. This includes changing templates and customizing styles to create a unique identity for your store.\n\nIn the upcoming guides of this tutorial, you'll learn how to define templates by configuring and combining components for each store page, as well as declaring styles such as colors, typography scales, and spacing.\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Getting-Started/getting-started-3/vtex-io-documentation-3-settingyourstoretheme.md)\n\n[2\\. Configuring your account« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme//docs/guides/vtex-io-documentation-2-prerequesites)[4\\. Configuring templatesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme//docs/guides/vtex-io-documentation-4-configuringtemplates)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-3-settingyourstoretheme%23before-you-begin)\n\n[Have the Edtion Store app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-3-settingyourstoretheme%23have-the-edtion-store-app)[Learn about the Store Theme app’s structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-3-settingyourstoretheme%23learn-about-the-store-theme-apps-structure)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-3-settingyourstoretheme%23instructions)\n\n[Step 1 - Downloading the Store Theme app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-3-settingyourstoretheme%23step-1-downloading-the-store-theme-app)[Step 2 - Linking your local code to the VTEX IO platform](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-3-settingyourstoretheme%23step-2-linking-your-local-code-to-the-vtex-io-platform)[Step 3 - Checking out your new Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-3-settingyourstoretheme%23step-3-checking-out-your-new-store-theme)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Getting-Started/getting-started-3/vtex-io-documentation-3-settingyourstoretheme.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-3-settingyourstoretheme%23before-you-begin)\n\n[Have the Edtion Store app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-3-settingyourstoretheme%23have-the-edtion-store-app)[Learn about the Store Theme app’s structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-3-settingyourstoretheme%23learn-about-the-store-theme-apps-structure)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-3-settingyourstoretheme%23instructions)\n\n[Step 1 - Downloading the Store Theme app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-3-settingyourstoretheme%23step-1-downloading-the-store-theme-app)[Step 2 - Linking your local code to the VTEX IO platform](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-3-settingyourstoretheme%23step-2-linking-your-local-code-to-the-vtex-io-platform)[Step 3 - Checking out your new Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme/docs/guides/vtex-io-documentation-3-settingyourstoretheme%23step-3-checking-out-your-new-store-theme)\n\nOn this page\n\n[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=)"
}
] |
doc_4830cdc1
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX search suggestions app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/troubleshooting)\n\n[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.search/suggestions/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/guides/basic-components)\n\nSuggestions\n\n[vtex.search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search)\n\nVersion: 2.18.8\n\nLatest version: 2.18.8\n\n`Suggestions` is a component used to suggest search terms similar to the current query.\n\n## Before you begin\n\nMake sure you have added the `search` app to your theme dependencies in the `manifest.json` as shown below:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.search\": \"2.x\" \n\n3\n\n } \n\n`\n\nCheck the [Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search) app documentation for more details on this step.\n\n## Usage\n\nAdd the `search-suggestions` block to the `search-result-layout.desktop` or `search-result-layout.mobile`. For example:\n\n`1\n\n\"search-result-layout.desktop\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"flex-layout.row#suggestion\", \n\n4\n\n ], \n\n5\n\n \"flex-layout.row#suggestion\": { \n\n6\n\n \"children\": [\"search-suggestions\"] \n\n7\n\n } \n\n8\n\n} \n\n`\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| ---------- | ------ | -------------------------------------------------------------------------------- | ------------- |\n| customPage | string | Defines a custom page to the link of a suggestion. Example: store.search.custom. | store.search |\n\n## Customization\n\nIn order to apply CSS customizations in this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization).\n\n| CSS Handles |\n| --------------------- |\n| suggestionsList |\n| suggestionsListPrefix |\n| suggestionsListLink |\n| suggestionsListItem |\n\n[Search« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.search)[DidYouMeanNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.search/didyoumean)\n\nSee also\n\n[Vtex.searchVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.search)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.search/suggestions%23before-you-begin)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.search/suggestions%23usage)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.search/suggestions%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/suggestions/docs/apps/vtex.search/suggestions%23customization)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_6e3d6bd7
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides sending emails with triggers on master data v2 in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/master-data-best-practices)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/master-data-v2)\n\nSchemas\n\nTriggers\n\n[Setting up triggers on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/setting-up-triggers-on-master-data-v2)\n\n[A/B testing Master Data v2 trigger actions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/trigger-ab-test)\n\n[Sending emails with triggers on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2)\n\n[Master Data v2 document saving flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/master-data-v2-document-saving-flow)\n\n[Creating relationships between data entities using Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2)\n\n[Using dynamic expressions on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/using-dynamic-expressions-on-master-data-v2)\n\n[Searching by geocoordinates in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/searching-by-geocoordinates-in-master-data-v2)\n\n[Setting up alternate keys in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/setting-up-alternate-keys-in-master-data-v2)\n\n[Setting up an auto increment field in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/master-data-v1)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/master-data-best-practices)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/master-data-v2)\n\nSchemas\n\nTriggers\n\n[Setting up triggers on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/setting-up-triggers-on-master-data-v2)\n\n[A/B testing Master Data v2 trigger actions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/trigger-ab-test)\n\n[Sending emails with triggers on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2)\n\n[Master Data v2 document saving flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/master-data-v2-document-saving-flow)\n\n[Creating relationships between data entities using Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2)\n\n[Using dynamic expressions on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/using-dynamic-expressions-on-master-data-v2)\n\n[Searching by geocoordinates in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/searching-by-geocoordinates-in-master-data-v2)\n\n[Setting up alternate keys in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/setting-up-alternate-keys-in-master-data-v2)\n\n[Setting up an auto increment field in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/master-data-v1)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides)\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/master-data)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/master-data-v2)\n\nTriggers\n\n[Sending emails with triggers on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2)\n\nSending emails with triggers on Master Data v2\n\nThere are two ways of sending emails automatically with Master Data v2 triggers:\n\n* [Sending emails](#sending-emails)\n* [Sending emails using Message Center templates](#sending-emails-using-message-center-templates)\n\n> Learn more about triggers in the article [Setting up triggers in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2).\n\n## Sending emails\n\nThis is the more direct method of sending emails with Master Data v2 triggers, but without the standardization provided by [Message Center templates](#sending-emails-using-message-center-templates).\n\n### Properties\n\n| Field | Type | Description | Required |\n| -------- | ---------------- | ----------------------------------------------------------------------------------- | -------- |\n| type | String | Action type, which must be email. | True |\n| provider | String | Message Center provider name (usually named as default). | True |\n| from | Object | Information about the sender. | True |\n| ↪ email | String | Sender email. | True |\n| ↪ name | String | Sender name. | True |\n| to | Array of strings | List of recipient email addresses, separated by comma. | True |\n| replyTo | Array | Email address for replies. | True |\n| subject | String | Email subject. | True |\n| body | String | Email message body. | True |\n| bcc | Array of strings | List of email addresses that will receive a blind carbon copy (BCC) of the message. | False |\n\n### Dynamic expressions\n\nYou can use dynamic expressions to deal with document properties in these settings. For more information, look at the [Article on dynamic expressions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2).\n\n### JSON schema example\n\n`1\n\n { \n\n2\n\n \"properties\": { ... }, \n\n3\n\n \"v-triggers\": [ \n\n4\n\n { \n\n5\n\n \"type\": \"email\", \n\n6\n\n \"provider\": \"default\", \n\n7\n\n \"subject\": \"Sending email with VTEX Master Data\", \n\n8\n\n \"from\": { \n\n9\n\n \"email\": \"mailfrom@email.com\", \n\n10\n\n \"name\": \"My custom name\" \n\n11\n\n }, \n\n12\n\n \"to\": [ \"test@test.com\" ], \n\n13\n\n \"bcc\": [ \"testbcc@test.com\" ], \n\n14\n\n \"replyTo\": \"noreply@email.com\", \n\n15\n\n \"body\": \"VTEX Master Data Triggers email body\" \n\n16\n\n } \n\n17\n\n ] \n\n18\n\n } \n\n`\n\n## Sending emails using Message Center templates\n\nSee below how to set up a trigger to send emails using a [Message Center](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/understanding-the-message-center--tutorials%5F84) template.\n\n### Properties\n\n| Field | Type | Description | Required |\n| -------- | ---------------- | ----------------------------------------------------------------------------------- | -------- |\n| type | String | Action type, which must be t-email. | True |\n| template | String | Name of the Message Center template. | True |\n| provider | String | Message Center provider name (usually named as default). | True |\n| from | Object | Information about the sender. | True |\n| ↪ email | String | Sender email. | True |\n| ↪ name | String | Sender name. | True |\n| to | Array of strings | List of recipient email addresses, separated by comma. | True |\n| replyTo | String | Email address for replies. | True |\n| subject | String | Email subjec.t | True |\n| body | String | Email message body. | True |\n| bcc | Array of strings | List of email addresses that will receive a blind carbon copy (BCC) of the message. | False |\n\n### JSON schema example\n\n`1\n\n { \n\n2\n\n \"properties\": { ... }, \n\n3\n\n \"v-triggers\" [ \n\n4\n\n { \n\n5\n\n \"type\": \"t-email\", \n\n6\n\n \"template\": \"template-name\", \n\n7\n\n \"provider\": \"default\", \n\n8\n\n \"subject\": \"My template email with VTEX Master Data\", \n\n9\n\n \"to\": [ \n\n10\n\n \"{!email}\", \n\n11\n\n \"test@email.com\" \n\n12\n\n ], \n\n13\n\n \"bcc\": [ \n\n14\n\n \"myemail@test.com\" \n\n15\n\n ], \n\n16\n\n \"replyTo\": \"noreply@company.com\", \n\n17\n\n \"body\": { \n\n18\n\n \"firstName\": \"{firstName}\", \n\n19\n\n \"email\": \"{email}\", \n\n20\n\n \"id\": \"{!id}\", \n\n21\n\n \"clientName\": \"{!clientProfileData.firstName{!clientProfileData.lastName}\", \n\n22\n\n \"ownerListName\": \"{!customData.customApps[0fields.ownerListName}\", \n\n23\n\n \"ownerListEmail\": \"{!customData.customApps[0fields.ownerListEmail}\", \n\n24\n\n \"items\": \"{!items}\", \n\n25\n\n \"openTextField\": \"{!openTextField.value}\" \n\n26\n\n } \n\n27\n\n } \n\n28\n\n ] \n\n29\n\n } \n\n`\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/master-data-v2/triggers/sending-emails-with-triggers-on-master-data-v2.md)\n\n[A/B testing Master Data v2 trigger actions« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2//docs/guides/trigger-ab-test)[Master Data v2 document saving flowNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2//docs/guides/master-data-v2-document-saving-flow)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Sending emails](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2%23sending-emails)\n\n[Properties](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2%23properties)[Dynamic expressions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2%23dynamic-expressions)[JSON schema example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2%23json-schema-example)\n\n[Sending emails using Message Center templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2%23sending-emails-using-message-center-templates)\n\n[Properties](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2%23properties)[JSON schema example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2%23json-schema-example)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/master-data-v2/triggers/sending-emails-with-triggers-on-master-data-v2.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Sending emails](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2%23sending-emails)\n\n[Properties](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2%23properties)[Dynamic expressions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2%23dynamic-expressions)[JSON schema example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2%23json-schema-example)\n\n[Sending emails using Message Center templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2%23sending-emails-using-message-center-templates)\n\n[Properties](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2%23properties)[JSON schema example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2%23json-schema-example)\n\nOn this page\n\n[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=)"
}
] |
doc_d1b4f14f
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX overlay layout app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/troubleshooting)\n\n[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.overlay-layout/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/layout-apps)\n\n[Condition Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.condition-layout)\n\n[Disclosure Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.disclosure-layout)\n\n[Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.flex-layout)\n\n[Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.modal-layout)\n\n[Overlay Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.overlay-layout)\n\n[Responsive Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.responsive-layout)\n\n[Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.slider-layout)\n\n[Stack Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.stack-layout)\n\n[Sticky Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.sticky-layout)\n\n[Tab Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.tab-layout)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/layout-apps)\n\n[Condition Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.condition-layout)\n\n[Disclosure Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.disclosure-layout)\n\n[Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.flex-layout)\n\n[Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.modal-layout)\n\n[Overlay Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.overlay-layout)\n\n[Responsive Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.responsive-layout)\n\n[Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.slider-layout)\n\n[Stack Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.stack-layout)\n\n[Sticky Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.sticky-layout)\n\n[Tab Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.tab-layout)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/vtex-io-apps)\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/layout-apps)\n\nOverlay Layout\n\nOfficial extension\n\nVersion: 0.1.3\n\nLatest version: 0.1.3\n\n[](#contributors-)\n\nThe Overlay Layout app provides blocks that help you create a Dropdown, Select or a Tooltip component.\n\n\n\n_Example of a [Locale Switcher](https://read.calvincode.net/reader?url=https://vtex.io/docs/components/all/vtex.locale-switcher@0.5.5) using the Overlay Layout_.\n\n## Configuration\n\n1. Add the Overlay Layout app to your theme's dependencies in the `manifest.json`, for example:\n\n`1\n\n{ \n\n2\n\n \"dependencies\": { \n\n3\n\n \"vtex.overlay-layout\": \"0.x\" \n\n4\n\n } \n\n5\n\n} \n\n`\n\nNow you can use the two blocks exported by the app:\n\n| Block name | Description |\n| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| overlay-trigger |  Declares a renderable children block responsible for triggering the overlay-layout content. |\n| overlay-layout |  Declares a renderable children block responsible for building the |\n\n1. In any desired theme template, add the `overlay-trigger` and then declare it using a block of your choosing and the `overlay-layout`:\n\n`1\n\n{ \n\n2\n\n \"overlay-trigger\": { \n\n3\n\n \"children\": [ \n\n4\n\n \"rich-text#question\", \n\n5\n\n \"overlay-layout\" \n\n6\n\n ] \n\n7\n\n }, \n\n`\n\n_Notice that the_ `overlay-trigger` i_s not rendered. Following the example stated above, the_ `rich-text` _block will be the one rendered and responsible for effectively triggering the Overlay Layout content (defined by the children block of_ `overlay-layout`_)._\n\n### `overlay-trigger` props\n\n| Prop name | Type | Description | Default value |\n| --------- | ---- | ------------------------------------------------------------------------------------ | ------------- |\n| trigger | Enum | Defines whether the popover-layout will be opened by click (click) or hover (hover). | click |\n\n1. Configure the chosen trigger [block](https://read.calvincode.net/reader?url=https://vtex.io/docs/apps/all) and declare the `overlay-layout` using its props. For example:\n\n`1\n\n \"rich-text#question\": { \n\n2\n\n \"props\": { \n\n3\n\n \"text\": \"**Click to open the Overlay Layout**\", \n\n4\n\n \"blockClass\": \"question\" \n\n5\n\n } \n\n6\n\n }, \n\n7\n\n \"overlay-layout\": { \n\n8\n\n \"props\": { \n\n9\n\n \"placement\": \"left\" \n\n10\n\n }, \n\n11\n\n \"children\": [ \n\n12\n\n \"rich-text#link\" \n\n13\n\n ] \n\n14\n\n }, \n\n15\n\n \"rich-text#link\": { \n\n16\n\n \"props\": { \n\n17\n\n \"text\": \"\\n**Reach us at**\\nwww.vtex.com.br\", \n\n18\n\n \"blockClass\": \"link\" \n\n19\n\n } \n\n20\n\n } \n\n21\n\n} \n\n`\n\n_The_ `overlay-layout` _defines which block will be rendered in order to build the Overlay Layout content. This means that you will have to pass to it a children block to be rendered._\n\n### `overlay-layout` props\n\n| Prop name | Type | Description | Default value |\n| -------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |\n| placement | Enum | Defines the Overlay Layout content placement when it is triggered according to the Trigger component positioning. Possible values are: bottom, left, right or top. If there is no page space in the placement that you choose, it will fit in a fallback position. | bottom |\n| scrollBehavior | Enum | Defines the Overlay Layout content behavior when users try to scroll the page. Possible values are: lock-page-scroll (in which users can't scroll), close-on-scroll (the block is closed when users start scrolling) or default (Scroll does not affect the Overlay Layout content). | default |\n| backdrop | Enum | Once the Overlay Layout content is rendered, it defines whether a backdrop overlay will be displayed (visible) or not (none). When set as visible, the backdrop will close Overlay Layout content when clicked on. Otherwise, the content will be closed only if any component from the page is clicked on. | none |\n| showArrow | Boolean | Whether an arrow pointing to the overlay-trigger component should be displayed on UI(true) or not (false). | false |\n| offsets | Object | Defines the overlay-layout component positioning when compared to the overlay-trigger (unit used is px). For more details, check out the offsets object table stated below. | { skidding: 0, distance: 0 } |\n\n* **`offsets` object:**\n\n| Prop | Type | Description |\n| -------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| skidding | Number | Defines the overlay-layout component positioning side by side with the overlay-trigger. |\n| distance | Number | Defines the distance between the overlay-layout and the overlay-trigger components in the UI. A positive number places the overlay-layout component farther, while a negative number lets it overlap the overlay-trigger. |\n\n## Customization\n\nIn order to apply CSS customizations in this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization).\n\n| CSS Handles |\n| ------------------- |\n| arrow |\n| container |\n| outsideClickHandler |\n| paper |\n| popper |\n| popperArrow |\n| trigger |\n\n[Modal Layout« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.modal-layout)[Responsive LayoutNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.responsive-layout)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.overlay-layout%23configuration)\n\n[overlay-trigger props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.overlay-layout%23overlay-trigger-props)[overlay-layout props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.overlay-layout%23overlay-layout-props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.overlay-layout%23customization)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_4286dab4
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore go live overview in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-before-you-begin)\n\n[1\\. Configuring external DNS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-1-configuring-external-dns)\n\n[2\\. Integrating the VTEX Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-2-integrating-the-vtex-login)\n\n[3\\. Integrating the VTEX Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout)\n\n[4\\. Integrating the VTEX Order Placed and My Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-4-integrating-the-vtex-order-placed-and-my-account)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-before-you-begin)\n\n[1\\. Configuring external DNS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-1-configuring-external-dns)\n\n[2\\. Integrating the VTEX Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-2-integrating-the-vtex-login)\n\n[3\\. Integrating the VTEX Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout)\n\n[4\\. Integrating the VTEX Order Placed and My Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-4-integrating-the-vtex-order-placed-and-my-account)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore)\n\nGo live overview\n\nIn a headless architecture, an ecommerce website relies on the seamless collaboration of various modules. FastStore specializes in the frontend aspect, enabling the development of high-performance user interfaces for ecommerce websites. However, to create a complete digital commerce experience, multiple core modules must be integrated. At **VTEX**, some of these modules are:\n\n| Module | Description |\n| --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |\n| **Checkout** | Receives the shopper's information necessary to process an order. |\n| **OrderPlaced** | Handles the processing of customer orders. It displays a successful message right after the checkout process is completed. |\n| **Login** | Handles user login in a store. |\n| **MyAccount** | Allows customers to manage their orders and personal data (e.g., profile information, passwords, addresses, and credit cards) on a single page. |\n| **VTEX Intelligent Search** | Provides autocomplete and displays relevant results based on the store catalog. |\n\nTherefore, to provide shoppers with a full checkout and post-purchase experience, you, as a developer, must guarantee the integration between your FastStore project and VTEX solutions before going live.\n\nTo ensure that you have set up all configurations for your store to run smoothly, please consider the following go-live checklist.\n\n> To get a complete overview of the go-live process for any VTEX store, see this [Go-live guide](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/go-live-your-store--4Ns5FxIiksmjsdX2yOTduM/1iP90RcJvlrfQhnlxM54wo).\n\n---\n\n## Go-live checklist\n\n### Storefront development\n\nChecking the account edition\n\nEnsure that your account edition is set to `vtex.edition-store@5.x` Edition app in your master workspace.\n\n| Management | Reference |\n| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Agency and VTEX Support | If your account uses a different Edition App version, [open a support ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support) requesting the installation of the [vtex.edition-store@5.x](mailto:vtex.edition-store@5.x). |\n\nDeploying with FastStore WebOps\n\nDeploy your project using the FastStore WebOps app.\n\n| Management | Reference |\n| ---------- | ------------------------------------------------------------------------------------------------------------ |\n| Agency | [FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project) |\n\nSetting up the project\n\nSet up and develop your Storefront.\n\n| Management | Reference |\n| ---------- | -------------------------------------------------------------------------------------------------------------------- |\n| Agency | [Setting up the project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project) |\n\n### VTEX integration\n\nConfiguring external DNS for a custom domain\n\nConfigure your website's domain and subdomain.\n\n| Management | Reference |\n| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |\n| Agency and VTEX Support | [Configuring external DNS for a custom domain](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns) |\n\nIntegrating the VTEX Login\n\nIntegrate the VTEX Login with your FastStore project.\n\n| Management | Reference |\n| ----------------------- | -------------------------------------------------------------------------------------------------------------------- |\n| Agency and VTEX Support | [Integrating the VTEX Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login) |\n\nIntegrating the VTEX Checkout\n\nAdjust the header by replacing the links to the Checkout and MyAccount pages with the proper paths.\n\n| Management | Reference |\n| ----------------------- | -------------------------------------------------------------------------------------------------------------------------- |\n| Agency and VTEX Support | [Integrating the VTEX Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout) |\n\nIntegrating the VTEX Order Placed and My Account\n\nClone, edit, and install the [faststore-vtex-integrations](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore-vtex-integrations/) app on your VTEX account.\n\n| Management | Reference |\n| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Agency and VTEX Support | [Integrating the VTEX Order Placed and My Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-order-placed-and-my-account) |\n\nChecking the pages in the secure domain\n\nTest your website links to pages being rendered in the secure subdomain, such as the Login, Checkout, My Account, and Order Placed pages.\n\n**Management**: Agency\n\n### Headless customization\n\nIntegrating the storefront with VTEX Headless CMS\n\nSet up the preview flow between the storefront and the Headless CMS\n\n| Management | Reference |\n| ---------- | -------------------------------------------------------------------------------------------- |\n| Agency | [VTEX Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview) |\n\n### SSL Configuration\n\nChecking the pages SSL certificate\n\nCheck if all pages of your store have the correct SSL certificate configured.\n\n**Management:** Agency\n\n### Testing and performance\n\nPerforming Lighthouse audits\n\nRun Lighthouse audits on your store's pages to guarantee you are going live with great performance\n\n**Management:** Agency\n\n* Run Lighthouse audits on your store's Home Page, Product Listing Page (PLP), Product Details Page (PDP), and custom pages.\n* All pages must have Lighthouse Score equal or more than 60 on mobile devices.\n* Any publication will be automatically blocked by the system until all checks pass.\n* For more information about store performance, refer to the [Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview) track and the [Lighthouse Integration on WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-dashboard%23integrations) guide.\n\nSetting up Traffic Splitting\n\nIf you already have a live store, configure traffic splitting to validate which version of your website is the best for your business needs.\n\n**Management:** VTEX Support\n\n### Analytics\n\nManaging the Analytics module\n\nMake sure that all analytics events and data are accurately being send to Google Analytics.\n\n| Management | Reference |\n| ---------- | ------------------------------------------------------------------------------------------- |\n| Agency | [FastStore Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview) |\n\n---\n\n## Next\n\nBefore starting the go-live process, make sure that you have met all the necessary prerequisites listed on the [Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin) page.\n\nContributors\n\n3\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/aliceoq)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/go-live/overview.mdx)\n\n[Validating UTM tracking in FastStore« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/seo-validating-utm-tracking-in-faststore)[Before you beginNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-before-you-begin)\n\nContributors\n\n3\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/aliceoq)\n\nON THIS PAGE\n\n[Go-live checklist](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23go-live-checklist)\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23storefront-development)[VTEX integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23vtex-integration)[Headless customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23headless-customization)[SSL Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23ssl-configuration)[Testing and performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23testing-and-performance)[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23analytics)\n\n[Next](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23next)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/go-live/overview.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Go-live checklist](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23go-live-checklist)\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23storefront-development)[VTEX integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23vtex-integration)[Headless customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23headless-customization)[SSL Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23ssl-configuration)[Testing and performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23testing-and-performance)[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23analytics)\n\n[Next](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23next)\n\nOn this page\n\n[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=)"
}
] |
doc_1dee3beb
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides setting up triggers on master data v2 in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/master-data-best-practices)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/master-data-v2)\n\nSchemas\n\nTriggers\n\n[Setting up triggers on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/setting-up-triggers-on-master-data-v2)\n\n[A/B testing Master Data v2 trigger actions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/trigger-ab-test)\n\n[Sending emails with triggers on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2)\n\n[Master Data v2 document saving flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/master-data-v2-document-saving-flow)\n\n[Creating relationships between data entities using Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2)\n\n[Using dynamic expressions on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/using-dynamic-expressions-on-master-data-v2)\n\n[Searching by geocoordinates in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/searching-by-geocoordinates-in-master-data-v2)\n\n[Setting up alternate keys in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/setting-up-alternate-keys-in-master-data-v2)\n\n[Setting up an auto increment field in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/master-data-v1)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/master-data-best-practices)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/master-data-v2)\n\nSchemas\n\nTriggers\n\n[Setting up triggers on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/setting-up-triggers-on-master-data-v2)\n\n[A/B testing Master Data v2 trigger actions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/trigger-ab-test)\n\n[Sending emails with triggers on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2)\n\n[Master Data v2 document saving flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/master-data-v2-document-saving-flow)\n\n[Creating relationships between data entities using Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2)\n\n[Using dynamic expressions on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/using-dynamic-expressions-on-master-data-v2)\n\n[Searching by geocoordinates in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/searching-by-geocoordinates-in-master-data-v2)\n\n[Setting up alternate keys in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/setting-up-alternate-keys-in-master-data-v2)\n\n[Setting up an auto increment field in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/master-data-v1)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides)\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/master-data)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/master-data-v2)\n\nTriggers\n\n[Setting up triggers on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/setting-up-triggers-on-master-data-v2)\n\nSetting up triggers on Master Data v2\n\nLearn how to create and configure triggers in Master Data v2 to automate actions after a document update.\n\nThis guide will teach you how to create and configure triggers in **Master Data v2** to automate actions after a document update.\n\nA **Master Data** trigger is an [action](#action) executed immediately after a document is inserted or updated.\n\n**Master Data v2** supports the following types of triggers:\n\n* Send an HTTP request.\n* Send an email.\n* Send email using [Message Center](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/understanding-the-message-center--tutorials%5F84) template.\n* Save data to another data entity.\n\n> This article is about **Master Data v2** triggers. If you want to use **Master Data v1**, check the [How to create a trigger in **Master Data v1**](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-trigger-in-master-data--tutorials%5F1270) guide.\n\n## Before you begin\n\nYou may use **Master Data v2** triggers to create and add hooks to VTEX first-party apps. To do that, [Create a new JSON schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23put-/api/dataentities/-dataEntityName-/schemas/-schemaName-) for the data entity used by the app and then follow the instructions below.\n\n## Instructions\n\nEach trigger is described as an item of the array `v-triggers` of a [JSON schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/master-data-schema-lifecycle). If you want to create a trigger for a data entity with no associated schema, you may [create a new schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23put-/api/dataentities/-dataEntityName-/schemas/-schemaName-) with the trigger settings according to what is described below.\n\nTo create a new trigger in an existing schema, follow these steps:\n\n1. [Get the schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23get-/api/dataentities/-dataEntityName-/schemas/-schemaName-) associated with the data entity you wish to add a trigger to.\n2. Copy the JSON schema from the response and create a new object in the `v-triggers` array, configuring its properties according to your desired behavior. See the [Trigger properties](#trigger-properties) and [Example](#trigger-example) sections for more information.\n3. Send the edited schema as the body to the [Save schema by name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23put-/api/dataentities/-dataEntityName-/schemas/-schemaName-) endpoint.\n\n> To edit Master Data v2 triggers, follow the steps described above, editing the properties you wish instead of creating a new array item.\n\n### Trigger Properties\n\n| Property | Type | Description |\n| --------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| name | string | Trigger name, limited to 100 characters. Don't use blank spaces; only underscores (\\_) or dashes (\\-) are allowed. |\n| active | boolean | Defines whether the trigger is enabled (true) or disabled (false). |\n| condition | string | A rule that validates the document before executing the trigger. See the [condition](#condition) section for more information. |\n| runAt | object | The scheduled date to execute the action. See the [runAt](#runat) section for more information. |\n| weight | integer | Percentage value used for A/B testing. See the [Setting up an A/B test with Master Data trigger](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/setting-up-a-b-test--4xFzBMHYty6gmEosWGWMC0) article for more information. |\n| retry | object | Defines the retry policy, specifying the number of attempts and delay between them. See the [retry](#retry) section for more information. |\n| action | object | The action that will be executed. See the [action](#action) section for more information. |\n\n#### Condition\n\nSetting up condition rules is very similar to using query parameters when making a call to Master Data API v2's [Search documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23get-/api/dataentities/-dataEntityName-/search). However, differently from the API, you should not include `_where` in the `condition` string. Examples: `status=ready-for-handling`, `createdIn between 2001-01-01 AND 2016-01-01`, `email=my@email.com`.\n\nYou can create conditions based on any value of any field, including nested fields up to the second level, as exemplified below.\n\n`1\n\n \"condition\": \"Body.ChildOne.ChildTwo=Foo\", \n\n`\n\nTo get further information, check the [Search documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23get-/api/dataentities/-dataEntityName-/search) endpoint reference.\n\n#### runAt\n\nTo schedule an action in the future, use the `runAt` object, with the `dateTime` and `increment` properties.\n\nSet the `dateTime` string according to your specific need:\n\n* To consider the date and time of the trigger as the start date, use `now` as the value.\n* To consider the date and time of a specific field, use `{!fieldName}` as the value. E.g. `{!createdIn}`\n\nUse one of the following `increment` object properties (integers) according to the time unit to be used:\n\n* Minutes: `addMinutes`\n* Hours: `addHours`\n* Days: `addDays`\n* Months: `addMonths`\n* Years: `addYears`\n\nSee examples below:\n\n* Schedule the execution 10 minutes later.\n\n`1\n\n { \n\n2\n\n \"dateTime\": \"now\", \n\n3\n\n \"increment\": { \n\n4\n\n \"addMinutes\": 10 \n\n5\n\n } \n\n6\n\n } \n\n`\n\n* Schedule the execution six months after the field value `createdIn`.\n\n`1\n\n { \n\n2\n\n \"dateTime\": \"{!createdIn}\", \n\n3\n\n \"increment\": { \n\n4\n\n \"addMonths\": 6 \n\n5\n\n } \n\n6\n\n } \n\n`\n\n#### Retry\n\nBy default, VTEX Master Data makes three attempts in an interval of 10 minutes. Use this property to override such behavior. See the example below of five attempts in an interval of 30 minutes.\n\n`1\n\n { \n\n2\n\n \"times\": 5, \n\n3\n\n \"delay\": { \n\n4\n\n \"addMinutes\": 30 \n\n5\n\n } \n\n6\n\n } \n\n`\n\n#### Action\n\nDefine the action to be executed, which can be one of the following types:\n\nCall an HTTP request\n\n`1\n\n { \n\n2\n\n \"type\": \"http\", \n\n3\n\n \"uri\": \"http://mydomain.com/api/test\", \n\n4\n\n \"method\": \"POST\", \n\n5\n\n \"headers\": { \n\n6\n\n \"content-type\": \"application/json\" \n\n7\n\n }, \n\n8\n\n \"body\": { \n\n9\n\n \"id\": \"{!id}\", \n\n10\n\n \"test\": \"TestValue\", \n\n11\n\n \"count\": 25 \n\n12\n\n } \n\n13\n\n } \n\n`\n\nSend an email\n\n`1\n\n{ \n\n2\n\n \"type\": \"email\", \n\n3\n\n \"provider\": \"default\", \n\n4\n\n \"subject\": \"My email with VTEX Master Data\", \n\n5\n\n \"to\": [ \n\n6\n\n \"{!email}\", \n\n7\n\n \"test@email.com\" \n\n8\n\n ], \n\n9\n\n \"bcc\": [ \n\n10\n\n \"myemail@test.com\" \n\n11\n\n ], \n\n12\n\n \"replyTo\": \"noreply@company.com\", \n\n13\n\n \"body\": \"My email with document {!id}.\" \n\n14\n\n} \n\n`\n\nSend an email action using a [Message Center](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/understanding-the-message-center--tutorials%5F84) template.\n\n`1\n\n { \n\n2\n\n \"type\": \"t-email\", \n\n3\n\n \"template\": \"template-name\", \n\n4\n\n \"provider\": \"default\", \n\n5\n\n \"subject\": \"My template email with VTEX Master Data\", \n\n6\n\n \"to\": [ \n\n7\n\n \"{!email}\", \n\n8\n\n \"test@email.com\" \n\n9\n\n ], \n\n10\n\n \"bcc\": [ \n\n11\n\n \"myemail@test.com\" \n\n12\n\n ], \n\n13\n\n \"replyTo\": \"noreply@company.com\", \n\n14\n\n \"body\": { \n\n15\n\n \"firstName\": \"{firstName}\", \n\n16\n\n \"email\": \"{email}\", \n\n17\n\n \"id\": \"{!id}\", \n\n18\n\n \"clientName\": \"{!clientProfileData.firstName} {!clientProfileData.lastName}\", \n\n19\n\n \"ownerListName\": \"{!customData.customApps[0].fields.ownerListName}\", \n\n20\n\n \"ownerListEmail\": \"{!customData.customApps[0].fields.ownerListEmail}\", \n\n21\n\n \"items\": \"{!items}\", \n\n22\n\n \"openTextField\": \"{!openTextField.value}\" \n\n23\n\n } \n\n24\n\n } \n\n`\n\nSave a document to another data entity.\n\n`1\n\n { \n\n2\n\n \"type\": \"save\", \n\n3\n\n \"dataEntity\": \"copy\", \n\n4\n\n \"json\": { \n\n5\n\n \"id\": \"{!id}\", \n\n6\n\n \"message\": \"{!message}\", \n\n7\n\n \"custom\": \"created/updated by VTEX Master Data triggers\" \n\n8\n\n } \n\n9\n\n } \n\n`\n\n### Trigger example\n\n`1\n\n{ \n\n2\n\n \"properties\": {}, \n\n3\n\n \"v-triggers\": [ \n\n4\n\n { \n\n5\n\n \"name\": \"copy-document\", \n\n6\n\n \"active\": true, \n\n7\n\n \"condition\": \"status=window-to-cancel\", \n\n8\n\n \"action\": { \n\n9\n\n \"type\": \"save\", \n\n10\n\n \"dataEntity\": \"copy\", \n\n11\n\n \"json\": { \n\n12\n\n \"id\": \"{!id}\", \n\n13\n\n \"message\": \"{!message}\", \n\n14\n\n \"custom\": \"created/updated by VTEX triggers\" \n\n15\n\n } \n\n16\n\n }, \n\n17\n\n \"retry\": { \n\n18\n\n \"times\": 5, \n\n19\n\n \"delay\": { \n\n20\n\n \"addMinutes\": 30 \n\n21\n\n } \n\n22\n\n } \n\n23\n\n } \n\n24\n\n ] \n\n25\n\n} \n\n`\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/master-data-v2/triggers/setting-up-triggers-on-master-data-v2.md)\n\n[Working with JSON Schemas in Master Data v2« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2//docs/guides/working-with-json-schemas-in-master-data-v2)[A/B testing Master Data v2 trigger actionsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2//docs/guides/trigger-ab-test)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/setting-up-triggers-on-master-data-v2%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/setting-up-triggers-on-master-data-v2%23instructions)\n\n[Trigger Properties](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/setting-up-triggers-on-master-data-v2%23trigger-properties)[Trigger example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/setting-up-triggers-on-master-data-v2%23trigger-example)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/master-data-v2/triggers/setting-up-triggers-on-master-data-v2.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/setting-up-triggers-on-master-data-v2%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/setting-up-triggers-on-master-data-v2%23instructions)\n\n[Trigger Properties](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/setting-up-triggers-on-master-data-v2%23trigger-properties)[Trigger example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/setting-up-triggers-on-master-data-v2%23trigger-example)\n\nOn this page\n\n[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=)"
}
] |
doc_493b08af
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides change seller in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n[Feed v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/orders-feed)\n\n[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/order-modifications)\n\n[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/change-seller)\n\n[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/order-canceling-improvements)\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/actions-orders)\n\nSubscriptions\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n[Feed v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/orders-feed)\n\n[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/order-modifications)\n\n[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/change-seller)\n\n[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/order-canceling-improvements)\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/actions-orders)\n\nSubscriptions\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides)\n\nOrders\n\n[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/change-seller)\n\nChange seller\n\nMarketplaces have the autonomy to change a seller that has been designated to fulfill an order. This can only be done under specific circumstances described in this [article on the Change seller feature](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-to-use-the-change-seller--5TBAwO2kOAMw44uyaaQMQO%23).\n\nThere are a few different APIs that can be useful to execute a seller change. Here we will see which are they and how to use them to perform this task.\n\n> Make sure you are aware of the limitations for using this, as described in this [article on the Change Seller feature](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/como-utilizar-change-seller--5TBAwO2kOAMw44uyaaQMQO%23). Also, note that this can only be done while the order's status is `window-to-change-seller`, `payment-pending` or `waiting-for-authorization` as seen on the API.\n\n## Seller listing\n\nIn the case of a seller change, the marketplace is responsible for choosing the new seller. VTEX does not have any automated system to make this choice, but we do suggest you use the [Get seller list API request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis%23get-/seller-register/pvt/sellers) to see the list of sellers associated with your marketplace. It is also possible to filter sellers returned by this call using query params.\n\n## Cart simulation\n\nWith the information of the sellers in hand, you can simulate carts to check the availability of the products. To do this, you may use our [Fulfillment simulation endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForms/simulation).\n\n## Window to change seller\n\nWhen a seller cancels an order, the marketplace has a limited period of time to choose a new seller to fulfill that order. This period of time is the window to change seller, and the default is of two days.\n\nThis value can be checked using the [Get window to change seller request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/checkout/pvt/configuration/window-to-change-seller) and configured with the [Update window to change seller endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/checkout/pvt/configuration/window-to-change-seller).\n\n## Change seller\n\nOnce you have all the information you need and are ready to actually change the seller responsible for shipping a given order, you can make a `PUT` call to this endpoint:`{marketplace_host}/api/checkout/pvt/orders/{marketplace_order_id}/sellers`\n\nThis is an example of what the body of this request should look like:\n\n`1\n\n{ \n\n2\n\n \"marketplacePaymentValue\": 1000, \n\n3\n\n \"newSellerId\":\"{id_do_seller_no_mkt}\", \n\n4\n\n \"shippingData\": \n\n5\n\n { \n\n6\n\n \"logisticsInfo\": \n\n7\n\n [ \n\n8\n\n { \n\n9\n\n \"itemIndex\": 0, \n\n10\n\n \"selectedSla\": \"PAC\", \n\n11\n\n \"selectedDeliveryChannel\": \"delivery\" \n\n12\n\n } \n\n13\n\n ] \n\n14\n\n } \n\n15\n\n} \n\n`\n\n> When a change of seller is successfully completed, the marketplace order loses courier information, since the array in `shippingData.logisticsInfo.deliveryIds` is now empty. In order to get the updated information, it is necessary to make a [Get order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/oms/pvt/orders/-orderId-) request to the new seller's endpoint, such as `https://{newSeller}.{environment}.com.br/api/oms/pvt/orders/{orderId}`.\n\nContributors\n\n2\n\n[](https://github.com/Isabella-Veloso)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/erp-integration-guide/change-seller.md)\n\n[Order modifications« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller//docs/guides/order-modifications)[Cancel orderNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller//docs/guides/order-canceling-improvements)\n\nContributors\n\n2\n\n[](https://github.com/Isabella-Veloso)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Seller listing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/change-seller%23seller-listing)\n\n[Cart simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/change-seller%23cart-simulation)\n\n[Window to change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/change-seller%23window-to-change-seller)\n\n[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/change-seller%23change-seller)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/erp-integration-guide/change-seller.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Seller listing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/change-seller%23seller-listing)\n\n[Cart simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/change-seller%23cart-simulation)\n\n[Window to change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/change-seller%23window-to-change-seller)\n\n[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller/docs/guides/change-seller%23change-seller)\n\nOn this page\n\n[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=)"
}
] |
doc_3e3594ec
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Explain the VTEX api reference pricing api API and how to use it."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/pricing-api/)\n\nPrices and Fixed Prices \n\nPricing Configuration\n\nPrice Tables\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/pricing-api/)\n\nPrices and Fixed Prices \n\nPricing Configuration\n\nPrice Tables\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[DeDelete Policy by ID« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/policies-system-api%23delete-/api/policy-engine/policies/-id-)[GeGet PriceNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api/docs/api-reference/pricing-api%23get-/pricing/prices/-itemId-)\n\n[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=)"
}
] |
doc_1fb852d2
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX store components productimages app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/troubleshooting)\n\n[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.store-components/ProductImages/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/vtex-io-apps)\n\nProduct Images\n\n[vtex.store-components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components)\n\nVersion: 3.178.5\n\nLatest version: 3.178.5\n\nThe `product-images` block renders an image or video configured in the SKU settings. To learn which media formats are supported, see the [Media](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/media-overview--31fhjHTt4TBoo50AmGQ9b2) section in the [Adding or editing SKUs](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/adding-or-editing-skus--4ryZ6J45kwn3jDiQBxGiiN) guide.\n\n\n\n## Configuration\n\n1. Import the `vtex.store-components` app to your theme dependencies in the `manifest.json` file, as in the following example:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.store-components\": \"3.x\" \n\n3\n\n } \n\n`\n\n1. Add the `product-images` block to any child of the `store.product` template (Product Details Page template). For example:\n\n`1\n\n \"store.product\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"flex-layout.row#product\", \n\n4\n\n ] \n\n5\n\n }, \n\n6\n\n \"flex-layout.row#product\": { \n\n7\n\n \"children\": [ \n\n8\n\n+ \"product-images\" \n\n9\n\n ] \n\n10\n\n }, \n\n`\n\n1. Declare the `product-images` block using the props stated in the [Props](#props) table. Example:\n\n`1\n\n \"product-images\": { \n\n2\n\n \"props\": { \n\n3\n\n \"displayThumbnailsArrows\": true \n\n4\n\n } \n\n5\n\n }, \n\n`\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| ----------------------- | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |\n| aspectRatio | string | Sets the image aspect ratio, determining whether it should be square, portrait, landscape, etc. Follow the [common aspect ratio notation](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/Aspect%5Fratio%5F%28image%29), represented by two numbers separated by a colon, such as 1:1 for square, 3:4 for portrait, or 1920:1080 for widescreen. | \"auto\" |\n| blockClass | string | Serves as the block's unique identifier for customization. | |\n| contentOrder | 'videos-first' \\| 'images-first' | Controls the order in which the images and videos are displayed. | 'images-first' |\n| contentType | enum | Controls the type of content that will be displayed in the block. Possible values are images, videos, or all. | all |\n| displayMode | enum | Defines how the product media should be displayed. Possible values are carousel (displays the product images and videos in a carousel), list (displays only the product images inline, with no extra markup), and first-image (displays only the first image available). **The list and first-image values don't display product videos and are only compatible with the maxHeight, hiddenImages, zoomFactor, aspectRatio,ModalZoomElement, and zoomMode props**. | carousel |\n| displayThumbnailsArrows | boolean | Displays navigation arrows on the thumbnail media (if there are enough thumbnails for them to scroll). | false |\n| hiddenImages | string | Hides images with labels that match the values listed in this prop. Intended to be used with the product-summary-sku-selector block. To learn more, see the [SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/skuselector) documentation. | skuvariation |\n| maxHeight | number | Maximum height for individual product images (in pixels). | 600 |\n| ModalZoom | block | Opens a modal to zoom in on the product image. This prop value must match the name of the block that triggers the modal containing the product image for zooming (for example, modal-layout from [Modal layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/apps/vtex.modal-layout) app). The ModalZoom prop will only work if the zoomMode prop is set as open-modal. To learn more, see the [Advanced configuration section](#Advanced-configuration). | undefined |\n| placeholder | string | Sets the URL for a placeholder image to be displayed when no product image or video is available. | undefined |\n| position | enum | Sets the position of the thumbnails (left or right). Only used when thumbnailsOrientation is vertical. | left |\n| showNavigationArrows | boolean | Defines if the navigation arrows should be displayed. | true |\n| showPaginationDots | boolean | Defines if the pagination dots should be displayed. | |\n| showImageLabel | boolean | Controls if the image label text should be rendered above each image. | true |\n| thumbnailVisibility | visible or hidden | Defines if the thumbnails should be displayed in carousel displayMode. | visible |\n| thumbnailAspectRatio | string | Sets the aspect ratio of the thumbnail image. For more information about aspect ratio, check out the aspectRatio prop. | \"auto\" |\n| thumbnailMaxHeight | number | Maximum height of the thumbnail image (in pixels). | 150 |\n| thumbnailsOrientation | enum | Sets the orientation of the thumbnails. It can be vertical or horizontal. | vertical |\n| zoomFactor | number | Sets how much the zoom increases the image size (for example, 2 will make the zoomed-in image twice as large). | 2 |\n| zoomMode | enum | Sets the image zoom behavior. Possible values are disabled (zoom is disabled), in-place-click (zoom is triggered when the image is clicked), in-place-hover (zoom is triggered when the image is hovered on), and open-modal (image is zoomed using a modal). | in-place-click |\n\n### Advanced configuration\n\nIn this section, you’ll learn how to use modal zoom, a property that allows you to open a popup displaying a product image for zooming. To use this feature, configure the `product-images` block by setting the `zoomMode` and `ModalZoom` props to `open-modal` and `modal-layout`, respectively.\n\nWhen configured as explained, the `zoomMode` prop allows the image to trigger a modal for zooming. Additionally, the `MozalZoom` prop will render the block defined as its value. In this case, the `modal-layout` is required. This allows you to configure a modal containing the product image for zooming.\n\nOnce both props are correctly configured, you must declare the `modal-layout` block and the `product-images.high-quality-image` block as its child.\n\nThe `modal-layout` block renders the modal component and triggers the image zoom in a popup box. The `product-images.high-quality-image` block, in turn, is a _special_ block used exclusively to render the `product-image` block inside the modal.\n\nExample:\n\n`1\n\n{ \n\n2\n\n \"product-images.high-quality-image\": { \n\n3\n\n \"props\": { \n\n4\n\n \"zoomMode\": \"in-place-click\", \n\n5\n\n \"zoomFactor\": 2 \n\n6\n\n } \n\n7\n\n }, \n\n8\n\n \"modal-layout#product-zoom\": { \n\n9\n\n \"children\": [ \n\n10\n\n // you can put any other block inside the modal, \n\n11\n\n // this is just a normal modal \n\n12\n\n \"flex-layout.row#product-name\", \n\n13\n\n \"product-images.high-quality-image\" \n\n14\n\n ] \n\n15\n\n }, \n\n16\n\n \"product-images\": { \n\n17\n\n \"props\": { \n\n18\n\n \"ModalZoom\": \"modal-layout#product-zoom\", \n\n19\n\n // to use the ModalZoom, the product-images zoomMode value must be set as open-modal \n\n20\n\n \"zoomMode\": \"open-modal\", \n\n21\n\n \"aspectRatio\": { \n\n22\n\n \"desktop\": \"auto\", \n\n23\n\n \"phone\": \"16:9\" \n\n24\n\n } \n\n25\n\n } \n\n26\n\n } \n\n27\n\n} \n\n`\n\nThe `product-images.high-quality-image` block must be declared as a child of `modal-layout`. You can also declare other blocks exported by the [Modal Layout app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.modal-layout) as children.\n\nThe following table shows the props allowed by `product-images.high-quality-image`:\n\n| Prop name | Type | Description | Default value |\n| ----------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |\n| aspectRatio | string | Sets the image aspect ratio, determining whether it should be square, portrait, landscape, etc. Follow the [common aspect ratio notation](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/Aspect%5Fratio%5F%28image%29), represented by two numbers separated by a colon, such as 1:1 for square, 3:4 for portrait, or 1920:1080 for widescreen. | auto |\n| defaultSize | number | Image default size (in px). | 1200 |\n| imageSizes | \\[number\\] | Image sizes (in px) to be used in the image [srcset HTML attribute](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Learn/HTML/Multimedia%5Fand%5Fembedding/Responsive%5Fimages). If no value is defined for this prop, the srcset will use the original image size. | undefined |\n| maxSize | number | Image maximum size (in px) for rendering, regardless of screen size. This prop only works if you also declare the imageSizes prop. | 4096 |\n| zoomFactor | number | Sets how much the zoom increases the image size (for example, 2 will make the zoomed-in image twice as large). | 2 |\n| zoomMode | enum | Sets the zoom behavior for the product-images.high-quality-image block. Possible values are disabled (no zoom), in-place-click (zoom on click), and in-place-hover (zoom on hover). Unlike the store-images prop, this one doesn’t accept the open-modal value. | disabled |\n\n## Customization\n\nTo apply CSS customizations to this and other blocks, see the guide [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).\n\n| CSS Handles |\n| ---------------------------------------------- |\n| carouselContainer |\n| carouselCursorDefault |\n| carouselGaleryCursor |\n| carouselGaleryThumbs |\n| carouselIconCaretLeft |\n| carouselIconCaretRight |\n| carouselImagePlaceholder |\n| carouselInconCaretRight |\n| carouselThumbBorder |\n| figure |\n| figure--video |\n| highQualityContainer |\n| image |\n| imgZoom |\n| productImagesContainer (content is deprecated) |\n| productImagesContainer--carousel |\n| productImagesContainer--list |\n| productImagesGallerySlide |\n| productImagesGallerySwiperContainer |\n| productImagesThumb |\n| productImagesThumbActive |\n| productImagesThumbCaret |\n| productImagesThumbsSwiperContainer |\n| productImageTag--main |\n| productImageTag--zoon |\n| productImageTag |\n| productImageLabel |\n| productVideo |\n| swiper-pagination |\n| swiperBullet--active |\n| swiperBullet |\n| swiperCaret |\n| swiperCaretNext |\n| swiperCaretPrev |\n| thumbImg |\n| thumbImg--video |\n| video |\n| video |\n| videoContainer |\n\nSee also\n\n[Vtex.store ComponentsVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/apps/vtex.store-components)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/apps/vtex.store-components/ProductImages%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/apps/vtex.store-components/ProductImages%23props)[Advanced configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/apps/vtex.store-components/ProductImages%23advanced-configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/ProductImages/docs/apps/vtex.store-components/ProductImages%23customization)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_4d45f017
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex store components logo in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-logo/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-logo/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-logo/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-logo/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-logo/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-logo/docs/troubleshooting)\n\n[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-store-components-logo/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-logo/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-logo/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-logo/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-logo/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-logo/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-logo/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-logo/updates/release-notes)\n\nLogo\n\nThe `logo` block displays a logo in the store header.\n\n\n\n## Configuration\n\n1. Import the `vtex.store-components` app to your theme's dependencies in the `manifest.json` file as in the following example:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.store-components\": \"3.x\" \n\n3\n\n } \n\n`\n\n1. Add the `logo` block into the [header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-header/) component. For example:\n\n`1\n\n \"header.full\": { \n\n2\n\n \"blocks\": [ \n\n3\n\n \"login\", \n\n4\n\n \"minicart\", \n\n5\n\n+ \"logo\", \n\n6\n\n \"search-bar\", \n\n7\n\n \"menu-link\", \n\n8\n\n \"telemarketing\", \n\n9\n\n \"category-menu\" \n\n10\n\n ] \n\n11\n\n }, \n\n`\n\n1. Then, declare the `logo` block using the props stated in the [Props](#props) table. For example:\n\n`1\n\n \"logo\": { \n\n2\n\n \"props\": { \n\n3\n\n \"width\": 132, \n\n4\n\n \"height\": 32, \n\n5\n\n \"mobileWidth\": 90, \n\n6\n\n \"mobileHeight\": 32 \n\n7\n\n } \n\n8\n\n } \n\n9\n\n} \n\n`\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| --------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |\n| classes | CustomCSSClasses | Overrides default CSS handles. To better understand how this prop works, check [this document](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/css-handles%23usecustomclasses). Note that this is only helpful if you're using this block as a React component. | undefined |\n| color | String | The image fill color. | #F71963 |\n| height | Number | The logo image height. | 177 |\n| href | String | The image hyperlink. | undefined |\n| showLabel | Boolean | The label visibility. | true |\n| title | String! | The image alt description. | VTEX logo |\n| url | String | The image soure URL. | undefined |\n| width | Number | The logo image width. | 493 |\n\n## Customization\n\nTo apply CSS customizations in this and other blocks, follow the [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) guide.\n\n| CSS Handles |\n| ------------- |\n| logoContainer |\n| logoImage |\n| logoLink |\n| sizeDesktop |\n| sizeMobile |\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/store-components/vtex-store-components-logo.md)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-logo/docs/guides/vtex-store-components-logo%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-logo/docs/guides/vtex-store-components-logo%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-logo/docs/guides/vtex-store-components-logo%23customization)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/store-components/vtex-store-components-logo.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-logo/docs/guides/vtex-store-components-logo%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-logo/docs/guides/vtex-store-components-logo%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-logo/docs/guides/vtex-store-components-logo%23customization)\n\nOn this page\n\n[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=)"
}
] |
doc_e8f879c2
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides how to customize vtex sales app in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n[How to customize VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/how-to-customize-vtex-sales-app)\n\n[Change VTEX Sales App language](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/change-vtex-sales-app-language)\n\n[Hide anonymous customer option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/hide-anonymous-customer-option)\n\n[Define payment methods displayed on VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/define-payment-methods-displayed-on-vtex-sales-app)\n\n[Enable the Observation field in the order screen](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/enable-the-remarks-field-in-the-order-screen)\n\n[Enable the sales associate code](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/sales-associate-code)\n\n[Enable cart transfer and capture between devices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/enable-cart-transfer-between-devices)\n\n[Force stock availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/force-stock-availability)\n\n[Add extra text to the order summary print](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/add-extra-text-to-the-order-print)\n\n[Hide Print order and Reprint receipt buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/hide-print-order-and-reprint-receipt-buttons)\n\n[Enable partial cancellation for Debit or Credit Direct sales](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/enable-partial-cancellation)\n\n[Hide cancellation buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/hide-cancellation-buttons)\n\n[Allow manual prices on VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/allow-manual-prices-on-vtex-sales-app)\n\n[Integration VTEX Sales App Local stock sale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/integration-vtex-sales-app-local-stock-sale)\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n[How to customize VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/how-to-customize-vtex-sales-app)\n\n[Change VTEX Sales App language](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/change-vtex-sales-app-language)\n\n[Hide anonymous customer option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/hide-anonymous-customer-option)\n\n[Define payment methods displayed on VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/define-payment-methods-displayed-on-vtex-sales-app)\n\n[Enable the Observation field in the order screen](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/enable-the-remarks-field-in-the-order-screen)\n\n[Enable the sales associate code](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/sales-associate-code)\n\n[Enable cart transfer and capture between devices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/enable-cart-transfer-between-devices)\n\n[Force stock availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/force-stock-availability)\n\n[Add extra text to the order summary print](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/add-extra-text-to-the-order-print)\n\n[Hide Print order and Reprint receipt buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/hide-print-order-and-reprint-receipt-buttons)\n\n[Enable partial cancellation for Debit or Credit Direct sales](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/enable-partial-cancellation)\n\n[Hide cancellation buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/hide-cancellation-buttons)\n\n[Allow manual prices on VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/allow-manual-prices-on-vtex-sales-app)\n\n[Integration VTEX Sales App Local stock sale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/integration-vtex-sales-app-local-stock-sale)\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides)\n\nVTEX Sales App\n\n[How to customize VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/how-to-customize-vtex-sales-app)\n\nHow to customize VTEX Sales App\n\nLearn how to customize the VTEX Sales App.\n\n[VTEX Sales App](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-sales-app-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc) is VTEX's main product for Unified Commerce operations. It’s an app that enables your store to provide a true omnichannel experience, seamlessly integrating your online and physical channels, and placing your customers at the core of the business.\n\nYou can customize the VTEX Sales App experience according to your business needs by editing custom [JavaScript](#javascript-customizations) and [CSS](#css-customizations) files.\n\n## JavaScript customizations\n\nYou can perform JavaScript customizations on the `checkout-instore-custom.js` file, which you must access from the VTEX Admin homepage, following the steps below.\n\n1. Access `https://{{AccountName}}.myvtex.com/admin` and follow the steps below. Remember to replace `{{AccountName}}` with your VTEX account name.\n2. In the main menu, click on **Checkout**.\n3. Click on the store's gear icon, as shown in the image below. \n\n4. Click on the **Code** tab and then click on the `checkout-instore-custom.js` file, which is in the **Files** list on the right side of the screen, as illustrated in the image below. \n\n\n> ️ If you want to access the `checkout-instore-custom.js` file directly, you can enter the following URL in your browser: `https://{{AccountName}}.myvtex.com/admin/portal#/sites/default/code/files/checkout-instore-custom.js`. Make sure you replace `{{AccountName}}` with your VTEX account name.\n\n### Edit the JavaScript file\n\n`checkout-instore-custom.js` is a JavaScript file that accepts a number of functions, variables and objects responsible for changing standard behaviors of the VTEX Sales App application.\n\nTo make any changes to the file, simply add or modify the lines of code directly in the file edit box. Check out our list of possible customizations to learn more.\n\nOnce you are done, click on the `Save` button, as shown in the image below.\n\n\n\n> Always follow the customization instructions in this documentation and only make changes as indicated here, otherwise, VTEX Sales App may not work as expected.\n\n## CSS customizations\n\nFor CSS customizations, you need to edit the `checkout-instore-custom.css` file, which you can access by following the same steps as to open the [JavaScript customizations](#javascript-customizations) file. In the **Files** section, remember to open `checkout-instore-custom.css` instead.\n\n\n\nLikewise, you can modify the CSS stylesheet directly in the edit box. \n\nWhen you have finished, make sure you click the `Save` button.\n\n## List of customizations\n\nYou can make the following customizations on VTEX Sales App:\n\n* [Change VTEX Sales App language](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/change-vtex-sales-app-language)\n* [Hide anonymous customer option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option)\n* [Define payment methods displayed on VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app)\n* [Enable the Observation field in the order screen](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/enable-the-remarks-field-in-the-order-screen)\n* [Enable the sales associate code](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/sales-associate-code)\n* [Enable cart transfer and capture between devices](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/enable-cart-transfer-between-devices)\n* [Force stock availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/force-stock-availability)\n* [Add extra text to the order summary print](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-extra-text-to-the-order-print)\n* [Hide Print order and Reprint receipt buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-print-order-and-reprint-receipt-buttons)\n* [Enable partial cancellation for Debit or Credit Direct sales](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-partial-cancellation)\n* [Hide cancellation buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-cancellation-buttons)\n* [Allow manual prices on VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/allow-manual-prices-on-vtex-sales-app)\n* [Integration VTEX Sales App Local stock sale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale)\n\nYou can find more information on how to set up each customization in the following guides.\n\nContributors\n\n2\n\n[](https://github.com/Isabella-Veloso)\n\n[](https://github.com/karenkrieger)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX-Sales-App/how-to-customize-vtex-sales-app.md)\n\n[Enabling an access control list ACL in B2B Suite« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app//docs/guides/enabling-an-access-control-list-acl-in-b2b-suite)[Change VTEX Sales App languageNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app//docs/guides/change-vtex-sales-app-language)\n\nContributors\n\n2\n\n[](https://github.com/Isabella-Veloso)\n\n[](https://github.com/karenkrieger)\n\nON THIS PAGE\n\n[JavaScript customizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/how-to-customize-vtex-sales-app%23javascript-customizations)\n\n[Edit the JavaScript file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/how-to-customize-vtex-sales-app%23edit-the-javascript-file)\n\n[CSS customizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/how-to-customize-vtex-sales-app%23css-customizations)\n\n[List of customizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/how-to-customize-vtex-sales-app%23list-of-customizations)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX-Sales-App/how-to-customize-vtex-sales-app.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[JavaScript customizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/how-to-customize-vtex-sales-app%23javascript-customizations)\n\n[Edit the JavaScript file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/how-to-customize-vtex-sales-app%23edit-the-javascript-file)\n\n[CSS customizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/how-to-customize-vtex-sales-app%23css-customizations)\n\n[List of customizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-customize-vtex-sales-app/docs/guides/how-to-customize-vtex-sales-app%23list-of-customizations)\n\nOn this page\n\n[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=)"
}
] |
doc_f38aefa3
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Explain the VTEX api reference catalog api seller portal API and how to use it."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/catalog-api-seller-portal/)\n\nProduct\n\nSKU\n\nBrand\n\nCategory\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/catalog-api-seller-portal/)\n\nProduct\n\nSKU\n\nBrand\n\nCategory\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[GeGet card token import report« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/card-token-vault-api%23get-/api/card-token-vault/tokens/import/-importId-/report)[GeGet Product by IDNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal/docs/api-reference/catalog-api-seller-portal%23get-/api/catalog-seller-portal/products/-productId-)\n\n[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=)"
}
] |
doc_354837ec
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX store components 3.178.5 BuyButton app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/troubleshooting)\n\n[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.store-components@3.178.5/BuyButton/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/vtex-io-apps)\n\nBuy Button\n\n[vtex.store-components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components)\n\nVersion: 3.178.5\n\nLatest version: 3.178.5\n\n> Warning\n> \n> **The Buy Button block has been deprecated in favor of the [Add To Cart Button app](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-add-to-cart-button/).** Although support for this block is still granted, we strongly recommend you to update your store theme with the Add to Cart Button's blocks in order to keep up with the component's evolution.\n\n\n\nThe `buy-button` block displays a button that allows users to add products in the [Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-minicart) (`minicart.v1`).\n\n> Warning\n> \n> **The Buy Button block only works for stores using the Minicart v1**. If your store uses the Minicart v2, please refer to the [Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-add-to-cart-button) instead.\n\n\n\n## Configuration\n\n1. Import the `vtex.store-components` app to your theme's dependencies in the `manifest.json` file as in the following example:\n\n`1\n\n \"dependencies\": { \n\n2\n\n+ \"vtex.store-components\": \"3.x\" \n\n3\n\n } \n\n`\n\n1. Add the `buy-button` to other theme block using the product context, such as the `product-summary.shelf`. In the following example, the `buy-button` component was added to the `flex-layout.row` block from the `store.product` template (which uses the product context):\n\n`1\n\n \"store.product\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"flex-layout.row#product\", \n\n4\n\n ] \n\n5\n\n }, \n\n6\n\n \"flex-layout.row#product\": { \n\n7\n\n \"children\": [ \n\n8\n\n+ \"buy-button#product\" \n\n9\n\n ] \n\n10\n\n }, \n\n`\n\n1. Then, declare the `buy-button` block using the props stated in the [Props](#props) table. For example:\n\n`1\n\n \"buy-button#product\": { \n\n2\n\n \"props\": { \n\n3\n\n \"isOneClickBuy\": true, \n\n4\n\n \"showTooltipOnSkuNotSelected\": false \n\n5\n\n } \n\n6\n\n }, \n\n`\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| --------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------- | ---------------- |\n| available | boolean | Whether the Buy Button block is available for using (true) or not (false). | true |\n| customToastURL | string | Defines the link to where users will be redirected when the Buy Button is clicked on and the isOneClickBuy prop is set to true. | /checkout/#/cart |\n| isOneClickBuy | boolean | Whether the user should be redirected to the checkout page (true) or not (false) when the Add To Cart Button is clicked on. | false |\n| large | boolean | Whether the Buy Button should fill its whole width (true) or not (false). | false |\n| shouldOpenMinicart | boolean | Whether the Minicart should be opened when the Buy Button is clicked on (true) or not (false). | false |\n| shouldAddToCart | boolean | Whether the Buy Button should add products to the minicart when clicked on (true) or not (false). | true |\n| showItemsPrice | boolean | Whether the total price of items added to the cart should be displayed (true) or not (false). | false |\n| showToast | boolean | Whether a Toast (pop-up notification) should be displayed when adding an item to the minicart (true) or not (false) | false |\n| showTooltipOnSkuNotSelected | boolean | Whether a tooltip should be displayed when the Buy Button is clicked on with no SKU was selected (true) or not (false). | true |\n\n## Customization\n\nTo apply CSS customizations in this and other blocks, follow the [Using CSS handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization) guide.\n\n| CSS Handles |\n| ------------------- |\n| buttonDataContainer |\n| buttonItemsPrice |\n| buyButtonText |\n\nSee also\n\n[Vtex.store ComponentsVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/apps/vtex.store-components)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/apps/vtex.store-components@3.178.5/BuyButton%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/apps/vtex.store-components@3.178.5/BuyButton%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/BuyButton/docs/apps/vtex.store-components@3.178.5/BuyButton%23customization)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_71a9ccf2
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore storefront features implementing live shopping for faststore in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-overview)\n\n[Adding third-party scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-handling-third-party-scripts)\n\n[Building navigation menus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-building-navigation-menus)\n\n[Displaying content for authenticated users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users)\n\n[Implementing regionalization features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-implementing-regionalization-features)\n\n[Implementing search features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-implementing-search-features)\n\n[Managing product images in specific contexts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-managing-product-images-in-specific-contexts)\n\n[Implementing Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/delivery-promise-implementation)\n\n[Implementing Live Shopping for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore)\n\n[Implementing Live Shopping for FastStore previous versions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-overview)\n\n[Adding third-party scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-handling-third-party-scripts)\n\n[Building navigation menus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-building-navigation-menus)\n\n[Displaying content for authenticated users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users)\n\n[Implementing regionalization features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-implementing-regionalization-features)\n\n[Implementing search features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-implementing-search-features)\n\n[Managing product images in specific contexts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-managing-product-images-in-specific-contexts)\n\n[Implementing Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/delivery-promise-implementation)\n\n[Implementing Live Shopping for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore)\n\n[Implementing Live Shopping for FastStore previous versions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-overview)\n\nImplementing Live Shopping for FastStore\n\n> This is an experimental feature.\n\n**Live Shopping for FastStore** is a solution to add a customizable player to your storefront to transmit [Live Shopping](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-live-shopping-getting-started--3eCHNCIx8XhZOSmX0sQT3U) events. Once you've implemented the feature, you will be able to [configure and manage](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-live-shopping-getting-started--3eCHNCIx8XhZOSmX0sQT3U/125yr6jAfwiiz84JP4ppfO) the event transmission through the VTEX Admin.\n\nThis guide explains how to integrate **Live Shopping** into a project using [FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore).\n\n> This feature is available as a native solution for the latest version of FastStore. If your storefront technology is [FastStore v1 or v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels), see the guide [Implementing Live Shopping for FastStore previous versions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions).\n\n## Before you begin\n\nBefore implementing **Live Shopping for FastStore**, make sure you have onboarded your FastStore project through [WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project).\n\n## Live Shopping app\n\nThe first step is to get the **Live Shopping** app by following the steps below:\n\n1. Access [VTEX Live Shopping](https://read.calvincode.net/reader?url=https://apps.vtex.com/vtexventures-livestreaming/p) on VTEX App Store. You can also access it via the VTEX Admin by going to **Apps > App Store > VTEX Live Shopping**.\n2. Click `Get app` to install the app. Log in to your VTEX account if necessary.\n3. Click `Place order`.\n4. Click `Go to install page`.\n5. Click `Install`.\n6. Agree to the Terms of Service by clicking `Install`.\n\n## Installation\n\nOnce you have the app on your store project, install the **Live Shopping** plugin package and its dependencies by running the following command:\n\n`1\n\nyarn add @vtex/faststore-plugin-live-shopping object-hash@3.0.0 p-queue@8.1.0 \n\n`\n\n## Configuration\n\nNext, add the plugin reference below to your `discovery.config.js` file:\n\n`1\n\n plugins: [\"@vtex/faststore-plugin-live-shopping\"] \n\n`\n\n## CMS sections sync\n\nOnce you've added the plugin, synchronize your CMS sections with the following command:\n\n`1\n\nyarn faststore cms-sync \n\n`\n\nYou will be able to add the **Live Shopping** section to the store's CMS:\n\n\n\n> For information about customizing the **Live Shopping** player, see [Live Shopping: Events](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/live-shopping-events--6aGLiqoKG1UoS30f3FFWch%23customizing-the-live-shopping-video-player).\n\n## First Live Shopping event\n\nThe first step is [creating an event](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-live-shopping-getting-started--3eCHNCIx8XhZOSmX0sQT3U/5WLXGbOSFmxN7QlzOnfGrv) in the VTEX Admin. After that, you will need to place the component to start the event and delete the component to end the event. Learn more:\n\n* **Start the event:** [Place the component](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-live-shopping-getting-started--3eCHNCIx8XhZOSmX0sQT3U/4r5uk6XHxdYlOGMr11GFWR) to show the player on the storefront.\n* **End the event:** [Delete the component](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-live-shopping-getting-started--3eCHNCIx8XhZOSmX0sQT3U/7e3bP6LjFgxXC210jSpl59) to remove the player.\n\n> For information about transmitting a **Live Shopping** event, check [VTEX Live Shopping - Getting started](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-live-shopping-getting-started--3eCHNCIx8XhZOSmX0sQT3U/17HV0OAaCIB46tW9O1rVEJ).\n\nContributors\n\n3\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/GeorgeLimaDev)\n\n[](https://github.com/Isabella-Veloso)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/storefront-features/implementing-live-shopping-for-faststore.mdx)\n\n[Working with Delivery Promise components« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/delivery-promise-components)[Implementing Live Shopping for FastStore previous versionsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions)\n\nContributors\n\n3\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/GeorgeLimaDev)\n\n[](https://github.com/Isabella-Veloso)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore%23before-you-begin)\n\n[Live Shopping app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore%23live-shopping-app)\n\n[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore%23installation)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore%23configuration)\n\n[CMS sections sync](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore%23cms-sections-sync)\n\n[First Live Shopping event](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore%23first-live-shopping-event)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/storefront-features/implementing-live-shopping-for-faststore.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore%23before-you-begin)\n\n[Live Shopping app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore%23live-shopping-app)\n\n[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore%23installation)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore%23configuration)\n\n[CMS sections sync](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore%23cms-sections-sync)\n\n[First Live Shopping event](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore%23first-live-shopping-event)\n\nOn this page\n\n[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=)"
}
] |
doc_edf1fd2e
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides session data available from vtex apps in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/session-manager)\n\n[Session data aggregation: create and transform calls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/session-data-aggregation-create-and-transform-calls)\n\n[Session data available from VTEX apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/session-data-available-from-vtex-apps)\n\n[Adding telesales impersonated email using the Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/adding-telesales-impersonated-email-using-the-session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/session-manager)\n\n[Session data aggregation: create and transform calls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/session-data-aggregation-create-and-transform-calls)\n\n[Session data available from VTEX apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/session-data-available-from-vtex-apps)\n\n[Adding telesales impersonated email using the Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/adding-telesales-impersonated-email-using-the-session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides)\n\nIntegration Guides\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/session-manager)\n\n[Session data available from VTEX apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/session-data-available-from-vtex-apps)\n\nSession data available from VTEX apps\n\nBelow you can see all data from VTEX apps that is made available in **Session Manager**\n\n## Store (vtex.store-session)\n\n| **RunOnCreate** | true |\n| ------------------------------- | ---------------------------------------------------------------------- |\n| **Inputs** | public: cultureInfo, sc, locale |\n| profile: email, isAuthenticated | |\n| **Outputs** | store: channel, countryCode, cultureInfo, currencyCode, currencySymbol |\n\nThis app is responsible for processing the current user on the session (by email, if available) and requesting the corresponding trade policy and related information.\n\nIt is also sensitive to the `sc` input parameter, which is interpreted as a trade policy request. In other words, if it is present, the app checks if the requested trade policy is within the active options for that user and selects it, if possible. Otherwise, the user gets a 401 status code error if he is not authenticated or 403 if he is.\n\nThe `locale` and `cultureInfo` input parameters are used to overwrite the `cultureInfo` output parameter to ensure the session language can be set according to the user’s preference.\n\n## Authentication (vtex.authentication-session)\n\n| **RunOnCreate** | false |\n| --------------- | ------------------------------------------------------------------------ |\n| **Inputs** | cookie: VtexIdclientAutCookie, VtexIdclientAutCookie\\_.\\* |\n| **Outputs** | authentication: adminUserId, adminUserEmail, storeUserId, storeUserEmail |\n\nThis app is our primary authentication method, taking the VTEXID cookie from the request, validating it, and extracting the user or admin IDs.\n\n## Profile (vtex.profile-session)\n\n| **RunOnCreate** | false |\n| --------------------------- | -------------------------------------------------------------------------------------- |\n| **Inputs** | public: storeUserEmail |\n| authentication: storeUserId | |\n| impersonate: storeUserId | |\n| **Outputs** | profile: id, email, firstName, lastName, phone, document, priceTables, isAuthenticated |\n\nThis app ensures the user information corresponds to the data loaded into the session.\n\nIf the input parameter `storeUserEmail` is defined in the `public` namespace, it assumes there is no authentication cookie. As such, the output parameter `isAuthenticated` is set to `false`, and only the `priceTables` output parameter is loaded. On the other hand, if the input parameter `storeUserId` is defined in the `authentication` or `impersonate` namespace, all relevant information is loaded from Master Data.\n\n## Rates and Benefits (vtex.rnb-session)\n\n| **RunOnCreate** | false |\n| ---------------------------------------------- | -------------- |\n| **Inputs** | profile: email |\n| public: utm\\_source, utm\\_campaign, postalCode | |\n| **Outputs** | rnb: campaigns |\n\nThis app integrates with our Rates and benefits system, identifying which campaigns the user is eligible for.\n\n## Checkout (vtex.checkout-session)\n\n| **RunOnCreate** | false |\n| --------------- | ----------------------------------------------------- |\n| **Inputs** | public: regionId, country, postalCode, geoCoordinates |\n| **Outputs** | checkout: regionId, cartId |\n\nThe checkout app deals with the user's purchasing experience. Currently, it looks the user’s location up (to be a valid input the location must include the country and either `postalCode` or `geoCoordinates`). The output also contains the ID of the cart used during the checkout process.\n\n## Impersonate (vtex.impersonate-session)\n\n| **RunOnCreate** | false |\n| ---------------------------------------- | ----------------------------------------------------------------- |\n| **Inputs** | public: vtex-impersonated-customer-email |\n| cookie: vtex-impersonated-customer-email | |\n| authentication: adminUserEmail | |\n| **Outputs** | impersonate: storeUserId, storeUserEmail, canImpersonate, account |\n\nThe impersonate app is the only app on session’s framework that does not come as part of the default bundle and must be manually installed on each store. It enables the feature of customer impersonation, which is particularly useful for telephone centers that must make purchases on the client’s behalf. It receives the `vtex-impersonated-customer-email` parameter, either through direct `POST` or cookie, and attempts to impersonate that user using the admin credentials in the session. If such a pair has permission for impersonation, then the impersonated user’s ID and email will be loaded into the session.\n\nContributors\n\n1\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/session-manager/session-data-available-from-vtex-apps.md)\n\n[Session data aggregation: create and transform calls« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps//docs/guides/session-data-aggregation-create-and-transform-calls)[Adding telesales impersonated email using the Session ManagerNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps//docs/guides/adding-telesales-impersonated-email-using-the-session-manager)\n\nContributors\n\n1\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Store (vtex.store-session)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/session-data-available-from-vtex-apps%23store-vtexstore-session)\n\n[Authentication (vtex.authentication-session)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/session-data-available-from-vtex-apps%23authentication-vtexauthentication-session)\n\n[Profile (vtex.profile-session)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/session-data-available-from-vtex-apps%23profile-vtexprofile-session)\n\n[Rates and Benefits (vtex.rnb-session)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/session-data-available-from-vtex-apps%23rates-and-benefits-vtexrnb-session)\n\n[Checkout (vtex.checkout-session)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/session-data-available-from-vtex-apps%23checkout-vtexcheckout-session)\n\n[Impersonate (vtex.impersonate-session)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/session-data-available-from-vtex-apps%23impersonate-vteximpersonate-session)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/session-manager/session-data-available-from-vtex-apps.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Store (vtex.store-session)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/session-data-available-from-vtex-apps%23store-vtexstore-session)\n\n[Authentication (vtex.authentication-session)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/session-data-available-from-vtex-apps%23authentication-vtexauthentication-session)\n\n[Profile (vtex.profile-session)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/session-data-available-from-vtex-apps%23profile-vtexprofile-session)\n\n[Rates and Benefits (vtex.rnb-session)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/session-data-available-from-vtex-apps%23rates-and-benefits-vtexrnb-session)\n\n[Checkout (vtex.checkout-session)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/session-data-available-from-vtex-apps%23checkout-vtexcheckout-session)\n\n[Impersonate (vtex.impersonate-session)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/session-data-available-from-vtex-apps/docs/guides/session-data-available-from-vtex-apps%23impersonate-vteximpersonate-session)\n\nOn this page\n\n[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=)"
}
] |
doc_30e47f83
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX product gifts app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[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-gifts/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/troubleshooting)\n\n[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-gifts/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtexventures.livestreaming)\n\n[PayPal Checkout with Smart Payment Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.product-gifts)\n\n[Product Highlight by VTEX Segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtexarg.product-highlight-by-vtex-segment)\n\n[Product Specification Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.reviews-and-ratings)\n\n[Querying personal MasterData Information with SafeData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.shipping-option-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtexventures.livestreaming)\n\n[PayPal Checkout with Smart Payment Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.product-gifts)\n\n[Product Highlight by VTEX Segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtexarg.product-highlight-by-vtex-segment)\n\n[Product Specification Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.reviews-and-ratings)\n\n[Querying personal MasterData Information with SafeData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.shipping-option-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/vtex-io-apps)\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/guides/advanced-components)\n\nProduct Gifts\n\nOfficial extension\n\nVersion: 0.4.0\n\nLatest version: 0.4.0\n\nThe Product Gifts app provides blocks responsible for displaying, in the Product Description block, all gifts available for a given product.\n\n:information\\_source: _A product's gift is configured in a [Buy&Win promotion](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/buy-and-win--tutorials%5F322)_\n\n\n\n## Configuration\n\n1. Add the `product-gifts` app to your theme's dependencies in the `manifest.json`. For example:\n\n`1\n\n\"dependencies\": { \n\n2\n\n \"vtex.product-gifts\": \"0.x\" \n\n3\n\n} \n\n`\n\nNow, you are able to use all blocks exported by the `product-gifts` app. Check out the full list below:\n\n| Block name | Description |\n| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| product-gifts |  Renders a default Product Gifts block implementation. |\n| gift-text |  Reads Catalog data regarding the product's gifts and provides it to its children. |\n| product-gift-list | Renders the available gifts in a list format. It also provides context for its 3 children listed below. |\n| gift-name | Renders the product's gift name. |\n| gift-image | Renders the product's gift image. |\n| gift-description | Renders the gift's description provided by the product-gift-list block. |\n\n1. Add the `product-gifts` block to your `store.product` template:\n\n`1\n\n\"store.product\": { \n\n2\n\n \"children\": [ \n\n3\n\n // (...) \n\n4\n\n \"product-gifts\", \n\n5\n\n ] \n\n6\n\n} \n\n`\n\nWhen added to the `store.product` template but not declared with any children or prop, the Product Gifts block is rendered even so.\n\nFor the rendering, it uses the following block implementation behind the scenes:\n\n`1\n\n{ \n\n2\n\n \"product-gifts\": { \n\n3\n\n \"props\": { \n\n4\n\n \"maxVisibleItems\": { \n\n5\n\n \"desktop\": 2, \n\n6\n\n \"mobile\": 1 \n\n7\n\n } \n\n8\n\n }, \n\n9\n\n \"children\": [\"flex-layout.row#product-gifts-text\", \"product-gift-list\"] \n\n10\n\n }, \n\n11\n\n \n12\n\n \"flex-layout.row#product-gifts-text\": { \n\n13\n\n \"props\": { \n\n14\n\n \"verticalAlign\": \"middle\", \n\n15\n\n \"colSizing\": \"auto\", \n\n16\n\n \"preserveLayoutOnMobile\": true \n\n17\n\n }, \n\n18\n\n \"children\": [ \n\n19\n\n \"rich-text#product-gifts\", \n\n20\n\n \"flex-layout.col#product-gifts-text\" \n\n21\n\n ] \n\n22\n\n }, \n\n23\n\n \"flex-layout.col#product-gifts-text\": { \n\n24\n\n \"children\": [\"gift-text\"], \n\n25\n\n \"props\": { \n\n26\n\n \"verticalAlign\": \"middle\" \n\n27\n\n } \n\n28\n\n }, \n\n29\n\n \"rich-text#product-gifts\": { \n\n30\n\n \"props\": { \n\n31\n\n \"text\": \"**+ GIFT**\" \n\n32\n\n } \n\n33\n\n }, \n\n34\n\n \"gift-text\": { \n\n35\n\n \"props\": { \n\n36\n\n \"text\": \"{exceedingItems, plural, =0{ } one {+ # gift} other {+ # gifts}}\" \n\n37\n\n } \n\n38\n\n }, \n\n39\n\n \"product-gift-list\": { \n\n40\n\n \"children\": [\"flex-layout.row#gift\"] \n\n41\n\n }, \n\n42\n\n \"flex-layout.row#gift\": { \n\n43\n\n \"props\": { \n\n44\n\n \"fullWidth\": true \n\n45\n\n }, \n\n46\n\n \"children\": [\"flex-layout.col#gift-name-description\", \"gift-image\"] \n\n47\n\n }, \n\n48\n\n \"flex-layout.col#gift-name-description\": { \n\n49\n\n \"props\": { \n\n50\n\n \"verticalAlign\": \"middle\", \n\n51\n\n \"rowGap\": 3 \n\n52\n\n }, \n\n53\n\n \"children\": [\"gift-name\", \"gift-description\"] \n\n54\n\n } \n\n55\n\n} \n\n`\n\n### Advanced configuration\n\nIf desired, you can change the Product Gifts default implementation by explicitly declaring the code showed above in your `store.product` template.\n\nAs a result, you will be able to configure the Product Gifts behavior by using all available props for each block:\n\n* **`product-gifts`**\n\n\n\n| Prop name | Type | Description | Default value |\n| --------------- | ------------------- | ------------------------------------------------------ | ------------- |\n| maxVisibleItems | number \\| \"showAll\" | Maximum number of gifts that will be displayed at once | \"showAll\" |\n\n* **`gift-text`**\n\n\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------ |\n| text | String | A translatable string (according to [ICU pattern](https://read.calvincode.net/reader?url=https://formatjs.io/guides/message-syntax/)) that has variables that might be used to render any desired text regarding the gifts. | \"{exceedingItems, plural, =0{ } one {+ # gift} other {+ # gifts}}\" |\n\nYou can configure the string received by the `text` prop using the following variables:\n\n| Variable name | Description |\n| -------------- | -------------------------------------------------------------------------------------------- |\n| exceedingItems | Number of items that were not rendered because of the maxVisibleItems prop of product-gifts. |\n| totalGifts | Total number of gifts available. |\n| visibleItems | Number of items that are being rendered. |\n\n* **`gift-name`**\n\n\n\n| Prop name | Type | Description | Default value |\n| ----------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| linkToProductPage | Boolean | Whether or not the gift-name block should be a link to the gift's product page. | false |\n| nameType | enum | Name type to be displayed alongside the gift. Possible values are: productName (displays the gift's product name) and skuName (displays the gift's SKU name). | skuName |\n\n* **`gift-image`**\n\n\n\n| Prop name | Type | Description | Default value |\n| ---------- | ---------------- | ----------------------------------------------- | ------------- |\n| maxWidth | Number \\| String | Gift image maximum width. | 125 |\n| maxHeight | Number \\| String | Gift image maximum height. | 125 |\n| minWidth | Number \\| String | Gift image minimum width. | 125 |\n| minHeight | Number \\| String | Gift image minimum height. | 125 |\n| imageLabel | String | The label of the image that should be rendered. | undefined |\n\n:information\\_source: _If no image label is defined, the_ `gift-image` _block will use the first available image from the product's SKU._\n\n## Customization\n\nIn order to apply CSS customizations in this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization).\n\nThereafter, you should add a single column table with the available CSS handles for that block:\n\n| CSS Handles |\n| ------------------------ |\n| giftDescription |\n| giftListItem |\n| giftNameLink |\n| giftNameText |\n| productGiftListContainer |\n| productGiftText |\n| productGiftsContainer |\n\n[Product Comparison« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.product-comparison)[Product Highlight by VTEX SegmentNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtexarg.product-highlight-by-vtex-segment)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.product-gifts%23configuration)\n\n[Advanced configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.product-gifts%23advanced-configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-gifts/docs/apps/vtex.product-gifts%23customization)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_381a92d5
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides interactive marchitecture tool in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/vtex-platform-overview)\n\n[Cloud infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/cloud-infrastructure)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/security)\n\n[Data privacy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/data-privacy)\n\n[Composability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/composability)\n\n[VTEX Composable Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/vtex-composable-components)\n\n[Interactive Marchitecture tool](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/interactive-marchitecture-tool)\n\n[Extensibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/extensibility)\n\n[Store architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/store-architecture)\n\n[Developer experience](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/developer-experience)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/vtex-platform-overview)\n\n[Cloud infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/cloud-infrastructure)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/security)\n\n[Data privacy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/data-privacy)\n\n[Composability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/composability)\n\n[VTEX Composable Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/vtex-composable-components)\n\n[Interactive Marchitecture tool](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/interactive-marchitecture-tool)\n\n[Extensibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/extensibility)\n\n[Store architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/store-architecture)\n\n[Developer experience](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/developer-experience)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides)\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/vtex-platform-overview)\n\n[Composability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/composability)\n\n[Interactive Marchitecture tool](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool/docs/guides/interactive-marchitecture-tool)\n\nInteractive Marchitecture tool\n\nLearn how to use the Interactive Marchitecture tool and simulate a composable VTEX store architecture.\n\nThe [Interactive Marchitecture tool](https://read.calvincode.net/reader?url=https://vtex.com/en-us/assets/interactive-architecture/) allows you to simulate the store architecture interactively by choosing which services and add-ons will be used, along with third-party providers for integrations. For reference, see types of architectures for specific scenarios in our [Store architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-architecture) guide.\n\n\n\nWhen you open the [Interactive Marchitecture tool](https://read.calvincode.net/reader?url=https://vtex.com/en-us/assets/interactive-architecture/), you first have to choose the desired region to plan the store architecture. The region selection defines the available partners for third-party integrations.\n\nThe tool displays all the services, add-ons, and integrations described in the [VTEX Composable Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-composable-components) guide. You can identify each component type by its color:\n\n* Services: Hot pink boxes.\n* Add-ons: Light pink boxes.\n* Integrations: Dark blue boxes.\n* Platform interaction tools: Light blue boxes.\n\nYou can enable and disable services, add-ons, User Admin features, and Developer Tooling by clicking them. If you double-click an add-on, a pop-up opens with a video explaining it.\n\nWhen you click a type of integration, e.g., Carriers, a pop-up opens with the available partners for that type of integration and the selected region. You can choose up to four partners. Then, you can click the X in the top-right corner to close the pop-up.\n\n\n\n_Pop-up containing available carriers for the LATAM region_\n\n\n\n_Selected carriers in the architecture planning_\n\nAfter selecting all the desired options for your store planning, you should have something like the image below.\n\n\n\n> If you want to reset your architecture planning, click the 🔃refresh button in the top right corner or refresh the page in your browser.\n\nContributors\n\n2\n\n[](https://github.com/henriquessb)\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX-Platform-Overview/Composability/interactive-marchitecture-tool.md)\n\n[VTEX Composable Components« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool//docs/guides/vtex-composable-components)[ExtensibilityNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interactive-marchitecture-tool//docs/guides/extensibility)\n\nContributors\n\n2\n\n[](https://github.com/henriquessb)\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX-Platform-Overview/Composability/interactive-marchitecture-tool.md)\n\nCopy page\n\nOn this page\n\nOn this page\n\n[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=)"
}
] |
doc_14d084bf
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX login app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/troubleshooting)\n\n[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.login/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/guides/basic-components)\n\nLogin\n\nOfficial extension\n\nVersion: 2.69.1\n\nLatest version: 2.69.1\n\n[](#contributors-)\n\nThe VTEX Login app is responsible for handling user login in your store.\n\n\n\n## Configuration\n\n1. Add the Login app to your theme's dependencies in the `manifest.json` file:\n\n`1\n\n \"dependencies\": { \n\n2\n\n+ \"vtex.login\": \"2.x\" \n\n3\n\n } \n\n`\n\nNow, you are able to use all the blocks exported by the Login app. Check out the full list below:\n\n| Block name | Description |\n| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| login |  Renders the Login component, as shown in the media above. |\n| login-content | Only renders the login form . |\n\n1. Add the `login` block and its props to your store's header. For example:\n\n`1\n\n\"login\": { \n\n2\n\n \"props\": { \n\n3\n\n \"emailAndPasswordTitle\": \"LOG-IN\", \n\n4\n\n \"accessCodeTitle\": \"Acess Code LOG-IN\", \n\n5\n\n \"emailPlaceholder\": \"e-mail\", \n\n6\n\n \"passwordPlaceholder\": \"password\", \n\n7\n\n \"showPasswordVerificationIntoTooltip\": true, \n\n8\n\n } \n\n9\n\n} \n\n`\n\n### `login` props\n\n| Prop name | Type | Description | Default value |\n| ----------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| optionsTitle | string | Text to entitle the login options. | undefined |\n| emailAndPasswordTitle | string | Text to display the email-and-password option. | undefined |\n| accessCodeTitle | string | Text to display the access-code option. | undefined |\n| emailPlaceholder | string | Text to be displayed as placeholder to the email input. | undefined |\n| passwordPlaceholder | string | Text to be displayed as placeholder to the password input. | undefined |\n| acessCodePlaceholder | string | Text to be displayed as placeholder to the access code input. | undefined |\n| showPasswordVerificationIntoTooltip | boolean | Whether a tooltip responsible for checking the password format should be shown (true) or not (false). | true |\n| showIconProfile | boolean | Whether the hpa-profile icon from [Store Icons](https://read.calvincode.net/reader?url=https://vtex.io/docs/components/all/vtex.store-icons/) should be displayed on the Login component (true) or not (false). | true |\n| iconLabel | string | Text string to entitle the Login icon. | undefined |\n| hideIconLabel | boolean | Whether the text string defined for the Login icon should be hidden (true) or not (false). | false |\n| labelClasses | \\[string\\] | Login icon's classnames. | undefined |\n| providerPasswordButtonLabel | string | Text to be displayed as the password button label. | undefined |\n| identifierPlaceholder | string | Text to be displayed as placeholder to the extension input. | undefined |\n| invalidIdentifierError | string | Error message for invalid user identifier. | undefined |\n| mirrorTooltipToRight | boolean | Whether the Login tooltip should open towards the right side of the screen (true) or not (false). | false |\n| logInButtonBehavior | enum | Expected behavior of the Login component when clicked on. Possible values are: popover (opens a popover tab) and link (redirects user to the /login page). | popover |\n| accountOptionsButtonBehavior | enum | Expected behavior of the My account button when clicked on. Possible values are: popover (opens a popover tab) and link (redirects user to the /account page). | popover |\n| accountOptionLinks | \\[object\\] | Creates a custom link to replace the default one set for the accountOptionsButtonBehavior's link value (/account). Check out below the available props for the object. | undefined |\n| termsAndConditions | string | Text to be displayed below the login options regarding terms&conditions. | undefined |\n| hasGoogleOneTap | boolean |  Whether the [Google's One-tap sign-up and auto sign-in](https://read.calvincode.net/reader?url=https://developers.google.com/identity/one-tap/web/) solution should be enabled (true) or not (false). | false |\n| googleOneTapAlignment | enum |  Defines pop-up alignment for the Google One-tap login. Possible values are Left and Right. | Right |\n| googleOneTapMarginTop | string |  Defines the pop-up top margin for the Google One-tap login. The values supported are the same supported by the CSS property top. | 3rem |\n| disabledEmailInputs | boolean | Whether user email editing should be allowed (true) or not (false). | false |\n| blockOAuthAutoRedirect | boolean | If this prop is true and the only active provider is an OAuth, the login won't auto-redirect as usual. Also, the query string oAuthRedirect will be disabled. | false |\n\n> _Notice that the Google One Tap props are still in Beta. Although they are ready to be used, UX improvements should be expected._\n\n* **`accountOptionLinks` object:**\n\n| Prop name | Type | Description | Default value |\n| --------- | ---------- | ------------------------------- | ------------- |\n| label | string | Text lable for the custom link. | undefined |\n| path | string | Custom link's path. | undefined |\n| cssClass | \\[string\\] | Login icon's class names. | undefined |\n\n### `login-content` props\n\n| Prop name | Type | Description | Default value |\n| ----------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| isInitialScreenOptionOnly | boolean | Whether only the login options will be displayed on the initial screen (true) or not (false). | true |\n| defaultOption | enum | Defines the default login options to be shown. Possible values are: 0 (shows the access-code option for login), 1 (shows the email/password option for login) and 2 (shows the corporate option for login). | 0 |\n| optionsTitle | string | Text to entitle the login options. | undefined |\n| emailAndPasswordTitle | String | Text to display the email-and-password option. | undefined |\n| accessCodeTitle | string | Text to display the access-code option. | undefined |\n| emailPlaceholder | string | Text to be displayed as placeholder to the email input. | undefined |\n| passwordPlaceholder | string | Text to be displayed as placeholder to the password input. | undefined |\n| showPasswordVerificationIntoTooltip | boolean | Whether a tooltip responsible for checking the password format should be shown (true) or not (false). | true |\n| acessCodePlaceholder | string | Text to be displayed as placeholder to the access code input. | undefined |\n| providerPasswordButtonLabel | string | Text to be displayed as the password button label. | undefined |\n| identifierPlaceholder | string | Text to be displayed as placeholder to the extension input. | undefined |\n| invalidIdentifierError | string | Error message for invalid user identifier. | undefined |\n| termsAndConditions | string | Text to be displayed below the login options regarding terms&conditions. | undefined |\n| disabledEmailInputs | boolean | Whether user email editing should be allowed (true) or not (false). | false |\n\n### Advanced configuration\n\nThe email/password login asks by default two inputs from users:\n\n* The email (_user identifier_)\n* The password\n\nIt is possible to **set up the User Identifier Extension, allowing other identifiers to be used in the Login's form instead** \\- as long as they can be resolved to the user email behind the scenes.\n\nFor example: if your account stores the National Identity Document of each user, the email/password login could be changed to ask for the following two inputs:\n\n* The National Identity Document (_user identifier_)\n* The password\n\nIn order to display an identifier other than the user email, you must create an **extension app** of your own to work behind the scenes with the Login component.\n\nThe new extension app should be set up to receive the custom user identifier from the interface, such as the National Identity Document, and link it to the accurate user using the store data. Thereafter, the app should fetch the user email and return it to the Login app, which will behave as if the user just typed in their email.\n\nAn example implementation is available at the [\"user-identifier-extension-example\" repository](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/user-identifier-extension-example).\n\nFind below the needed instructions to perform the User Identifier Extension in your store:\n\n> _This extension is only allowed for enterprise clients. You can check your account plan in your VTEX contract._\n\n1. Ensure that the Login app is added as your extension app's dependency and that the `store` builder is listed as one of its builders, as shown below:\n\n`1\n\n\"dependencies\": { \n\n2\n\n \"vtex.login\": \"2.x\" \n\n3\n\n}, \n\n`\n\n`1\n\n\"builders\": { \n\n2\n\n \"store\": \"0.x\", \n\n3\n\n}, \n\n`\n\n1. [Develop a new component](https://read.calvincode.net/reader?url=https://vtex.io/docs/getting-started/desenvolva-componentes-usando-vtex-io-e-react/1) to replace the `email` input in the login form. It can be anything you desire for that position, such as a file uploader or a simple text input which takes the National Identity Document.\n\n> _When developing it, remember that it must know how to convert the custom identifier to an email. This should be done by registering a callback function, which returns an email within the Login app, in the `react/{{ComponentName}}.js` file. For example:_\n\n`` 1\n\nimport { useState, useCallback, useEffect } from 'react' \n\n2\n\n \n3\n\nconst ComponentName = ({ renderInput, identifierPlaceholder, registerSubmitter }) => { \n\n4\n\n // The component receives 3 props: \n\n5\n\n // - renderInput is a function that returns the same Input component used by the login app, defined in styleguide. \n\n6\n\n // It receives an object with three named parameters, trivially used by Inputs with react: value, onChange, placeholder. \n\n7\n\n // When \"onChange\" is called, the login app clears the \"email is invalid\" error, if it exists. \n\n8\n\n // - identifierPlaceholder is the value of the configuration \"identifierPlaceholder\" defined in the Store Front. It has a \n\n9\n\n // fallback to the value of the configuration \"emailPlaceholder\". \n\n10\n\n // - registerSubmitter is a function that receives your async callback function defined in this file. Your callback will be called \n\n11\n\n // when the user submits the form. \n\n12\n\n \n13\n\n // This code controls the state of the rendered Input component. \n\n14\n\n const [inputValue, setInputValue] = useState('') \n\n15\n\n const onChangeInput = useCallback(e => setInputValue(e.target.value), [ \n\n16\n\n setInputValue, \n\n17\n\n ]) \n\n18\n\n \n19\n\n // This callback function (onSubmit) should return the resolved email. In the example below, it adds `@email.com` to the current \n\n20\n\n // value in the Input component (eg. \"john\" would be resolved to \"john@email.com\"). \n\n21\n\n const onSubmit = useCallback(async () => { \n\n22\n\n const email = `$\\{inputValue\\}@email.com` \n\n23\n\n return email \n\n24\n\n }, [inputValue]) \n\n25\n\n \n26\n\n // This code registers the async callback function you defined in the login app when this component mounts. \n\n27\n\n useEffect(() => { \n\n28\n\n registerSubmitter(onSubmit) \n\n29\n\n }, [registerSubmitter, onSubmit]) \n\n30\n\n \n31\n\n // The component calls \"renderInput\" and renders its result. \n\n32\n\n return renderInput({ \n\n33\n\n value: inputValue, \n\n34\n\n onChange: onChangeInput, \n\n35\n\n placeholder: identifierPlaceholder, \n\n36\n\n }) \n\n37\n\n} \n\n38\n\n \n39\n\nexport default ComponentName \n\n ``\n\n1. In the `store/interfaces.json` file, create a new [interface](https://read.calvincode.net/reader?url=https://vtex.io/docs/getting-started/desenvolva-componentes-usando-vtex-io-e-react/4%23entendendo-interfaces) for `user-identifier`, declaring the component you created in the previous step:\n\n`1\n\n\"user-identifier.{{InterfaceName}}\": { \n\n2\n\n \"component\": \"{{ComponentName}}\" \n\n3\n\n}, \n\n`\n\n> _The interface name, which is represented in the example above as `{{InterfaceName}}`, can be any of your choosing._ℹ️ _In the example above, the component created in the step 2 is represented by `{{ComponentName}}`._\n\n1. In the `store/plugins.json` file, plug in the new interface (`user-identifier`) to the Login app:\n\n`1\n\n\"login > user-identifier\": \"user-identifier.{{InterfaceName}}\", \n\n2\n\n\"login-content > user-identifier\": \"user-identifier.{{InterfaceName}}\", \n\n`\n\n> _If the `store/plugins.json` file is not available, you should create it._\n\n> _Since the Login app behaves as if users were typing their emails, error messages like `The email is invalid` may appear even if the component is asking users other identifiers. This message, along with others, can be edited in the admin's CMS._\n\n## Modus Operandi\n\nThe Login app reads the following query-string parameters:\n\n* `returnUrl` \\- Redirects users to the given `returnUrl` once they are logged in. Caution: This parameter only works for the store's domain and should be UTF-8 encoded (as in javascript's `encodeURIComponent`).\n* `oAuthRedirect` \\- Redirects users to the given OAuth Provider page, instead of displaying the native login options. For this to work, the given OAuth Provider must be listed on the component as one of the login options. Caution: The parameter value is case sensitive and must be `Google`, `Facebook` or the registered name of the chosen OAuth Provider.\n* `userEmail` \\- User email data.\n* `flowState` \\- Default state of the login flow. Possible values: \n * `createPass` \\- Sends an email to users with the code required to create a new password. Caution: When used, this parameter also requires the `userEmail` query string in the same URL.\n\n> _Use the parameters above to build the Login's desired URLs - through which you will be able to set the expected behavior for the component._\n\n## Customization\n\nIn order to apply CSS customizations in this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization).\n\n| CSS Handles |\n| -------------------------- |\n| container |\n| contentInitialScreen |\n| contentFormVisible |\n| profile |\n| label |\n| optionsSticky |\n| optionsList |\n| optionsListItem |\n| optionsListItemContainer |\n| accessCodeOptionBtn |\n| emailPasswordOptionBtn |\n| corporateOptionBtn |\n| facebookOptionBtn |\n| googleOptionBtn |\n| customOAuthOptionBtn |\n| oauthProvider |\n| inputContainer |\n| inputContainerAccessCode |\n| inputContainerPassword |\n| inputContainerEmail |\n| emailVerification |\n| emailForm |\n| emailAndPasswordForm |\n| forgotPasswordForm |\n| formLinkContainer |\n| arrowUp |\n| buttonLink |\n| formError |\n| content |\n| content--emailVerification |\n| content--emailAndPassword |\n| content--codeConfirmation |\n| content--accountOptions |\n| content--recoveryPassword |\n| button |\n| sendButton |\n| buttonSocial |\n| buttonDanger |\n| backButton |\n| accountOptions |\n| codeConfirmation |\n| corporateEmail |\n| formTitle |\n| formSubtitle |\n| box |\n| contentContainer |\n| formFooter |\n| contentForm |\n| contentAlwaysWithOptions |\n| options |\n| tooltipContainer |\n| tooltipContainerTop |\n| tooltipContainerLeft |\n| loginOptionsContainer |\n| termsAndConditions |\n| forgotPasswordLink |\n| dontHaveAccount |\n| eyeIcon |\n| selectCodeDeliveryMethod |\n| deliveryMethodOptions |\n\n[Locale Switcher« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.locale-switcher)[MenuNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.menu)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.login%23configuration)\n\n[login props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.login%23login-props)[login-content props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.login%23login-content-props)[Advanced configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.login%23advanced-configuration)\n\n[Modus Operandi](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.login%23modus-operandi)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.login/docs/apps/vtex.login%23customization)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_cf3c8925
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore api extensions use cases overview in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/api-extensions-overview)\n\n[Extending API schemas](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/api-extensions-extending-api-schema)\n\n[Extending queries using fragments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/api-extensions-extending-queries-using-fragments)\n\n[Consuming FastStore API extension with custom components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/api-extensions-consuming-api-extensions)\n\n[Best practices for using API extensions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/api-extensions-best-practices)\n\n[API extensions - Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/api-extensions-use-cases-overview)\n\n[Adding a contact form to the landing page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/api-extensions-use-cases-adding-a-contact-form-to-a-landing-page)\n\n[Adding available installment information in PDP](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/api-extensions-overview)\n\n[Extending API schemas](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/api-extensions-extending-api-schema)\n\n[Extending queries using fragments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/api-extensions-extending-queries-using-fragments)\n\n[Consuming FastStore API extension with custom components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/api-extensions-consuming-api-extensions)\n\n[Best practices for using API extensions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/api-extensions-best-practices)\n\n[API extensions - Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/api-extensions-use-cases-overview)\n\n[Adding a contact form to the landing page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/api-extensions-use-cases-adding-a-contact-form-to-a-landing-page)\n\n[Adding available installment information in PDP](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/api-extensions-overview)\n\nAPI extensions use cases\n\nThis section provides an introduction, implementation instructions, and storefront results, showing how to extend FastStore APIs and integrate them with external ones. These examples are designed to help you understand how to use this feature.\n\n| Use case | Description |\n| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |\n| [Adding a contact form to the landing page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-a-contact-form-to-a-landing-page) | Allows shoppers to contact your store through a form. |\n| [Adding available installment information on the PDP](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page) | Displays the available installment options for a product on the Product Details Page (PDP). |\n\n> For detailed code examples, access the [playground.store](https://read.calvincode.net/reader?url=https://github.com/vtex-sites/playground.store) repository, which provides in-depth details on each use case.\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/api-extensions/api-extensions-use-cases/overview.mdx)\n\n[Best practices for using API extensions« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/api-extensions-best-practices)[Adding a contact form to the landing pageNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-overview/docs/guides/faststore/api-extensions-use-cases-adding-a-contact-form-to-a-landing-page)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/api-extensions/api-extensions-use-cases/overview.mdx)\n\nCopy page\n\nOn this page\n\nOn this page\n\n[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=)"
}
] |
doc_2a6448b2
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore getting started promoting your headless cms changes in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-overview)\n\n[1\\. Setting up your environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-1-setting-up-your-environment)\n\n[2\\. Starting a new FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-2-starting-the-project)\n\n[3\\. Running the project locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-3-running-the-project-locally)\n\n[4\\. Understanding the project structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-4-understanding-the-project-structure)\n\n[5\\. Integrating your project with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)\n\n[Setting up the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-setting-up-the-headless-cms)\n\n[Structuring Content Types and Sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-structuring-content-types-and-sections)\n\n[Promoting your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes)\n\n[6\\. Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-6-next-steps)\n\n[Glossary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-glossary)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-overview)\n\n[1\\. Setting up your environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-1-setting-up-your-environment)\n\n[2\\. Starting a new FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-2-starting-the-project)\n\n[3\\. Running the project locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-3-running-the-project-locally)\n\n[4\\. Understanding the project structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-4-understanding-the-project-structure)\n\n[5\\. Integrating your project with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)\n\n[Setting up the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-setting-up-the-headless-cms)\n\n[Structuring Content Types and Sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-structuring-content-types-and-sections)\n\n[Promoting your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes)\n\n[6\\. Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-6-next-steps)\n\n[Glossary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-glossary)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-overview)\n\n[5\\. Integrating your project with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)\n\nPromoting your changes\n\nPromote your CMS definitions to production and finish the Headless CMS setup.\n\nIn this final part of the Headless CMS integration, you'll promote your Content Types and Sections to production so editors can use them to create and manage content.\n\n## What you'll accomplish\n\nBy the end of this step, you will have:\n\n* Synced your CMS definitions to production\n* Made your Content Types and Sections available to content editors in the Headless CMS app\n* Completed the Headless CMS integration workflow\n\nYour FastStore project will now be fully integrated with Headless CMS, enabling content editors to create, edit, and publish web content via the VTEX Admin.\n\n## Instructions\n\nIf you are happy with your Content Type and Section definitions, you can promote them to production by taking the following steps:\n\n1. Open the terminal and switch to the `master` workspace. \n`1 \nvtex use master \n`\n2. Change to the root directory of your FastStore project and sync your changes in the `cms` folder with the Headless CMS app. \n`1 \nfaststore cms-sync \n`\n\nYour FastStore project is now fully integrated with the Headless CMS. Editors can create, edit, and publish web content via the VTEX Admin using the Headless CMS app.\n\n## Next step\n\nCongratulations! You've completed the Getting Started track. Explore next steps to continue customizing your store: [7\\. Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-next-steps)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/getting-started/promoting-your-headless-cms-changes.mdx)\n\n[Structuring Content Types and Sections« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-structuring-content-types-and-sections)[6\\. Next stepsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-6-next-steps)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[What you'll accomplish](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes%23what-youll-accomplish)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes%23instructions)\n\n[Next step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes%23next-step)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/getting-started/promoting-your-headless-cms-changes.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[What you'll accomplish](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes%23what-youll-accomplish)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes%23instructions)\n\n[Next step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes%23next-step)\n\nOn this page\n\n[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=)"
}
] |
doc_e9b3162c
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides store framework using components in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-using-components)\n\n[Building a horizontal Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary)\n\n[Building a Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/vtex-io-documentation-building-a-shelf)\n\n[Configuring custom images for the SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector)\n\n[Creating a native form for your store users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users)\n\n[Creating a product availability form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/vtex-io-documentation-creating-a-product-availability-form)\n\n[Overriding native app blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/vtex-io-documentation-overriding-native-app-blocks)\n\n[Using Sandbox blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/vtex-io-documentation-using-sandbox-blocks)\n\n[Using the Assets Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/vtex-io-documentation-using-the-assets-builder)\n\n[Setting up Delivery Promise components (Beta)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/setting-up-delivery-promise-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-using-components)\n\n[Building a horizontal Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary)\n\n[Building a Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/vtex-io-documentation-building-a-shelf)\n\n[Configuring custom images for the SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector)\n\n[Creating a native form for your store users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users)\n\n[Creating a product availability form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/vtex-io-documentation-creating-a-product-availability-form)\n\n[Overriding native app blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/vtex-io-documentation-overriding-native-app-blocks)\n\n[Using Sandbox blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/vtex-io-documentation-using-sandbox-blocks)\n\n[Using the Assets Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/vtex-io-documentation-using-the-assets-builder)\n\n[Setting up Delivery Promise components (Beta)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/setting-up-delivery-promise-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-using-components)\n\nUsing components\n\nDiscover how components in VTEX IO Store Framework enable you to build your storefront, from basic elements to advanced customizations.\n\nComponents are building blocks used to create storefronts and admin apps. They are built on the [VTEX IO development platform](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io) using [React](https://read.calvincode.net/reader?url=https://react.dev/) technology.\n\nThese components are modular, reusable pieces of code that encapsulate specific features and can be combined to create complex user interfaces. They range from basic elements, such as buttons and forms, to more complex ones, such as product carousels and navigation bars. Conceptually, components resemble JavaScript functions: they take arbitrary inputs, referred to as `props`, and return React elements that articulate what should be displayed on the screen.\n\nYou can use our [native components](#native-components), customize them as needed, or even [create your own components](#custom-components) to meet the specific needs of your projects on the VTEX IO platform.\n\nIn the guides of this section, you will explore how to leverage components to create customizable storefronts.\n\n## Before you begin\n\n### Develop your Store Theme\n\nMake sure your store has a [Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme) developed following the [Storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3) guide.\n\n### Check the builders\n\nCheck if the builders are properly installed in your Store Theme. To use builders, your account must have at least version `vtex.builder-hub@0.293.4` installed. Also, you need to specify them in the app's `manifest.json` file. Learn more in [Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders).\n\nYou must have at least the following builders configured:\n\n* [store builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-builder): Enables the development of Store Framework storefronts.\n* [react builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-react-builder): Used to develop apps with [React](https://read.calvincode.net/reader?url=https://react.dev/) when your project requires customized frontend solutions.\n\n### Learn about VTEX IO apps\n\nFamiliarize yourself with [VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps) and learn how to build custom solutions following the guide [Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io).\n\n## Essential concepts\n\nA deep understanding of native and custom components is important for using them more effectively.\n\n### Native components\n\nWithin the VTEX IO ecosystem, different types of components address different aspects of store development. Below are the main types of components:\n\n* [**Basic components**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/basic-components): Reusable UI elements such as buttons, forms, input fields, and other fundamental interface elements. These components provide the building blocks for creating more complex UI elements and features.\n\nThe [Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary) exemplifies a basic storefront component, summarizing essential product information like name, price, and image, which can be seamlessly integrated into other store blocks, such as the [Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf).\n\n* [**Store Components**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components): Collection of components that can be used to create or extend other VTEX apps, aiming to improve the functionality and appearance of the storefront. They cover a range of elements, including product displays, navigation bars, checkout processes, and category pages. Some components in this collection offer advanced features, such as product recommendations, search filters, and personalized content delivery.\n\n### Custom components\n\nWhen building a [store theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-6-buildingyourownstoretheme), you can leverage existing VTEX IO apps or create custom apps to add new components and extend the platform features.\n\nSee our guide about how to [develop an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-an-app).\n\n## Guides in this section\n\n[Building a horizontal Product SummaryDiscover the process of building a horizontal Product Summary.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary)[Building a ShelfUnderstand how to build and customize shelves to display products on your store’s pages.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-shelf)[Configuring custom images for the SKU SelectorLearn how to customize the images for your SKU Selector.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector)[Creating a native form for your store usersDiscover how to customize and integrate forms directly on your store.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users)[Creating a product availability formLearn how to create a product availability form with this step-by-step guide.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-product-availability-form)[Using Sandbox blocksLearn how to use Sandbox blocks to test different components in a safe environment.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-sandbox-blocks)[Using the Assets BuilderExplore how to manage assets in your VTEX IO projects using the Assets builder.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-assets-builder)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/store-framework-using-components.md)\n\n[Customizing the Header and Footer blocks by page« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components//docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page)[Building a horizontal Product SummaryNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components//docs/guides/vtex-io-documentation-building-a-horizontal-product-summary)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-using-components%23before-you-begin)\n\n[Develop your Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-using-components%23develop-your-store-theme)[Check the builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-using-components%23check-the-builders)[Learn about VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-using-components%23learn-about-vtex-io-apps)\n\n[Essential concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-using-components%23essential-concepts)\n\n[Native components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-using-components%23native-components)[Custom components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-using-components%23custom-components)\n\n[Guides in this section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-using-components%23guides-in-this-section)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/store-framework-using-components.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-using-components%23before-you-begin)\n\n[Develop your Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-using-components%23develop-your-store-theme)[Check the builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-using-components%23check-the-builders)[Learn about VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-using-components%23learn-about-vtex-io-apps)\n\n[Essential concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-using-components%23essential-concepts)\n\n[Native components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-using-components%23native-components)[Custom components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-using-components%23custom-components)\n\n[Guides in this section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components/docs/guides/store-framework-using-components%23guides-in-this-section)\n\nOn this page\n\n[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=)"
}
] |
doc_de0a79a1
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation slots in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[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-slots/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/api-reference)\n\n[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-slots/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/storefront-development)\n\n[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-slots/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/troubleshooting)\n\n[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-slots/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/getting-started-3)\n\nConcepts\n\n[Composition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/vtex-io-documentation-composition)\n\n[Interfaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/vtex-io-documentation-interface)\n\n[Properties](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/vtex-io-documentation-properties)\n\n[Slots](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/vtex-io-documentation-slots)\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/getting-started-3)\n\nConcepts\n\n[Composition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/vtex-io-documentation-composition)\n\n[Interfaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/vtex-io-documentation-interface)\n\n[Properties](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/vtex-io-documentation-properties)\n\n[Slots](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/vtex-io-documentation-slots)\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/store-framework)\n\nConcepts\n\n[Slots](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/vtex-io-documentation-slots)\n\nSlots\n\nSlots provide an alternative way for defining component structures within Store Framework themes.\n\nSlots composition is an alternative paradigm for defining component structures within the Store Framework themes. Unlike the conventional block composition method, slots enable developers to pass React props directly to components, providing enhanced flexibility in storefront design.\n\nWhen using slots, consider the following:\n\n* The requirement for the `blocks` attribute is eliminated when implementing components that utilize slots in the Store Theme. Instead, developers can pass the desired blocks as regular `props`.\n* Slots grant the ability to include any block from any app as a regular prop. Hence, unlike the blocks composition method, declaring the `allowed` interface attribute is not necessary.\n\n## Blocks vs. Slots\n\nTo better understand the distinctions between blocks and slots, let's delve into the specifics of each method using a hypothetical `hello-world` component.\n\n### Blocks\n\nWhen using the blocks composition, the focus revolves around defining `allowed` blocks and structuring their arrangement. In this approach, the `blocks` attribute specifies which blocks can be used within the `hello-world` component. Consider the following example:\n\n| HelloWorld.tsx | interfaces.json | blocks.json |\n| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| 1// HelloWorld.tsx2import React from 'react'3import { ExtensionPoint } from 'vtex.render-runtime' 45const HelloWorld \\= () \\=> (6 <div className\\=\"tc pv5\"\\>7 <ExtensionPoint id\\=\"icon-caret\" size\\={32} />8 <h1 className\\=\"t-heading-1 c-on-base\"\\>Hello, world!<h1\\>9 </div\\>10)1112export default HelloWorld | 1// interfaces.json2{3 \"hello-world\": {4 \"component\": \"HelloWorld\",5 \"allowed\": \\[\"icon-caret\"\\]6 }7} | 1// blocks.json2{3 \"hello-world\": {4 \"blocks\": \\[\"icon-caret#point-up\"\\]5 },6 \"icon-caret#point-up\": {7 \"props\": {8 \"orientation\": \"up\"9 }10 }11} |\n\nNote that, in this example, the `icon-caret` block is the only child block allowed for `hello-world`. Other limitations of this method include:\n\n* The `hello-world` block only accepts the `icon-caret` block as a child. Any other `icon-*` block or any block beyond that scope is incompatible, necessitating the explicit allowance of each distinct block in the `interfaces.json` file.\n* Implementing the block-based approach within `HelloWorld.tsx` involves conditional logic to identify the block passed by the developer and subsequently convey its ID to the `ExtensionPoint` component.\n* Passing multiple instances of the same block within the `HelloWorld` component may lead to rendering problems. For example, passing and rendering both `icon-caret#point-up` and `icon-caret#point-down` in the `blocks.json` file would lead to an ambiguous scenario.\n\n### Slots\n\nNow, let's reimagine the same scenario using slots composition:\n\n| HelloWorld.tsx | interfaces.json | blocks.json |\n| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| 1import React, { ReactElement } from 'react';2const HelloWorld \\= ({ Icon }) \\=> (3 <div className\\=\"tc pv5\"\\>4 <Icon size\\={32} />5 <h1 className\\=\"t-heading-1 c-on-base\"\\>Hello, world!</h1\\>6 </div\\>7);89export default HelloWorld; | 1// interfaces.json2{3 \"hello-world\": {4 \"component\": \"HelloWorld\"5 }6} | 1//blocks.json2{3 \"hello-world\": {4 \"props\": {5 \"Icon\": \"icon-caret#point-up\"6 }7 },8 \"icon-caret#point-up\": {9 \"props\": {10 \"orientation\": \"up\"11 }12 }13} |\n\nNote that, by directly passing required components as `props`, the slots approach eliminates the need for the `allowed` attribute. This method introduces flexibility into the component integration process, allowing any component to be included as a prop without prior restrictions.\n\nThis example demonstrates how slots composition simplifies the component declaration process and enhances flexibility. You can adjust the composition by passing different components as props, making the structure more adaptable to your needs.\n\nTo ensure consistent and effective usage of slots, it is important to adhere to the following guidelines:\n\n* Slots are always exposed via `PascalCased` props.\n\n| ✅ Do | ❌ Don't |\n| ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |\n| 1{2 \"props\": {3 // Works!4 \"Icon\": \"icon-caret\"5 }6} | 1{2 \"props\": {3 // Does NOT work. This will be interpreted as a string by store builder4 \"icon\": \"icon-caret\"5 }6} |\n\n* Nested slots are not supported. This means that you can't have a slot prop inside of an object, such as shown below:\n\n`1\n\n{ \n\n2\n\n \"props\": { \n\n3\n\n \"somePropThatsAnObject\": { \n\n4\n\n \"p1\": \"this\", \n\n5\n\n \"p2\": \"will\", \n\n6\n\n \"p3\": \"not\", \n\n7\n\n \"p4\": \"work\", \n\n8\n\n // This will NOT be picked up by the store builder \n\n9\n\n \"Slot\": \"some-block\" \n\n10\n\n } \n\n11\n\n } \n\n12\n\n} \n\n`\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/concepts/vtex-io-documentation-slots.md)\n\n[Properties« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots//docs/guides/vtex-io-documentation-properties)[Building pagesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots//docs/guides/store-framework-building-pages)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Blocks vs. Slots](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/vtex-io-documentation-slots%23blocks-vs-slots)\n\n[Blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/vtex-io-documentation-slots%23blocks)[Slots](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/vtex-io-documentation-slots%23slots)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/concepts/vtex-io-documentation-slots.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Blocks vs. Slots](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/vtex-io-documentation-slots%23blocks-vs-slots)\n\n[Blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/vtex-io-documentation-slots%23blocks)[Slots](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-slots/docs/guides/vtex-io-documentation-slots%23slots)\n\nOn this page\n\n[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=)"
}
] |
doc_46cbffbe
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX store sitemap 2.18.3 CUSTOM ROUTES ARCHITECTURE app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/troubleshooting)\n\n[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.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/vtex-io-apps)\n\nCustom Routes Architecture\n\n[vtex.store-sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap)\n\nVersion: 2.18.3\n\nLatest version: 2.18.3\n\n## Overview\n\nThe custom routes solution provides pre-generated route data for VTEX stores through a background processing architecture with caching and automatic regeneration.\n\n## System Architecture\n\nCache Miss\n\nCache Hit\n\nNo Lock or Expired\n\nActive Lock\n\nYes - Stale\n\nNo - Fresh\n\nClient Request: GET /custom-routes\n\ncustomRoutes Middleware\n\nCheck VBase Cache\n\nNo Cached Data Found\n\nCached Data Found\n\nTrigger Generation\n\nCheck Generation Lock\n\nCreate Generation Lock\n\nGeneration In Progress\n\nStart Background Generation\n\nReturn 404: Generation Triggered\n\nReturn 404: Generation In Progress\n\nData Age > 1 Day?\n\nTrigger Background Regeneration\n\nServe Cached Data\n\nReturn 200 + Data\n\nClient Receives 404\n\nClient Receives 200\n\n## Background Processing Flow\n\nClientcustomRoutes MiddlewareVBase StorageBackground PromisegenerateCustomRoutes FunctionApps Routes ServiceUser Routes Servicealt\\[Cache Miss\\]\\[Cache Hit - Fresh Data\\]\\[Cache Hit - Stale Data\\]GET /custom-routesGet custom-routes.jsonnull (not found)Check generation lockNo lock foundCreate lock fileStart generateCustomRoutes() (fire-and-forget)404 - Generation triggeredExecute generationFetch apps routesFetch user routesApps routes arrayUser routes arrayCombine route dataSave custom-routes.jsonClear generation lockReturn cached data (< 1 day old)200 + Routes dataReturn cached data (> 1 day old)Trigger background regeneration (fire-and-forget)200 + Routes data (stale)Execute regenerationClientcustomRoutes MiddlewareVBase StorageBackground PromisegenerateCustomRoutes FunctionApps Routes ServiceUser Routes Service\n\n## VBase Storage Structure\n\nVBase Storage\n\nBucket: configuration\n\nBucket: custom-routes\n\nFile: generation-lock.json \nType: Generation Lock \nTTL: 23 hours\n\nFile: custom-routes.json \nType: Cached Routes Data \nRegeneration: After 1 day\n\nContent: \n{ \n generationId: string, \n endDate: string \n}\n\nContent: \n{ \n timestamp: number, \n data: \\[ \n {name: 'apps-routes', routes: \\[\\]}, \n {name: 'user-routes', routes: \\[\\]} \n \\] \n}\n\n## Response Status Codes\n\n| Status | Scenario | Body | Behavior |\n| ------- | --------------------------------- | -------------------------------------------------------------------------- | --------------------------------------------------------------- |\n| **200** | Cached data available | { data: \\[...\\] } | Returns cached routes (may trigger background refresh if stale) |\n| **404** | No cache + Generation triggered | { message: \"Custom routes not available. Generation has been triggered.\" } | New generation started |\n| **404** | No cache + Generation in progress | { message: \"Generation already in progress, expires at {date}\" } | Active lock prevents duplicate generation |\n| **500** | Server error | { success: false, error: \"...\" } | Unexpected error occurred |\n\n## Key Components\n\n### Files\n\n* **`node/middlewares/customRoutes.ts`**: Main middleware handling requests and triggering background generation\n* **`node/middlewares/generateMiddlewares/generateCustomRoutes.ts`**: Background generation function\n* **`node/utils.ts`**: Shared utilities and constants\n* **`node/services/routes.ts`**: Route fetching services\n\n### Constants (from `utils.ts`)\n\n`1\n\nexport const CUSTOM_ROUTES_BUCKET = 'custom-routes' \n\n2\n\nexport const CUSTOM_ROUTES_FILENAME = 'custom-routes.json' \n\n3\n\nexport const CUSTOM_ROUTES_GENERATION_LOCK_FILENAME = 'generation-lock.json' \n\n4\n\nexport const CONFIG_BUCKET = 'configuration' \n\n`\n\n### Background Generation Mechanism\n\nThe generation is triggered directly via a background promise (fire-and-forget pattern):\n\n`1\n\n// Execute generation in background - don't await \n\n2\n\ngenerateCustomRoutes(ctx).catch(error => { \n\n3\n\n logger.error({ \n\n4\n\n message: 'Background custom routes generation failed', \n\n5\n\n type: 'custom-routes-background-error', \n\n6\n\n generationId, \n\n7\n\n error, \n\n8\n\n }) \n\n9\n\n}) \n\n`\n\n**Key characteristics:**\n\n* **Direct function call**: No event system overhead\n* **Fire-and-forget**: Promise runs in background without blocking response\n* **Error handling**: Errors are caught and logged but don't crash the service\n* **Synchronous trigger**: Immediate execution without event queue delays\n\n### Generation Lock Mechanism\n\n1. **Lock Creation**: When generation starts, a lock file is created with: \n * `generationId`: Random identifier \n * `endDate`: Expiration timestamp (23 hours from creation)\n2. **Lock Check**: Before starting generation: \n * If lock exists and is valid → Reject with `MultipleCustomRoutesGenerationError` \n * If lock expired or doesn't exist → Proceed with generation\n3. **Lock Cleanup**: After generation completes (success or failure), lock is removed\n4. **Lock Duration Rationale**: \n * **23 hours** chosen to align with daily regeneration schedule \n * Prevents indefinite blocking if cleanup fails \n * Allows next day's scheduled generation to proceed even if previous generation failed\n\n### Caching Strategy\n\n* **Storage**: VBase bucket `custom-routes`, file `custom-routes.json`\n* **Structure**: Account-level (not binding-specific)\n* **Freshness**: Data older than 1 day triggers background regeneration\n* **Stale-While-Revalidate**: Returns stale data while refreshing in background\n\n## Benefits\n\n✅ **Background Processing**: Asynchronous generation doesn't block requests \n✅ **Direct Execution**: No event system overhead or delays \n✅ **Lock Mechanism**: Prevents duplicate concurrent generations with 23-hour auto-expiration \n✅ **Stale-While-Revalidate**: Always serves data when available, refreshes in background \n✅ **Simple Filename**: Single `generation-lock.json` file for lock management \n✅ **Account-Level Caching**: Single `custom-routes.json` per account (not per binding) \n✅ **Centralized Constants**: All configuration in `utils.ts` \n✅ **Consistent Status Codes**: 404 when unavailable, 200 when serving data \n✅ **Daily Generation Safe**: 23-hour lock ensures next day's generation proceeds even if cleanup fails \n✅ **Error Resilience**: Background errors are logged but don't affect service availability\n\nSee also\n\n[Vtex.store SitemapVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/apps/vtex.store-sitemap)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM%5FROUTES%5FARCHITECTURE%23overview)\n\n[System Architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM%5FROUTES%5FARCHITECTURE%23system-architecture)\n\n[Background Processing Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM%5FROUTES%5FARCHITECTURE%23background-processing-flow)\n\n[VBase Storage Structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM%5FROUTES%5FARCHITECTURE%23vbase-storage-structure)\n\n[Response Status Codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM%5FROUTES%5FARCHITECTURE%23response-status-codes)\n\n[Key Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM%5FROUTES%5FARCHITECTURE%23key-components)\n\n[Files](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM%5FROUTES%5FARCHITECTURE%23files)[Constants (from utils.ts)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM%5FROUTES%5FARCHITECTURE%23constants-from-utilsts)[Background Generation Mechanism](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM%5FROUTES%5FARCHITECTURE%23background-generation-mechanism)[Generation Lock Mechanism](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM%5FROUTES%5FARCHITECTURE%23generation-lock-mechanism)[Caching Strategy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM%5FROUTES%5FARCHITECTURE%23caching-strategy)\n\n[Benefits](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM_ROUTES_ARCHITECTURE/docs/apps/vtex.store-sitemap@2.18.3/CUSTOM%5FROUTES%5FARCHITECTURE%23benefits)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_f239d1a2
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation roles in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[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-roles/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/api-reference)\n\n[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-roles/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/storefront-development)\n\n[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-roles/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/troubleshooting)\n\n[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-roles/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/vtex-io-documentation-policies)\n\n[Accessing external resources within a VTEX IO app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/accessing-external-resources-within-a-vtex-io-app)\n\n[Controlling access to app resources](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/controlling-access-to-app-resources)\n\n[Roles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/vtex-io-documentation-roles)\n\n[VTEX Resource Name (VRN)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/vtex-io-documentation-vrn)\n\n[Policies from License Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/vtex-io-documentation-policies-from-license-manager)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/vtex-io-documentation-policies)\n\n[Accessing external resources within a VTEX IO app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/accessing-external-resources-within-a-vtex-io-app)\n\n[Controlling access to app resources](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/controlling-access-to-app-resources)\n\n[Roles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/vtex-io-documentation-roles)\n\n[VTEX Resource Name (VRN)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/vtex-io-documentation-vrn)\n\n[Policies from License Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/vtex-io-documentation-policies-from-license-manager)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/app-development)\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/vtex-io-documentation-policies)\n\n[Roles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles/docs/guides/vtex-io-documentation-roles)\n\nRoles\n\nRoles are uniquely identifiable names given to request sources.\n\nWhenever a request is performed in the VTEX IO platform, the source of this action, which can be the user or app responsible for performing that request, automatically receives a unique role.\n\nIn the sequence, to detect whether or not the request source is authorized to perform that particular request, and also to determine if the call can go through, VTEX IO platform checks if the source role contains the required policies attached.\n\n> As a single request source can have different permissions within the same account, each role can also have multiple policies attached to it.\n\nSince apps and users are able to perform a request on the platform, both of them mandatorily receive roles. However, notice the following: app and user roles are structured in different formats.\n\nFor example: an user making a request would receive a role similar to `user:f1sd8705-b34f-48ff-a113-2b8bb8c22411`, or `user:<e-mail>`. Installed and linked apps, in turn, would receive roles as `app:vtex.auth-server@1.0.0` and `link:vtex.auth-server@1.0.0`.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/concepts/vtex-io-documentation-roles.md)\n\n[Controlling access to app resources« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles//docs/guides/controlling-access-to-app-resources)[VTEX Resource Name (VRN)Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles//docs/guides/vtex-io-documentation-vrn)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/concepts/vtex-io-documentation-roles.md)\n\nCopy page\n\nOn this page\n\nOn this page\n\n[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=)"
}
] |
doc_0c1b68fe
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX shipping option components 2.0.0 AvailabilityBadges app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/troubleshooting)\n\n[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.shipping-option-components@2.0.0/AvailabilityBadges/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/vtex-io-apps)\n\nAvailability Badges\n\n[vtex.shipping-option-components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components)\n\nVersion: 2.0.0\n\nLatest version: 2.0.0\n\nThe `availability-badges` block displays availability badges for product delivery and pickup.\n\n\n\n## Configuration\n\n1. Import the `shipping-option-components` app to your theme's dependencies in the manifest.json file as in the following example:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"shipping-option-components\": \"1.x\" \n\n3\n\n \n4\n\n } \n\n`\n\n1. Add the `availability-badges` block to the `product-summary.shelf` component. For example:\n\n`1\n\n \"product-summary.shelf\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"availability-badges\" \n\n4\n\n ] \n\n5\n\n } \n\n`\n\n### Props\n\nAlthough this block does not have explicit props, it uses the `ProductSummaryContext` and `useShippingOptionState` to retrieve delivery information.\n\n## Customization\n\nTo apply CSS customizations to this and other blocks, please see the [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) guide.\n\n| CSS Handles |\n| ------------------------ |\n| availabilityBadgeCircle |\n| availabilityPickupButton |\n\n## Notes\n\n* Delivery availability is defined at the product level.\n* Each product may or may not have each delivery method (Shipping and Pickup).\n* The store must be regionalized for the component to work correctly.\n\nSee also\n\n[Vtex.shipping Option ComponentsVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/apps/vtex.shipping-option-components)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges%23customization)\n\n[Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges/docs/apps/vtex.shipping-option-components@2.0.0/AvailabilityBadges%23notes)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_c5b4c409
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX store components 3.178.5 ShippingSimulator app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/troubleshooting)\n\n[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.store-components@3.178.5/ShippingSimulator/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/vtex-io-apps)\n\nShipping Simulator\n\n[vtex.store-components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components)\n\nVersion: 3.178.5\n\nLatest version: 3.178.5\n\nThe `shipping-simulator` block estimates the shipping cost based on a postal code input.\n\n\n\n## Configuration\n\n1. Import the `vtex.store-components` app to your theme's dependencies in the `manifest.json` file, as shown in the following example:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.store-components\": \"3.x\" \n\n3\n\n } \n\n`\n\n1. Add the `shipping-simulator` block to any child of the `store.product` template (Product Details Page template). For example:\n\n`1\n\n \"store.product\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"flex-layout.row#product\", \n\n4\n\n ] \n\n5\n\n }, \n\n6\n\n \"flex-layout.row#product\": { \n\n7\n\n \"children\": [ \n\n8\n\n+ \"shipping-simulator\" \n\n9\n\n ] \n\n10\n\n }, \n\n`\n\n1. Declare the `shipping-simulator` block using the props stated in the [Props](#props) table. For example:\n\n`1\n\n \"shipping-simulator\": { \n\n2\n\n \"props\": { \n\n3\n\n \"skuID\": \"342\" \n\n4\n\n } \n\n5\n\n }, \n\n`\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| --------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- |\n| pricingMode | enum | Defines how shipping information is displayed when a product includes gifts or attachments. You can choose to group shipping information by type (grouped) or display shipping costs for each item individually (individualItems). | individualItems |\n| seller | String | ID of the product seller. | \\- |\n| shouldUpdateOrderForm | Boolean | Determines whether interacting with the shipping simulator should update the shopper's address in their orderForm (true). This only works if the [orderform optimization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization) is enabled; otherwise, it has no effect, even if set to true. | true |\n| skuId | String | ID of the current product SKU. | \\- |\n\n## Customization\n\nTo apply CSS customizations to this and other blocks, see the guide[Using CSS handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization).\n\n| CSS Handles |\n| --------------------------------- |\n| shippingContainer |\n| shippingContainerLoader |\n| shippingCTA |\n| shippingInputLoader |\n| shippingNoMessage |\n| shippingTable |\n| shippingTableBody |\n| shippingTableCell |\n| shippingTableCellDeliveryEstimate |\n| shippingTableCellDeliveryName |\n| shippingTableCellDeliveryPrice |\n| shippingTableHead |\n| shippingTableHeadDeliveryEstimate |\n| shippingTableHeadDeliveryName |\n| shippingTableHeadDeliveryPrice |\n| shippingTableLabel |\n| shippingTableRadioBtn |\n| shippingTableRow |\n| shippingZipcodeLabel |\n| shippingZipcodeLabelLoader |\n\nSee also\n\n[Vtex.store ComponentsVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/apps/vtex.store-components)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/apps/vtex.store-components@3.178.5/ShippingSimulator%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/apps/vtex.store-components@3.178.5/ShippingSimulator%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ShippingSimulator/docs/apps/vtex.store-components@3.178.5/ShippingSimulator%23customization)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_b167512a
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore overrides syncing components with the headless cms in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Section override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/overrides-overview)\n\n[Overriding native component's props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/overrides-component-props)\n\n[Overriding a native component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/overrides-native-component)\n\n[Overriding section styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/overrides-section-styles)\n\n[\\`getOverriddenSection\\` function](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/overrides-getoverriddensection-function)\n\n[Syncing components with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms)\n\n[Migrating Overrides v1 to v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/overrides-migrating-v1-to-v2)\n\n[Overriding native components and props (v1)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/overrides-components-and-props-v1)\n\n[Section override - Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/override-use-cases-overview)\n\n[Creating a new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section)\n\n[List of native sections and overridable components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections)\n\n[Experimental exports - Hooks and Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/developing-and-overriding-components-experimental-exports-hooks-and-components)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Section override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/overrides-overview)\n\n[Overriding native component's props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/overrides-component-props)\n\n[Overriding a native component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/overrides-native-component)\n\n[Overriding section styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/overrides-section-styles)\n\n[\\`getOverriddenSection\\` function](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/overrides-getoverriddensection-function)\n\n[Syncing components with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms)\n\n[Migrating Overrides v1 to v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/overrides-migrating-v1-to-v2)\n\n[Overriding native components and props (v1)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/overrides-components-and-props-v1)\n\n[Section override - Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/override-use-cases-overview)\n\n[Creating a new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section)\n\n[List of native sections and overridable components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections)\n\n[Experimental exports - Hooks and Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/developing-and-overriding-components-experimental-exports-hooks-and-components)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Section override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/overrides-overview)\n\nSyncing components with the Headless CMS\n\nAfter incorporating overridden components, sections, and [updating the props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props) of FastStore native components, one crucial step is to ensure their availability in the Headless CMS.\n\n## Instructions\n\n1. In the FastStore root directory, create a folder named `cms`.\n2. Inside `cms`, create the `faststore` folder.\n3. Within the `cms/faststore` folder, create the `sections.json` file.\n4. Add the schema of the new section to the `sections.json` file. The schema defines how the Headless CMS renders the section. \n> Refer to the Step 3: Adding sections to the Headless CMS guide for further information on how to structure the schema. Also, refer to the [List of Native Sections and Overridable Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-list-of-native-sections) to check the schemas for each component.\n5. Open the terminal and log in to your vtex account by running `vtex login {accountName}`.\n6. run the following command to sync your changes with the Headless CMS: \n`1 \nfaststore cms-sync \n`\n7. Access the VTEX Admin and proceed to **Storefront > Headless CMS**.\n8. Click on the page you desire to add the new section.\n9. Click the add button (`+`) and add the new section.\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/developing-and-overriding-components/overrides/syncing-components-with-the-headless-cms.mdx)\n\n[\\`getOverriddenSection\\` function« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/overrides-getoverriddensection-function)[Migrating Overrides v1 to v2Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/overrides-migrating-v1-to-v2)\n\nSee also\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms%23instructions)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/developing-and-overriding-components/overrides/syncing-components-with-the-headless-cms.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms%23instructions)\n\nOn this page\n\n[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=)"
}
] |
doc_fc27aa46
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides managing your weni by vtex projects in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\nWeni by VTEX CLI\n\n[Using the Weni by VTEX CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/using-the-weni-by-vtex-cli)\n\n[Weni by VTEX CLI Command Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/weni-by-vtex-cli-command-reference)\n\n[Authenticating with your Weni by VTEX account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/authenticating-with-your-weni-by-vtex-account)\n\n[Managing your Weni by VTEX projects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/managing-your-weni-by-vtex-projects)\n\n[Understanding the core concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/weni-by-vtex-understanding-the-core-concepts)\n\n[Working with Weni by VTEX agents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/working-with-weni-by-vtex-agents)\n\n[Fetching and filtering logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/weni-by-vtex-fetching-and-filtering-logs)\n\n[Using Weni Run to execute tool tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/using-weni-run-to-execute-tool-tests)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\nWeni by VTEX CLI\n\n[Using the Weni by VTEX CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/using-the-weni-by-vtex-cli)\n\n[Weni by VTEX CLI Command Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/weni-by-vtex-cli-command-reference)\n\n[Authenticating with your Weni by VTEX account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/authenticating-with-your-weni-by-vtex-account)\n\n[Managing your Weni by VTEX projects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/managing-your-weni-by-vtex-projects)\n\n[Understanding the core concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/weni-by-vtex-understanding-the-core-concepts)\n\n[Working with Weni by VTEX agents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/working-with-weni-by-vtex-agents)\n\n[Fetching and filtering logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/weni-by-vtex-fetching-and-filtering-logs)\n\n[Using Weni Run to execute tool tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/using-weni-run-to-execute-tool-tests)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides)\n\nWeni by VTEX\n\nWeni by VTEX CLI\n\n[Managing your Weni by VTEX projects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/managing-your-weni-by-vtex-projects)\n\nManaging your Weni by VTEX projects\n\nManage your Weni by VTEX projects with the CLI.\n\nLearn how to manage your Weni by VTEX projects using the CLI.\n\n### Project Commands\n\n#### List Projects\n\nView all projects you have access to:\n\n`1\n\nweni project list \n\n`\n\nFilter projects by organization UUID:\n\n`1\n\nweni project list --org <org-uuid> \n\n`\n\nIf many results are available, you'll be prompted to load more pages (`p`) or quit (`q`).\n\nThis command shows:\n\n* Project UUID\n* Project name\n* Organization\n* Creation date\n\n#### Select Project\n\nSet a project as your current working project:\n\n`1\n\nweni project use <project-uuid> \n\n`\n\nReplace `<project-uuid>` with the UUID from the project list.\n\n#### View Current Project\n\nCheck which project you're currently working with:\n\n`1\n\nweni project current \n\n`\n\nThis prints the current project UUID stored by the CLI, e.g.: `Current project: <uuid>`\n\n### Project Context\n\nThe CLI maintains a \"current project\" context, which is used by other commands like `project push`. This context is stored in your `.weni_cli` file.\n\n#### Why Project Context Matters\n\n* Simplifies command usage (no need to specify project in every command)\n* Prevents accidental deployments to wrong projects\n* Maintains consistent workflow\n\n### Best Practices\n\n#### Project Organization\n\n1. **Naming Conventions** \n * Use clear, descriptive project names \n * Follow your organization's naming standards\n2. **Project Structure** \n * Keep related agents together \n * Maintain consistent file organization\n\n#### Working with Multiple Projects\n\n1. **Context Switching** \n * Always verify current project before operations \n * Use `project current` to confirm active project\n2. **Project Isolation** \n * Keep project-specific files in separate directories \n * Use version control for project configurations\n\n### Common Workflows\n\n#### Starting a New Project\n\n1. Create project in Weni by VTEX platform\n2. List projects to get UUID: \n`1 \nweni project list \n`\n3. Select the new project: \n`1 \nweni project use <new-project-uuid> \n`\n4. Verify selection: \n`1 \nweni project current \n`\n\n#### Managing Multiple Projects\n\n1. List available projects\n2. Switch between projects as needed\n3. Verify current project before operations\n4. Keep project files organized\n\n### Troubleshooting\n\n#### Common Issues\n\n1. **Project Not Found** \n * Verify project UUID \n * Check your access permissions \n * Ensure you're in the correct environment\n2. **Unable to Switch Projects** \n * Verify `.weni_cli` file permissions \n * Check authentication status \n * Confirm project exists and is accessible\n3. **Project List Empty** \n * Verify authentication \n * Check environment configuration \n * Confirm you have project access\n\n#### Getting Help\n\nIf you encounter issues:\n\n1. Check command syntax\n2. Verify project access\n3. Contact support if needed\n\nContributors\n\n1\n\n[](https://github.com/mariananantua)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Weni-by-VTEX/CLI/managing-your-weni-by-vtex-projects.md)\n\n[Authenticating with your Weni by VTEX account« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects//docs/guides/authenticating-with-your-weni-by-vtex-account)[Understanding the core conceptsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects//docs/guides/weni-by-vtex-understanding-the-core-concepts)\n\nContributors\n\n1\n\n[](https://github.com/mariananantua)\n\nON THIS PAGE\n\n[Project Commands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/managing-your-weni-by-vtex-projects%23project-commands)\n\n[Project Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/managing-your-weni-by-vtex-projects%23project-context)[Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/managing-your-weni-by-vtex-projects%23best-practices)[Common Workflows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/managing-your-weni-by-vtex-projects%23common-workflows)[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/managing-your-weni-by-vtex-projects%23troubleshooting)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Weni-by-VTEX/CLI/managing-your-weni-by-vtex-projects.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Project Commands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/managing-your-weni-by-vtex-projects%23project-commands)\n\n[Project Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/managing-your-weni-by-vtex-projects%23project-context)[Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/managing-your-weni-by-vtex-projects%23best-practices)[Common Workflows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/managing-your-weni-by-vtex-projects%23common-workflows)[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-your-weni-by-vtex-projects/docs/guides/managing-your-weni-by-vtex-projects%23troubleshooting)\n\nOn this page\n\n[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=)"
}
] |
doc_5c91ae22
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore getting started 3 faststore cli in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developer-tools-overview)\n\n[Configuration options for discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developer-tools-config-options)\n\n[Custom Cypress integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developer-tools-custom-cypress)\n\n[FastStore CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developer-tools-faststore-cli)\n\n[Updating the @fastore/cli package version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developer-tools-updating-the-cli-package-version)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developer-tools-overview)\n\n[Configuration options for discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developer-tools-config-options)\n\n[Custom Cypress integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developer-tools-custom-cypress)\n\n[FastStore CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developer-tools-faststore-cli)\n\n[Updating the @fastore/cli package version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developer-tools-updating-the-cli-package-version)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developer-tools-overview)\n\nFastStore CLI\n\nThe FastStore Command Line Interface (CLI) provides pre-configured scripts for starting, building, and developing FastStore projects. It also helps keep FastStore projects up to date with the [@faststore/core](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-overview%23packagejson) package.\n\n## Before you begin\n\nTo ensure the FastStore CLI commands related to the Headless CMS run correctly, make sure to install the Headless CMS, its dependencies and plugins as described in the [FastStore requirements](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-requirements).\n\n## Running FastStore CLI on the project\n\nThe CLI is automatically added as a dependency in your project's `package.json` file, so once you run `yarn install` during the [project setup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project), you can start using it in the project.\n\n## Installing FastStore CLI globally\n\nTo use FastStore CLI commands globally on your machine, install the [@faststore/cli](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-project-structure%23faststorecli) package:\n\nyarn\n\nnpm\n\n`1\n\nyarn global add @faststore/cli \n\n`\n\n## Default commands\n\nBelow is a brief description of the default commands available in the FastStore CLI. To view detailed information about each command, click the respective command name.\n\n> Running commands via `yarn` is sufficient for developing your store. However, to set up your project with the Headless CMS and create new sections, you must install the FastStore CLI globally and use its commands.\n\n| Command name | Description |\n| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [build](#build) | Generates a production-ready storefront. It compiles the project and optimizes it for production usage. |\n| [cms-sync](#cms-sync) | Syncs the cms folder of your FastStore project with the [Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview). |\n| [dev](#dev) | Starts the project in the development environment and uses http://localhost:3000 as the default server. It allows you to make changes to the project and see the results locally in real time without affecting the production environment. |\n| [generate](#generate) | Optimizes the schema and regenerates TypeScript types so that recent changes take effect without restarting the development server. |\n| [help](#help) | Displays help for FastStore CLI commands. |\n| [start](#start) | Executes the FastStore project in the root directory and uses http://localhost:3000 as the default server. |\n\n### `dev`\n\nStarts the project in the development environment and uses `http://localhost:3000` as the default server. This allows you to make changes to the project and see the results locally in real time without affecting the production environment.\n\n#### Usage\n\n`1\n\n yarn dev \n\n`\n\n`1\n\n faststore dev \n\n`\n\n 🔼 [Back](#default-commands)\n\n### `build`\n\nGenerates a production-ready storefront. It compiles the project and optimizes it for production usage.\n\n#### Usage\n\n`1\n\n yarn build \n\n`\n\n`1\n\n faststore build \n\n`\n\n 🔼 [Back](#default-commands)\n\n### `start`\n\nExecutes the FastStore project in the root directory and uses `http://localhost:3000` as the default server.\n\n#### Usage\n\n`1\n\n yarn start \n\n`\n\n`1\n\n faststore start \n\n`\n\n 🔼 [Back](#default-commands)\n\n### `cms-sync`\n\nSyncs the `cms` folder of your FastStore project with the Headless CMS.\n\n#### Usage\n\n`1\n\n yarn cms-sync \n\n`\n\n`1\n\n faststore cms-sync \n\n`\n\n 🔼 [Back](#default-commands)\n\n### `help`\n\nDisplays help for FastStore CLI commands.\n\n#### Usage\n\n`1\n\n yarn faststore help \n\n`\n\n`1\n\n faststore help [COMMAND] [-n] \n\n`\n\n 🔼 [Back](#default-commands)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/developer-tools/faststore-cli.mdx)\n\n[Custom Cypress integration« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developer-tools-custom-cypress)[Updating the @fastore/cli package versionNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developer-tools-updating-the-cli-package-version)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developer-tools-faststore-cli%23before-you-begin)\n\n[Running FastStore CLI on the project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developer-tools-faststore-cli%23running-faststore-cli-on-the-project)\n\n[Installing FastStore CLI globally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developer-tools-faststore-cli%23installing-faststore-cli-globally)\n\n[Default commands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developer-tools-faststore-cli%23default-commands)\n\n[dev](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developer-tools-faststore-cli%23dev)[build](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developer-tools-faststore-cli%23build)[start](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developer-tools-faststore-cli%23start)[cms-sync](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developer-tools-faststore-cli%23cms-sync)[help](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developer-tools-faststore-cli%23help)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/developer-tools/faststore-cli.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developer-tools-faststore-cli%23before-you-begin)\n\n[Running FastStore CLI on the project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developer-tools-faststore-cli%23running-faststore-cli-on-the-project)\n\n[Installing FastStore CLI globally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developer-tools-faststore-cli%23installing-faststore-cli-globally)\n\n[Default commands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developer-tools-faststore-cli%23default-commands)\n\n[dev](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developer-tools-faststore-cli%23dev)[build](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developer-tools-faststore-cli%23build)[start](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developer-tools-faststore-cli%23start)[cms-sync](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developer-tools-faststore-cli%23cms-sync)[help](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli/docs/guides/faststore/developer-tools-faststore-cli%23help)\n\nOn this page\n\n[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=)"
}
] |
doc_2b6cd311
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX product identifier app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[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-identifier/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/troubleshooting)\n\n[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-identifier/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/guides/basic-components)\n\nProduct Identifier\n\nOfficial extension\n\nVersion: 0.5.1\n\nLatest version: 0.5.1\n\n[](#contributors-)\n\nThe Product Identifier app is responsible for showing a product identifier, such as a product reference, product ID, SKU EAN, or SKU reference.\n\n\n\n## Configuration\n\n1. Add the `vtex.product-identifier` app to your Store Theme's dependencies in the `manifest.json` file: \n`1 \n\"dependencies\": { \n2 \n \"vtex.product-identifier\": \"0.x\" \n3 \n} \n`\n2. Add `product-identifier.product` block as a child of `product-summary.shelf`. \n`1 \n\"product-identifier.product\": { \n2 \n \"props\": { \n3 \n \"label\": \"default\", //'default' | 'custom' | 'hide' \n4 \n \"customLabel\": \"teste\", // text if label is custom \n5 \n \"idField\": \"skuReferenceId\" //'itemId' | 'productId' | 'productReference' | 'skuEan' | 'skuReferenceId' \n6 \n } \n7 \n}, \n`\n\nThe `product-identifier` interface can also be configured in the [Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-working-with-site-editor). You can choose to display the following identifiers:\n\n* Product Reference\n* Product ID\n* SKU EAN\n* SKU Reference ID\n* Item ID\n\nIt's also possible to customize or hide the label text. In the following example, the \"Reference\" text was substituted by \"Foo.\"\n\n\n\n## Customization\n\nTo apply CSS customization to this and other blocks, follow the instructions in the [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization) guide.\n\n| CSS Handles |\n| ------------------------------- |\n| product-identifier |\n| product-identifier\\_\\_label |\n| product-identifier\\_\\_separator |\n| product-identifier\\_\\_value |\n\n[Product Highlights« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-highlights)[Product ListNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-list)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-identifier%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier/docs/apps/vtex.product-identifier%23customization)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_a9b4e9bc
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides services conclusion in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/vtex-io-documentation-service)\n\n[Developing services on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/developing-services-on-vtex-io)\n\n[1\\. Getting started with the boilerplate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/services-1-getting-started-with-the-boilerplate)\n\n[2\\. Handling and receiving events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/services-2-handling-and-receiving-events)\n\n[3\\. Using the Analytics client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/services-3-using-the-analytics-client)\n\n[4\\. Using events as triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/services-4-using-events-as-triggers)\n\n[5\\. Using the Master Data client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/services-5-using-the-master-data-client)\n\n[6\\. Using GraphQL to retrieve data from Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/services-6-graphql-retrieving-data-from-master-data)\n\n[7\\. Using GraphiQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/services-7-using-graphiql)\n\n[Services - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/services-conclusion)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/vtex-io-documentation-clients)\n\nHandling events\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/service-path-patterns)\n\n[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/configuring-dynamic-routes-in-vtex-io-services)\n\n[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/vtex-io-documentation-developing-service-configuration-apps)\n\n[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/node-builder-7x-migration-guide)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/vtex-io-documentation-service)\n\n[Developing services on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/developing-services-on-vtex-io)\n\n[1\\. Getting started with the boilerplate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/services-1-getting-started-with-the-boilerplate)\n\n[2\\. Handling and receiving events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/services-2-handling-and-receiving-events)\n\n[3\\. Using the Analytics client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/services-3-using-the-analytics-client)\n\n[4\\. Using events as triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/services-4-using-events-as-triggers)\n\n[5\\. Using the Master Data client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/services-5-using-the-master-data-client)\n\n[6\\. Using GraphQL to retrieve data from Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/services-6-graphql-retrieving-data-from-master-data)\n\n[7\\. Using GraphiQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/services-7-using-graphiql)\n\n[Services - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/services-conclusion)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/vtex-io-documentation-clients)\n\nHandling events\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/service-path-patterns)\n\n[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/configuring-dynamic-routes-in-vtex-io-services)\n\n[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/vtex-io-documentation-developing-service-configuration-apps)\n\n[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/node-builder-7x-migration-guide)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/app-development)\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/vtex-io-documentation-service)\n\n[Developing services on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/developing-services-on-vtex-io)\n\n[Services - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/services-conclusion)\n\nServices - Conclusion\n\nThrough this tutorial, we have explored the capability to export routes, manage events, and establish connections with both internal and external applications, enabling you to optimize your applications and leverage VTEX IO infrastructure.\n\n## Next steps\n\n[ServiceIn the VTEX IO ecosystem, services play a crucial role by allowing you to run .NET and Node.js code directly on VTEX servers. Services enable VTEX IO apps to export HTTP routes, GraphQL resolvers, and event handlers to the server.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/services/services-conclusion.mdx)\n\n[7\\. Using GraphiQL« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion//docs/guides/services-7-using-graphiql)[Calling commerce APIs on VTEX IONext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion//docs/guides/calling-commerce-apis-on-vtex-io)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/services-conclusion%23next-steps)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/services/services-conclusion.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-conclusion/docs/guides/services-conclusion%23next-steps)\n\nOn this page\n\n[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=)"
}
] |
doc_a94724a8
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX google customer reviews app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/troubleshooting)\n\n[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.google-customer-reviews/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/vtex-io-apps)\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/guides/pixel-apps)\n\nGoogle Customer Reviews\n\nOfficial extension\n\nVersion: 1.1.1\n\nLatest version: 1.1.1\n\n[](#contributors-)\n\nThis is a first party integration app for Google Customer Reviews, a free service that enables Google to collect valuable feedback from customers who’ve made a purchase on your site.\n\n\n\n## Configuration\n\n1. [Install](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/store/installing-an-app) the `vtex.google-customer-reviews` app in your VTEX account.\n\n> _By installing the Google Customer Reviews, you will have access to the `google-customer-review-badge` block, which displays the Google Customer Reviews badge on your store's UI. To know how to set it up, check out the **Advanced Configuration** section below._\n\n1. In your account's admin, open the **Apps** section and select the **Google Customer Reviews** box.\n2. Click on the settings icon and add your **Merchant Center ID**. You can get this value from the \\[Google Merchant Center\\](<https://www.google.com/retail/solutions/merchant-center/>.\n3. Save your changes.\n\n### Advanced Configuration\n\nTo display the Google Customer Reviews badge in your store, follow the instructions below:\n\n1. Add the Google Customer Reviews app to your theme's `peerDependency` list:\n\n`1\n\n \"peerDependencies\": { \n\n2\n\n \"vtex.reviews-and-ratings\": \"2.x\", \n\n3\n\n+ \"vtex.google-customer-reviews\": \"1.x\" \n\n4\n\n }, \n\n`\n\n> _To be successful in the first step, you will need to update your theme to a new major version. Learn how to perform this update following the instructions given in [this tutorial](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/development/migrating-CMS-settings-after-major-update/)._\n\n1. Add the `google-customer-review-badge` block to your theme's in the desired template. For example:\n\n`1\n\n \"flex-layout.row#footer-1-desktop\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"vtex.menu@2.x:menu#Products\", \n\n4\n\n \"vtex.menu@2.x:menu#footer-clothing\", \n\n5\n\n \"vtex.menu@2.x:menu#footer-decoration\", \n\n6\n\n \"vtex.menu@2.x:menu#footer-bags\", \n\n7\n\n \"footer-spacer\", \n\n8\n\n \"social-networks\", \n\n9\n\n+ \"google-customer-review-badge\" \n\n10\n\n ], \n\n11\n\n \"props\": { \n\n12\n\n \"blockClass\": \"menu-row\", \n\n13\n\n \"paddingTop\": 6, \n\n14\n\n \"paddingBottom\": 3 \n\n15\n\n } \n\n16\n\n }, \n\n`\n\n1. [Deploy your theme changes](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/store-management/making-your-theme-content-public/).\n\n## Troubleshooting\n\nThis app only works with the website URL verified and claimed in Merchant Center. When the website URL is not verified, a 404 javascript error is generated.\n\n[Google Adwords« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.google-adwords)[HotjarNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.hotjar)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.google-customer-reviews%23configuration)\n\n[Advanced Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.google-customer-reviews%23advanced-configuration)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-customer-reviews/docs/apps/vtex.google-customer-reviews%23troubleshooting)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_36f038ee
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides getting started with storefront solutions in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/docs/storefront-development)\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/docs/guides/getting-started-with-storefront-solutions)\n\nGetting started with storefront solutions\n\nLearn about the main differences between VTEX storefront solutions.\n\nThe VTEX platform provides three options for storefront development, each with distinct characteristics. This guide compares them to help you choose the best option for your business needs.\n\n* **FastStore:** Innovative technology that prioritizes performance and stability, offering operational teams an easily maintainable solution for editing store pages.\n* **Store Framework:** A composable commerce model that allows integrating VTEX IO apps for dynamic storefronts.\n* **Legacy CMS Portal:** VTEX's first storefront technology that relies on HTML, CSS, and JavaScript, with code management exclusively through the VTEX Admin.\n\nThe following table outlines the main differences between VTEX FastStore, Store Framework, and Legacy CMS Portal.\n\n| FastStore | Store Framework | Legacy CMS Portal | |\n| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **Storefront development** | FastStore is built with a **performance** focus based on the Jamstack (JavaScript, API, and Markup) architecture.Development is done through the integration of npm packages provided by VTEX and customizations via the extensibility of VTEX API core services. | Store Framework is based on **composability**, built on VTEX IO apps, allowing for the combination of different content, services, and data. | Development is done through the Admin, using the [Legacy Content Management System (CMS)](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/6OCY6S9tqBXPD5mgpbBInC). |\n| **Tech stack** | [React](https://read.calvincode.net/reader?url=https://react.dev/)[TypeScript](https://read.calvincode.net/reader?url=https://www.typescriptlang.org/)[Node.js](https://read.calvincode.net/reader?url=https://nodejs.org/)[Next.js](https://read.calvincode.net/reader?url=https://nextjs.org/)[GraphQL](https://read.calvincode.net/reader?url=https://graphql.org/) | [React](https://read.calvincode.net/reader?url=https://react.dev/)[TypeScript](https://read.calvincode.net/reader?url=https://www.typescriptlang.org/)[Node.js](https://read.calvincode.net/reader?url=https://nodejs.org/)[.NET](https://read.calvincode.net/reader?url=https://learn.microsoft.com/en-us/dotnet/)[GraphQL](https://read.calvincode.net/reader?url=https://graphql.org/) | [CSS](https://read.calvincode.net/reader?url=https://developer.mozilla.org/pt-BR/docs/Web/CSS/)HTMLJavaScript |\n| **Starter (initial template)** | After completing the [FastStore Starter](https://read.calvincode.net/reader?url=https://starter.vtex.app/), you can access [FastStore Onboarding](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project). This allows you to kick off a project with a base template optimized for performance. | [Store Theme](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-theme) is the initial template you can use to launch your storefront project or start from scratch. | The [Layout](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/1oN446gRGcR2s70RvBCAmj%23layout) section allows you to build your storefront with HTML and CSS.There, you'll find the standard [templates](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-are-templates--4l7BQBYO9ycumsqua2CU88), which are files that contain the code for your website pages. |\n| **CMS solution** | Integrated with [Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview). | Integrated with [Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor). | The [Layout](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-cms-layout--EmO8u2WBj2W4MUQCS8262) feature allows you to build your storefront with HTML and CSS. |\n| **Deployment platform** | Store deployment through [FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project) and VTEX GitHub quality-assurance bots. | Store deployment through the [VTEX IO platform](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io) using the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference). | Content updates are made directly through the CMS. |\n| **Deployment environment** | Supports running a [local server](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project%23step-2-running-a-local-server), which works as a development environment. Changes made in the local development server don't impact the live store. | Supports creating [development workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace) and [production workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace), allowing developers to deploy changes confidently, without affecting the live store. | No separate development environment. |\n| **Admin Apps (Extensions Hub)** | VTEX IO backend apps can work on FastStore via [API Extensions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview). Frontend apps that manipulate React components aren't supported. | Allows installation and use. | Allows installation and use of some apps. |\n| **Customizations** | Performance-focused: Allows customization through [Theming](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview), [Overrides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview), [API extensions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview), and [Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview) features. | Composability-focused: Flexible and customizable through [VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps). | Customizations are limited and can be managed by creating, organizing, and editing the structure of folders, files, and components within the [Layout](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/1oN446gRGcR2s70RvBCAmj%23layout) feature. |\n| **Performance** | Maximum performance possible, as it uses [Jamstack](https://read.calvincode.net/reader?url=https://jamstack.org/), a framework focused on performance that serves pre-rendered content to a CDN. It is made dynamic through APIs and serverless functions.Additionally, FastStore leverages [Partytown](https://read.calvincode.net/reader?url=https://partytown.builder.io/) to minimize performance degradation caused by third-party scripts.Built with performance as a core principle, FastStore not only optimizes speed but also provides clear visibility into performance metrics, ensuring transparency. | SSR (Server-Side Rendering) generates the complete HTML of a page on the server in response to a page request, while an SPA (Single-Page Application) loads elements such as the header only once the page is loaded. | Outdated technologies make it challenging to maintain optimal performance, especially in scenarios demanding multiple customizations. |\n| **Availability**_You can have both FastStore and Store Framework running simultaneously in your store, as the environments are completely different._ | General availability.For information on unavailable features, check the [Business models](#business-models) and [Features and functionalities](#features-and-functionalities) sections. | General availability. | No longer available to newly created VTEX stores. |\n| **Support**_To learn more about our support, see our documentation [Responsibilities within the VTEX ecosystem](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/responsabilidades-no-ecossistema-vtex--3vL9aWICDr3WR64DYi1fJ3)._ | Available for VTEX core commerce services, [FastStore packages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/docs-what-is-faststore), and troubleshooting code issues. | Available for VTEX core commerce services, VTEX IO native apps or components, and troubleshooting code issues. | Available for [VTEX core commerce services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started%23vtex-core-services), and VTEX native [Controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates) and [Templates](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-are-templates--4l7BQBYO9ycumsqua2CU88). |\n\n## Business models\n\nThe VTEX platform supports the configuration of different business models, such as business-to-business (B2B), marketplaces, omnichannel, and internationalization. See below the availability for each storefront technology.\n\n| FastStore | Store Framework | Legacy CMS Portal | |\n| -------------------------------------------------------------------------------------------------------------------------------- | --------------- | ----------------- | - |\n| [**B2B capabilities**](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/b2b-overview--5vb9SNXhX2bZnkpAh7ADdC?%26utm%5Fsource=autocomplete) | ❌ | ✅ | ❌ |\n| [**Bindings**](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-binding--4NcN3NJd0IeYccgWCI8O2W?%26utm%5Fsource=autocomplete) | ❌ | ✅ | ✅ |\n| [**Cross-border and multi-language stores**](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/5qgXy9Erm7FDP3UB5Ox8Bs) | ❌ | ✅ | ❌ |\n| [**Franchise accounts**](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-a-franchise-account--kWQC6RkFSCUFGgY5gSjdl) | ✅ | ✅ | ✅ |\n| [**Marketplace capabilities**](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/marketplace-strategies-at-vtex--tutorials%5F402) | ✅ | ✅ | ✅ |\n| [**Multiple trade policies**](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV) | ✅ | ✅ | ✅ |\n\n## Features and functionalities\n\nExplore below the features and functionalities available for each storefront technology. Consider the following:\n\n✅ **Available:** A ready-to-use, out-of-the-box feature.\n\n⚠️ **Limited:** The feature is available but requires a custom implementation. To assess whether it's viable for your project, open a ticket with [VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support).\n\n❌ **Not available:** This feature is currently unavailable, even with customizations.\n\n### Advanced store functionalities\n\n| FastStore | Store Framework | Legacy CMS Portal | |\n| --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | ----------------- | - |\n| [**Abandoned Cart**](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/setting-up-abandoned-carts--tutorials%5F740) | ⚠️ | ✅ | ✅ |\n| [**Attachments**](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-an-attachment--aGICk0RVbqKg6GYmQcWUm) | ✅ | ✅ | ✅ |\n| [**Coupons**](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/coupons-beta--1aAEN3ADpz19ss5JCIEBdL) | ✅ | ✅ | ✅ |\n| [**Delivery Promise**](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/delivery-promise-beta--p9EJH9GgxL0JceA6dBswd) | ✅ | ✅ | ❌ |\n| [**Gift Card**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/gift-card-integration-guide) **integration** | ✅ | ✅ | ✅ |\n| [**GTM - Google Analytics 4**](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-to-setup-google-analytics-in-vtex-store--G2P0rmSrEiqCcmUMyUUwG) | ✅ | ✅ | ✅ |\n| [**Intelligent Search**](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search) **integration** | ✅ | ✅ | ❌ |\n| [**Live Shopping**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexventures.livestreaming) | ✅ (experimental feature) | ✅ | ✅ |\n| [**Master Data**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data) **integration** | ⚠️ | ✅ | ✅ |\n| [**Newsletter integration with Master Data**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1) | ✅ | ✅ | ✅ |\n| [**Price table**](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-price-tables--58YmY2Iwggyw4WeSCGg24S) | ✅ | ✅ | ✅ |\n| [**Promotions**](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-promotions--tutorials%5F320) | ✅ | ✅ | ✅ |\n| [**Regionalization**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-regionalization) | ✅ | ✅ | ❌ |\n| [**SmartCheckout**](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/smartcheckout-customer-information-automatic-fill-in--2Nuu3xAFzdhIzJIldAdtan) | ✅ | ✅ | ✅ |\n| [**Sitemap**](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/rastreamento-google-search-console-sitemap--tutorials%5F575) **integration** | ✅ | ✅ | ✅ |\n| [**Subscription**](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-subscriptions-work--frequentlyAskedQuestions%5F4453) | ✅ | ✅ | ✅ |\n| **Support for** [**VTEX IO frontend apps**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io) | ❌ | ✅ | ❌ |\n\n### Development experience\n\n| FastStore | Store Framework | Legacy CMS Portal | |\n| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |\n| **API integration** | ✅ [FastStore APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview) | ✅ [API reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference) | ✅ [API reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference) |\n| **Automatic storefront updates** | ✅ | ✅ | ❌ |\n| **Command Line Interface (CLI)** | ✅ [FastStore CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli) | ✅ [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference) | ❌ |\n| **GitHub [WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project) workflow** | ✅ | ❌ | ❌ |\n\nLearn more in [Developer experience](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developer-experience).\n\nContributors\n\n4\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/barbara-celi)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/getting-started-with-storefront-solutions.md)\n\n[FastStoreNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions//docs/guides/faststore)\n\nContributors\n\n4\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/barbara-celi)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Business models](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/docs/guides/getting-started-with-storefront-solutions%23business-models)\n\n[Features and functionalities](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/docs/guides/getting-started-with-storefront-solutions%23features-and-functionalities)\n\n[Advanced store functionalities](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/docs/guides/getting-started-with-storefront-solutions%23advanced-store-functionalities)[Development experience](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/docs/guides/getting-started-with-storefront-solutions%23development-experience)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/getting-started-with-storefront-solutions.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Business models](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/docs/guides/getting-started-with-storefront-solutions%23business-models)\n\n[Features and functionalities](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/docs/guides/getting-started-with-storefront-solutions%23features-and-functionalities)\n\n[Advanced store functionalities](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/docs/guides/getting-started-with-storefront-solutions%23advanced-store-functionalities)[Development experience](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions/docs/guides/getting-started-with-storefront-solutions%23development-experience)\n\nOn this page\n\n[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=)"
}
] |
doc_2b5aea32
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides headless catalog in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/headless-commerce)\n\n[Headless catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/headless-catalog)\n\n[Headless cart and checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/headless-cart-and-checkout)\n\n[Headless profile management and order history](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/headless-profile-management-and-order-history)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/headless-commerce)\n\n[Headless catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/headless-catalog)\n\n[Headless cart and checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/headless-cart-and-checkout)\n\n[Headless profile management and order history](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/headless-profile-management-and-order-history)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides)\n\nIntegration Guides\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/headless-commerce)\n\n[Headless catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/headless-catalog)\n\nHeadless catalog\n\nBe it through category menus, keyword searches, or product pages, shoppers accessing your headless store will need to browse through your products' information.\n\nBelow you can learn more about API endpoints you can use to help shoppers find what they need in your store. See the [catalog documentation](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/3rA2tTpIoEXdv2nzC27zxR) to learn how to manage products, SKUs and categories, among other things.\n\n> You can filter the results of the endpoints below by [trade policy](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV?%26utm%5Fsource=autocomplete) with the query parameter `sc={tradePolicy}`.\n\n## Categories\n\nOne of the ways shoppers will interact with your product information is by browsing through a categories menu.\n\nUse the following endpoint to fetch category information:\n\n* [Get category tree](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pub/category/tree/-categoryLevels-)\n\n## Search\n\nInstead of browsing categories, shoppers may prefer to type a keyword into your store’s search bar to find what they want. VTEX provides two different search solutions for your store. We recommend that you use [Intelligent Search](#intelligent-search), but you have the option to use the [Legacy CMS Portal search](#legacy-search) if you wish.\n\n> Learn more about [VTEX Intelligent Search](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/3qgT47zY08biLP3d5os3DG).\n\n### Intelligent Search\n\nBefore implementing Intelligent Search in your headless storefront, make sure to check this [Intelligent Search guide](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/3qgT47zY08biLP3d5os3DG) and make the necessary configurations.\n\nTo retrieve products with the Intelligent Search API, use this endpoint:\n\n* [Get list of products for a query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api%23get-/product%5Fsearch/-facets-)\n\nFor any given Intelligent Search query, you can get search facets and display them so that your shoppers can narrow their search.\n\n* [Get list of the possible facets for a given query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api%23get-/facets/-facets-)\n\nShoppers may have trouble coming up with the optimal search term for their needs. Use these endpoints to help fill in the gaps:\n\n* [Get attempt of correction of a misspelled term](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api%23get-/correction%5Fsearch)\n* [Get list of suggested terms similar to the search term](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api%23get-/search%5Fsuggestions)\n\n#### Banners\n\nYou can use the Intelligent Search [banners feature](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/4ViKEivLJtJsvpaW0aqIQ5) with this endpoint:\n\n* [Get list of banners registered for query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api%23get-/banners/-facets-)\n\n#### Intelligent Search autocomplete\n\nYou can also improve shopping experience by implementing an [autocomplete feature](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/4gXFsEWjF7QF7UtI2GAvhL). Use this endpoint to get suggested search terms based on a provided term:\n\n* [Get list of suggested terms and attributes similar to the search term](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api%23get-/autocomplete%5Fsuggestions)\n\nYou can also get the most searched terms on your site:\n\n* [Get list of the 10 most searched terms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api%23get-/top%5Fsearches)\n\n### Legacy Search\n\nTo retrieve products with the Legacy Search, use this endpoint:\n\n* [Search for Products with Filter, Order and Pagination](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/search-api%23get-/api/catalog%5Fsystem/pub/products/search)\n\nNote that this endpoint provides multiple filtering and ordering options that can be made available for the shopper to narrow their search, improving the user’s experience. Handy examples include:\n\n* Searching within specific category levels (department, category and subcategory): `https://{accountName}.vtexcommerce{environment}.com.br/api/catalog_system/pub/products/search/{department}/{category}/{subcategory}`\n* Filtering products by [collection](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/4hN41yU8IPeb8HKmmaXoca): query string `fq=productClusterIds:{collectionId}`\n* Sorting by best discount: query string `O=OrderByBestDiscountDESC`\n\n> See the [Search endpoint documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/search-api%23get-/api/catalog%5Fsystem/pub/products/search) to learn about all filtering and sorting options.\n\n#### Legacy Search autocomplete\n\nYou can also implement an autocomplete feature to your store’s search bar using Legacu Search. To do this, use this endpoint:\n\n* [Product Search Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/search-api%23get-/buscaautocomplete)\n\n## Product details\n\nOn product pages and maybe other sections of your headless store, you will need to get information on specific products. To do this, you can use one of these endpoints:\n\n* [Search Product by Product URL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/search-api%23get-/api/catalog%5Fsystem/pub/products/search/-product-text-link-/p)\n* [Search for Products with Filter, Order and Pagination](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/search-api%23get-/api/catalog%5Fsystem/pub/products/search) \n * Filter by product ID: `fq=productId:{productId}` \n * Filter by SKU ID: `fq=skuId:{skuId}`\n\n### Cross selling\n\nWhen a shopper is interested in a product, it may be a good idea to display related products that they may be interested in purchasing as well.\n\nSee this guide to learn [how to set up cross selling](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/configurando-produto-similar-sugestoes-acessorios-e-genericos--tutorials%5F280) capabilities and use the endpoints below to retrieve this information on your storefront:\n\n* [Get Product Search of Show Together](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/search-api%23get-/api/catalog%5Fsystem/pub/products/crossselling/showtogether/-productId-)\n* [Get Product Search of Accessories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/search-api%23get-/api/catalog%5Fsystem/pub/products/crossselling/accessories/-productId-)\n* [Get Product Search of Similars](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/search-api%23get-/api/catalog%5Fsystem/pub/products/crossselling/similars/-productId-)\n* [Get Product Search of Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/search-api%23get-/api/catalog%5Fsystem/pub/products/crossselling/suggestions/-productId-)\n\n## Learn more\n\nSee these other guides to learn more about building a headless shopping experience using VTEX:\n\n* [Headless commerce overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-commerce)\n* [Headless cart and checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-cart-and-checkout)\n* [Headless profile management and order history](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history)\n\nContributors\n\n2\n\n[](https://github.com/PedroAntunesCosta)\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/headless-commerce/headless-catalog.md)\n\n[Headless commerce« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog//docs/guides/headless-commerce)[Headless cart and checkoutNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog//docs/guides/headless-cart-and-checkout)\n\nContributors\n\n2\n\n[](https://github.com/PedroAntunesCosta)\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Categories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/headless-catalog%23categories)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/headless-catalog%23search)\n\n[Intelligent Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/headless-catalog%23intelligent-search)[Legacy Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/headless-catalog%23legacy-search)\n\n[Product details](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/headless-catalog%23product-details)\n\n[Cross selling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/headless-catalog%23cross-selling)\n\n[Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/headless-catalog%23learn-more)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/headless-commerce/headless-catalog.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Categories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/headless-catalog%23categories)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/headless-catalog%23search)\n\n[Intelligent Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/headless-catalog%23intelligent-search)[Legacy Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/headless-catalog%23legacy-search)\n\n[Product details](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/headless-catalog%23product-details)\n\n[Cross selling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/headless-catalog%23cross-selling)\n\n[Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog/docs/guides/headless-catalog%23learn-more)\n\nOn this page\n\n[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=)"
}
] |
doc_c3c1a732
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides pii data architecture specifications in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/data-protection-plus)\n\n[PII Data Architecture specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/pii-data-architecture-specifications)\n\n[Data residency](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/data-residency)\n\n[Profile System integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/profile-system)\n\n[Working with schemas in the Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/working-with-schemas-in-the-profile-system)\n\n[Changes in VTEX features behavior to handle PII data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data)\n\n[Limitations of the PII data architecture during closed beta](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/limitations-of-the-pii-data-architecture-during-closed-beta)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/data-protection-plus)\n\n[PII Data Architecture specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/pii-data-architecture-specifications)\n\n[Data residency](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/data-residency)\n\n[Profile System integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/profile-system)\n\n[Working with schemas in the Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/working-with-schemas-in-the-profile-system)\n\n[Changes in VTEX features behavior to handle PII data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data)\n\n[Limitations of the PII data architecture during closed beta](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/limitations-of-the-pii-data-architecture-during-closed-beta)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides)\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/data-protection-plus)\n\n[PII Data Architecture specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/pii-data-architecture-specifications)\n\nPII Data Architecture specifications\n\n> [Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-protection-plus) is in closed beta phase, only available in select regions. \n> \n> This feature is part of [VTEX Shield](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our [contact form](https://read.calvincode.net/reader?url=https://vtex.com/us-en/contact/).\n\nVTEX's comprehensive PII data architecture, available for stores using [Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-protection-plus), incorporates a range of solutions and processes for managing personally identifiable information (PII). Here you can find detailed information about how this architecture works to ensure the protection of shoppers' data privacy.\n\nRead the sections below to learn more about:\n\n* [Profile system](#profile-system) \n * [Data entities](#data-entities) \n * [Communication with other VTEX modules](#communication-with-other-vtex-modules) \n * [Versioning](#versioning)\n* [Encryption](#encryption)\n* [Tokenization](#tokenization)\n* [Default data masking](#default-data-masking)\n* [Auditability](#auditability)\n* [Marketplaces](#marketplaces) \n * [Scenario 1: Your store acts as a marketplace](#scenario-1-your-store-acts-as-a-marketplace) \n * [Scenario 2: Your store acts as a seller](#scenario-2-your-store-acts-as-a-seller)\n* [Changes in VTEX features default behavior](#changes-in-vtex-features-default-behavior)\n* [Limitations during closed beta](#limitations-during-closed-beta)\n\n## Profile system\n\nThe [Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system) is VTEX's single source of truth regarding shoppers' profile data, for stores using [Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-protection-plus). Other modules, such as **Checkout** and **Order Management**, can request data from the **Profile System** when necessary.\n\nThis means that **Profile System** information is subject to specific data guidelines and processes, appropriate to handling PII. These specifications also apply whenever other VTEX modules communicate with the **Profile System**. In the following sections, you can learn more about these specifications.\n\nYou can integrate with the Profile System via its REST APIs, as described in the [Profile System integration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system).\n\n> The **Profile System** does not hold credit card information. Instead, all credit card data, including billing addresses, is processed and stored in a [PCI-compliant](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/what-is-the-pci-ssc--4jo3Vkox3amSO2w4qIWa0E) manner for all VTEX stores, regardless of any differences in data architecture. This ensures that VTEX adheres to the best practices of data protection regulations related to handling credit card PII. Learn more about [VTEX PCI certification](https://read.calvincode.net/reader?url=https://secure.vtex.com/?an=VTEX).\n\n### Data entities\n\nThe Profile System has three data entities:\n\n* **Prospect:** information entered by shoppers during cart and Checkout flow.\n* **Profile:** prospect information can become a profile if the shopper creates a profile, which can happen via order placement, manual profile creation, or [single sign-on integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview%23single-sign-on-integrations).\n* **Address:** once a prospect or profile places an order, the shipping address information is saved and associated with the respective profile. Note that a single profile may be associated with multiple shipping addresses.\n\n> The **address** data entity only stores shipping addresses. All credit card related PII, including billing addresses, is stored and processed in a [PCI compliant](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/what-is-the-pci-ssc) manner for all VTEX stores, regardless of any differences in data architecture.\n\n### Communication with other VTEX modules\n\nSome VTEX modules may need to access PII data from the Profile System: Checkout, Order Management and Message Center's transactional emails. Consider, for instance, a shopper that wishes to see their previous order history, including addresses and payment methods used at your store. In this case, the Order Management module must be able to display their own PII to them.\n\n> Although shopper data flows from Checkout to the Profile System, no data is stored by the Checkout module. The same applies to Order Management and Message Center's transactional emails, as these may access shopper data from the Profile System at times, but do not keep any of it.\n\nThe diagram below shows the information flow whenever another VTEX module requests unmasked PII from the Profile System.\n\nVTEX moduleProfile SystemLicense ManagerAuditProfile System databaseRequester, shopper token, reasonRequester credentials, Shopper token, ReasonAuthorizedRequester, shopper token, reasonShopper tokenPIIPIIVTEX moduleProfile SystemLicense ManagerAuditProfile System database\n\nWhen another VTEX module needs [unmasked](#default-data-masking) information from the Profile System it may request it, while informing:\n\n* Shopper [token](#tokenization).\n* Requester credentials.\n* Reason for requesting data.\n\nThen the Profile System proceeds with the following actions:\n\n1. Check whether the requester can access that data. If they do, it proceeds to the next steps.\n2. Log [Audit](#auditability) event.\n3. Retrieve [encryption key](#encryption) from the encryption key management system.\n4. Decrypt information.\n5. Return information to the requester.\n\nThese steps ensure access control with specific authorization and auditability of each access.\n\n### Versioning\n\nThe Profile System works with versioning, meaning that each [token](#tokenization) may have multiple versions. Because of this, every change is safely stored and other modules' related information, such as order history is not compromised due to profile changes made by users.\n\n## Encryption\n\nAll PII is encrypted with a unique key for each store. The [Profile System](#profile-system) uses AES GCM with an encryption key of 256 bits. VTEX does not share the encryption keys with any external entity, not even with the corresponding merchants.\n\n> The encryption key management system is a separate system and can only be accessed by the Profile System.\n\n## Tokenization\n\nAll PII is tokenized, meaning it is indexed under a token, which is a unique shopper ID internal to VTEX.\n\nThe diagram below exemplifies this communication in the case of a [Get order request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/oms/pvt/orders/-orderId-) from the Payments module to Order Management.\n\nPaymentsOrder managementGet orderOrder information with pseudonymised profile dataPaymentsOrder management\n\nModules may need to index PII information for purposes such as search. In this case, the data is hashed, meaning it can not be reversed. This minimizes requests to the [Profile System](#profile-system) and overall latency of the shopping experience.\n\nSee how the platform hashes this data in this case:\n\n1. Concatenate information with an account specific salt.\n2. Apply SHA256 to the resulting string.\n\nThis process is irreversible. So the information is safe even if the request indexer data becomes exposed.\n\n## Default data masking\n\nPII is masked by default. This means that when you access a shopper's order history in VTEX Admin panel or when you request their profile information via API, for example, any PII information returned will be masked.\n\nHowever, unmasked data can be requested by modules, integrations, and store operators with the appropriate [permissions](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc).\n\nSee examples, as returned by [Profile System APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system%23masked-data).\n\nMasked profile:\n\n`1\n\n{ \n\n2\n\n \"id\": \"70caf394-8534-447e-a0ca-1803c669c771\", \n\n3\n\n \"meta\": { \n\n4\n\n \"version\": \"abc\", \n\n5\n\n \"author\": \"e40e0b6d-0605-4fa6-8176-1d69fbaf0818\", \n\n6\n\n \"creationDate\": \"13/12/2021T00:00:00Z\", \n\n7\n\n \"lastUpdate\": \"13/12/2021T00:00:00Z\" \n\n8\n\n }, \n\n9\n\n \"document\": { \n\n10\n\n \"firstName\": \"J***\", \n\n11\n\n \"lastName\": \"D**\", \n\n12\n\n \"email\": \"j***.d**@e******.c**\", \n\n13\n\n \"birthDate\": \"1925-11-17\", \n\n14\n\n \"document\": \"1**********\", \n\n15\n\n \"documentType\": \"CPF\" \n\n16\n\n } \n\n17\n\n} \n\n`\n\nUnmasked profile:\n\n`1\n\n{ \n\n2\n\n \"id\": \"70caf394-8534-447e-a0ca-1803c669c771\", \n\n3\n\n \"document\": { \n\n4\n\n \"firstName\": \"John\", \n\n5\n\n \"lastName\": \"Doe\", \n\n6\n\n \"email\": \"john.doe@example.com\", \n\n7\n\n \"birthDate\": \"1925-11-17\", \n\n8\n\n \"document\": \"12345678911\", \n\n9\n\n \"documentType\": \"CPF\" \n\n10\n\n }, \n\n11\n\n \"meta\": { \n\n12\n\n \"version\": \"abc\", \n\n13\n\n \"author\": \"e40e0b6d-0605-4fa6-8176-1d69fbaf0818\", \n\n14\n\n \"creationDate\": \"13/12/2021T00:00:00Z\", \n\n15\n\n \"lastUpdate\": \"13/12/2021T00:00:00Z\" \n\n16\n\n } \n\n17\n\n} \n\n`\n\n> Learn more about retrieving unmasked data with the [Profile System integration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system%23masked-data).\n\n## Auditability\n\nThe VTEX platform enables stores to audit actions of store operators with the [Audit module](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/searching-for-events-on-audit--5RXf9WJ5YLFBcS8q8KcxTA), including actions related to personal data and PII.\n\nEvery successful request to unmasked personal data and PII generates a log on [Audit](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/searching-for-events-on-audit--5RXf9WJ5YLFBcS8q8KcxTA). This includes the Id of the store operator that requested this information.\n\nYou can see the [list of events available on Audit](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/eventos-disponiveis-no-audit--6r1Mzcu5NmkmmDLJlz9CCZ), but stores using the PII data architecture also log Profile System events, which you can see in the [Profile System integration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system%23auditability).\n\n## Marketplaces\n\nThe VTEX platform enables your store to be a marketplace and a seller to other marketplaces at the same time. Data privacy processes may impact your store in different ways depending on the roles your operation assumes in this context.\n\n### Scenario 1: Your store acts as a marketplace\n\nShopper data belongs to the marketplace. Hence, if your VTEX store acts as a [marketplace](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/marketplace-strategies-at-vtex--tutorials%5F402%23acting-as-a-marketplace), selling products from other sellers, all specifications described in this guide apply.\n\nMoreover, fulfillment information is shared with the seller. Therefore, you must ensure that your associated sellers also comply with data privacy laws.\n\n### Scenario 2: Your store acts as a seller\n\nIf your VTEX store acts as a [seller](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/marketplace-strategies-at-vtex--tutorials%5F402%23selling-on-marketplaces), offering products in marketplaces, the specifications described in this guide apply to the fulfillment data received by your store from each marketplace.\n\nThe marketplace is your data source, so you must guarantee that marketplaces associated with your store also comply with data privacy laws.\n\n## Changes in VTEX features default behavior\n\nThe behavior of some VTEX features has been adapted to better communicate with the PII data architecture. There are some differences in implementation when compared to the standard data architecture, such as API contracts and how information is displayed on VTEX Admin. Read [Changes in VTEX features behavior to handle PII data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data). This document is constantly updated to reflect the evolution of the PII data architecture.\n\n## Limitations during closed beta\n\nDuring closed beta testing stage, there are limitations in certain features for stores using PII data architecture. See this article about [Limitations of the PII data architecture during closed beta](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/limitations-of-the-pii-data-architecture-during-closed-beta). This document is constantly updated to reflect the evolution of the PII data architecture.\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/PedroAntunesCosta)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/data-privacy/pii-data-architecture-specifications.md)\n\n[Data Protection Plus« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications//docs/guides/data-protection-plus)[Data residencyNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications//docs/guides/data-residency)\n\nSee also\n\n[Profile System integrationGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/profile-system)[Limitations of the PII data architecture during closed betaGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/limitations-of-the-pii-data-architecture-during-closed-beta)[Data residencyGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/data-residency)[Data Protection PlusGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/data-protection-plus)[Changes in VTEX features behavior to handle PII dataGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data)\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/PedroAntunesCosta)\n\nON THIS PAGE\n\n[Profile system](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/pii-data-architecture-specifications%23profile-system)\n\n[Data entities](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/pii-data-architecture-specifications%23data-entities)[Communication with other VTEX modules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/pii-data-architecture-specifications%23communication-with-other-vtex-modules)[Versioning](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/pii-data-architecture-specifications%23versioning)\n\n[Encryption](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/pii-data-architecture-specifications%23encryption)\n\n[Tokenization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/pii-data-architecture-specifications%23tokenization)\n\n[Default data masking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/pii-data-architecture-specifications%23default-data-masking)\n\n[Auditability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/pii-data-architecture-specifications%23auditability)\n\n[Marketplaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/pii-data-architecture-specifications%23marketplaces)\n\n[Scenario 1: Your store acts as a marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/pii-data-architecture-specifications%23scenario-1-your-store-acts-as-a-marketplace)[Scenario 2: Your store acts as a seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/pii-data-architecture-specifications%23scenario-2-your-store-acts-as-a-seller)\n\n[Changes in VTEX features default behavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/pii-data-architecture-specifications%23changes-in-vtex-features-default-behavior)\n\n[Limitations during closed beta](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/pii-data-architecture-specifications%23limitations-during-closed-beta)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/data-privacy/pii-data-architecture-specifications.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Profile system](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/pii-data-architecture-specifications%23profile-system)\n\n[Data entities](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/pii-data-architecture-specifications%23data-entities)[Communication with other VTEX modules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/pii-data-architecture-specifications%23communication-with-other-vtex-modules)[Versioning](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/pii-data-architecture-specifications%23versioning)\n\n[Encryption](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/pii-data-architecture-specifications%23encryption)\n\n[Tokenization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/pii-data-architecture-specifications%23tokenization)\n\n[Default data masking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/pii-data-architecture-specifications%23default-data-masking)\n\n[Auditability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/pii-data-architecture-specifications%23auditability)\n\n[Marketplaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/pii-data-architecture-specifications%23marketplaces)\n\n[Scenario 1: Your store acts as a marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/pii-data-architecture-specifications%23scenario-1-your-store-acts-as-a-marketplace)[Scenario 2: Your store acts as a seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/pii-data-architecture-specifications%23scenario-2-your-store-acts-as-a-seller)\n\n[Changes in VTEX features default behavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/pii-data-architecture-specifications%23changes-in-vtex-features-default-behavior)\n\n[Limitations during closed beta](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications/docs/guides/pii-data-architecture-specifications%23limitations-during-closed-beta)\n\nOn this page\n\n[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=)"
}
] |
doc_b539f0f9
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides external marketplace integration canceled orders in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-guide)\n\n[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-architecture)\n\n[Store setup for VTEX Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-vtex-seller-setup)\n\n[Creating an integration app from a Template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-app-template)\n\n[Catalog Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-catalog)\n\n[Catalog logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-logs)\n\n[Get product list for an initial load](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-product-load)\n\n[How to get a new product to offer in the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-new-products)\n\n[How to get product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-product-updates)\n\n[Product and Category Mappings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-catalog-mapping)\n\n[How to keep prices updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-price-update)\n\n[How to keep stock updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-stock-update)\n\n[Order Integration overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-recommendations)\n\n[New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-collect-orders)\n\n[Update Order Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-update-order-status)\n\n[How to validate if items are available for delivery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-delivery-validation)\n\n[Sending invoice and tracking code to the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-invoice-tracking)\n\n[How to update a canceled order’s status in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-canceled-orders)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-guide)\n\n[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-architecture)\n\n[Store setup for VTEX Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-vtex-seller-setup)\n\n[Creating an integration app from a Template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-app-template)\n\n[Catalog Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-catalog)\n\n[Catalog logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-logs)\n\n[Get product list for an initial load](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-product-load)\n\n[How to get a new product to offer in the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-new-products)\n\n[How to get product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-product-updates)\n\n[Product and Category Mappings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-catalog-mapping)\n\n[How to keep prices updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-price-update)\n\n[How to keep stock updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-stock-update)\n\n[Order Integration overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-recommendations)\n\n[New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-collect-orders)\n\n[Update Order Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-update-order-status)\n\n[How to validate if items are available for delivery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-delivery-validation)\n\n[Sending invoice and tracking code to the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-invoice-tracking)\n\n[How to update a canceled order’s status in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-canceled-orders)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides)\n\nIntegration Guides\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-guide)\n\n[How to update a canceled order’s status in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-canceled-orders)\n\nHow to update a canceled order’s status in VTEX\n\nAn order can be canceled by the marketplace, or by the VTEX Admin The diagram below describes the notification flow, for cancelling the order and updating the status in VTEX:\n\n\n\n## Cancelling the Order and Updating the status\n\nFollow the steps below, once receiving the notification:\n\n1. Connector receives **Cancel Order notification** from the marketplace. \nWe suggest that connectors store notifications in a queue by store for processing.\n2. Connectors record the **order integration status**, to validate if the order has been integrated to VTEX, avoiding reprocessing of orders.\n3. **For orders that have been integrated in VTEX:**a. Connectors should verify the order status in VTEX through the [Get Order API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api/%23get-/api/oms/pvt/orders/-orderId-). Orders with the `invoiced` status cannot be canceled in VTEX right away. Connectors must first issue a return invoice, through the [Order Invoice Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api/%23post-/api/oms/pvt/orders/-orderId-/invoice), use the `“type”=”input”` parameter in the call, to issue a return invoice. b. For orders with statuses other than `invoiced`, call the [Cancel Order API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/cancel). c. VTEX OMS will receive the request and cancel the order. d.VTEX notifies the connector through the endpoint `/pvt/orders/{orderId}/cancel`. e. Connectors receive the notification and respond with 200 and the payload described below. f. Once receiving the response, VTEX updates the order status to `canceled`.\n4. **For orders that have not been integrated in VTEX:**a. Inform the user that the order is already canceled in VTEX.\n\n`1\n\n{ \n\n2\n\n \"orderId\": string, //ID do pedido na VTEX \n\n3\n\n \"receipt\": string, //GUID gerado pelo integrador \n\n4\n\n \"date\": string //Data em que a notificação foi recebido \n\n5\n\n} \n\n`\n\n> Note that if the order status in VTEX is `invoiced`, a return invoice must be sent through the Order Invoice Notification API, before following the Cancel Order flow described below. Use the `\"type\"=\"input\"` parameter in the call, to issue a return invoice.\n\n## API Reference\n\nUse the endpoints described below to perform this step. It is important to note that when consuming this API, the connector must have a valid VTEX App Key and App Token.\n\n\n\n> All parameters in the endpoints below must be declared in the request. In case one of the parameters does not have a value, you must still send it as `null`.\n\n### Cancel Order\n\nCheck out our [Cancel Order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/cancel) API Reference to know more details about this call.\n\n### Order Invoice Notification\n\nUse the request example below to generate an order invoice. Check out our [Order Invoice Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/invoice) API Reference to know more details.\n\n`1\n\n{ \n\n2\n\n \"type\": \"Output\", \n\n3\n\n \"invoiceNumber\": \"NFe-00001\", \n\n4\n\n \"courier\": \"\", \n\n5\n\n \"trackingNumber\": \"\", \n\n6\n\n \"trackingUrl\": \"\", \n\n7\n\n \"items\": [ \n\n8\n\n { \n\n9\n\n \"id\": \"345117\", \n\n10\n\n \"quantity\": 1, \n\n11\n\n \"price\": 9003 \n\n12\n\n } \n\n13\n\n ], \n\n14\n\n \"issuanceDate\": \"2019-11-21T00:00:00\", \n\n15\n\n \"invoiceValue\": 9508 \n\n16\n\n} \n\n`\n\n## Scenario 1: customer cancels order in marketplace\n\nThis scenario occurs when the marketplace’s customer cancels an order in the marketplace, and the connector sends the cancellation request to VTEX.\n\nWhen to perform: after receiving the cancellation notification from the marketplace\n\nConnectors should:\n\n1. Validate if order has been integrated in VTEX.\n2. Validate if order status allows cancellation (all but `invoiced`).\n3. If steps 1 and 2 are attended, call the Cancel Order API.\n4. Store VTEX's response to the call.\n5. Receive cancelling confirmation from VTEX and respond with `200` status, along with the response received in step 4.\n6. Log status for cancellation action.\n\n## Scenario 2: orders canceled in VTEX\n\nThis scenario occurs when VTEX cancels an order, and connectors should update the marketplace.\n\n1. VTEX OMS sends Order Cancel notification.\n2. Connector stores VTEX's response to the call.\n3. Receive cancelling confirmation from VTEX and respond with `200` status, along with the response received in step 2.\n4. Log status for cancellation action.\n\n## Scenario 3: orders integrated in VTEX with the “canceled” status\n\nThis scenario occurs when connectors list marketplace orders, and orders that had already been integrated in VTEX have been canceled in the marketplace\n\nConnectors should:\n\n1. Validate if order has been integrated in VTEX.\n2. Validate if order status allows cancellation (all but `invoiced`).\n3. If steps 1 and 2 are attended, call the Cancel Order API.\n4. Log status for cancellation action.\n\nContributors\n\n3\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-marketplace-integration-guide/external-marketplace-integration-canceled-orders.md)\n\n[Sending invoice and tracking code to the marketplace« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders//docs/guides/external-marketplace-integration-invoice-tracking)[External SellerNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders//docs/guides/external-seller-integration-guide)\n\nContributors\n\n3\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Cancelling the Order and Updating the status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-canceled-orders%23cancelling-the-order-and-updating-the-status)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-canceled-orders%23api-reference)\n\n[Cancel Order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-canceled-orders%23cancel-order)[Order Invoice Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-canceled-orders%23order-invoice-notification)\n\n[Scenario 1: customer cancels order in marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-canceled-orders%23scenario-1-customer-cancels-order-in-marketplace)\n\n[Scenario 2: orders canceled in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-canceled-orders%23scenario-2-orders-canceled-in-vtex)\n\n[Scenario 3: orders integrated in VTEX with the “canceled” status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-canceled-orders%23scenario-3-orders-integrated-in-vtex-with-the-canceled-status)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-marketplace-integration-guide/external-marketplace-integration-canceled-orders.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Cancelling the Order and Updating the status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-canceled-orders%23cancelling-the-order-and-updating-the-status)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-canceled-orders%23api-reference)\n\n[Cancel Order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-canceled-orders%23cancel-order)[Order Invoice Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-canceled-orders%23order-invoice-notification)\n\n[Scenario 1: customer cancels order in marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-canceled-orders%23scenario-1-customer-cancels-order-in-marketplace)\n\n[Scenario 2: orders canceled in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-canceled-orders%23scenario-2-orders-canceled-in-vtex)\n\n[Scenario 3: orders integrated in VTEX with the “canceled” status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-canceled-orders/docs/guides/external-marketplace-integration-canceled-orders%23scenario-3-orders-integrated-in-vtex-with-the-canceled-status)\n\nOn this page\n\n[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=)"
}
] |
doc_436281b8
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation vtex io cli plugins in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[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-vtex-io-cli-plugins/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/api-reference)\n\n[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-vtex-io-cli-plugins/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/storefront-development)\n\n[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-vtex-io-cli-plugins/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/troubleshooting)\n\n[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-vtex-io-cli-plugins/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n[Installing VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-vtex-io-cli-install)\n\n[Updating VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-vtex-io-cli-update)\n\n[Using VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-vtex-io-cli-usage)\n\n[Managing plugins](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-vtex-io-cli-plugins)\n\n[Command reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-vtex-io-cli-command-reference)\n\n[Uninstalling VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-vtex-io-cli-uninstall)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n[Installing VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-vtex-io-cli-install)\n\n[Updating VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-vtex-io-cli-update)\n\n[Using VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-vtex-io-cli-usage)\n\n[Managing plugins](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-vtex-io-cli-plugins)\n\n[Command reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-vtex-io-cli-command-reference)\n\n[Uninstalling VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-vtex-io-cli-uninstall)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/app-development)\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n[Managing plugins](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-vtex-io-cli-plugins)\n\nManaging plugins\n\nVTEX IO CLI 3.x has a plug-in architecture that makes it more flexible and extensible to inject new commands and functionalities. This way, you can go beyond VTEX IO's CLI default commands and add specific plugins to achieve a more comprehensive experience.\n\nCheck the [Command Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-command-reference%23plugins) for a detailed description of all plugins developed by VTEX.\n\n> The following plugins are native to VTEX IO'S CLI. Therefore, you do not need to install them: `abtest`, `autoupdate`, `deploy`, `deps`, `edition`, `plugins`, `whoami`, `workspace`.\n\n## Checking plugin commands\n\nCheck all commands related to plugins by running the following command.\n\n`1\n\nvtex plugins \n\n`\n\n\n\n## Listing all VTEX plugins\n\nList all plugins available by VTEX by running the following command.\n\n`1\n\nvtex plugins source \n\n`\n\n\n\n> If you already have downloaded a plugin, it will be highlighted in green.\n\n## Installing a plugin\n\nInstall a new plugin by running the following command.\n\n`1\n\nvtex plugins install {pluginName} \n\n`\n\nReplace the value between curly brackets with the name of the plugin you want to install.\n\n* For `vtex` plugins, use just the plugin name. For example, `vtex plugins install infra`. \n> Tip: you can run `vtex plugins source` to check the available VTEX plugins.\n* For third parties plugins, use the following format: `@{org-name}/{plugin-name}`.\n\n\n\n## Listing installed plugins\n\nList all plugins installed in your machine by running the following command.\n\n`1\n\nvtex plugins list \n\n`\n\n\n\n## Updating installed plugins\n\nUpdate all plugins installed in your machine by running the following command.\n\n`1\n\nvtex plugins update \n\n`\n\n\n\n## Uninstalling a plugin\n\nDelete a plugin from your machine by running the following command.\n\n`1\n\nvtex plugins uninstall {pluginName} \n\n`\n\n> Replace the value between curly brackets with the name of the plugin you want to uninstall. You can run `vtex plugins list` to check which plugins are installed in your machine.\n\n\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/vtex-io-documentation-vtex-io-cli-plugins.md)\n\n[Using VTEX IO's CLI« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins//docs/guides/vtex-io-documentation-vtex-io-cli-usage)[Command referenceNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins//docs/guides/vtex-io-documentation-vtex-io-cli-command-reference)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Checking plugin commands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-vtex-io-cli-plugins%23checking-plugin-commands)\n\n[Listing all VTEX plugins](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-vtex-io-cli-plugins%23listing-all-vtex-plugins)\n\n[Installing a plugin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-vtex-io-cli-plugins%23installing-a-plugin)\n\n[Listing installed plugins](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-vtex-io-cli-plugins%23listing-installed-plugins)\n\n[Updating installed plugins](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-vtex-io-cli-plugins%23updating-installed-plugins)\n\n[Uninstalling a plugin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-vtex-io-cli-plugins%23uninstalling-a-plugin)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/vtex-io-documentation-vtex-io-cli-plugins.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Checking plugin commands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-vtex-io-cli-plugins%23checking-plugin-commands)\n\n[Listing all VTEX plugins](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-vtex-io-cli-plugins%23listing-all-vtex-plugins)\n\n[Installing a plugin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-vtex-io-cli-plugins%23installing-a-plugin)\n\n[Listing installed plugins](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-vtex-io-cli-plugins%23listing-installed-plugins)\n\n[Updating installed plugins](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-vtex-io-cli-plugins%23updating-installed-plugins)\n\n[Uninstalling a plugin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins/docs/guides/vtex-io-documentation-vtex-io-cli-plugins%23uninstalling-a-plugin)\n\nOn this page\n\n[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=)"
}
] |
doc_d5603f5f
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex storefront permissions ui in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui/docs/troubleshooting)\n\n[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-storefront-permissions-ui/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui/updates/release-notes)\n\nStorefront Permissions UI\n\n**Storefront Permissions UI** provides an interface for the [Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions) app, which is part of VTEX’s [B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-suite) solution, a collection of apps that allow stores to manage organizations, storefront roles and permissions, and checkout settings for B2B commerce relationships.\n\nB2B customers often play distinct roles within their organization, such as professional buyer, manager, or supervisor. Each role is associated with a different set of permissions, depending on the actions the user needs to perform.\n\nThis app communicates with the backstage **Storefront Permissions** app and provides the following features for this scenario:\n\n* [Roles management](#roles-management): allow VTEX Admin users to manage B2B roles and associated app permissions through an interface.\n* [Theme blocks configuration](#theme-blocks-configuration): enable conditional theme blocks so that only users with the required permissions can access determined parts of the content in your storefront.\n\nWe recommend that you use it alongside the other apps in the [B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-suite) for all functionalities to work as expected.\n\n## Before you begin\n\nMake sure you have the [VTEX IO CLI (Command Line Interface)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install) installed in your machine.\n\n## Installation\n\nYou can install the app by running `vtex install vtex.storefront-permissions-ui` in your terminal, using the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference).\n\nAfter this command, the app will be installed in your VTEX Admin, and you can access it on **Account Settings** \\> **Storefront Permissions**.\n\n> Installing **Storefront Permissions UI** has the effect of automatically installing the [Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions) app as a dependency, in case it is not already installed.\n\n## Roles management\n\nTo manage roles and their respective app permissions using the Storefront Permissions UI, follow the steps below after installing the app.\n\n1. At the VTEX Admin, navigate to **Account Settings** \\> **Storefront Permissions**.\n2. Click on one of the [available storefront roles](#available-storefront-roles).\n3. Click on one of the listed apps. \n> Only apps that are integrated with **Storefront Permissions** will be on the list – check our [Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions%23advanced-app-integration-optional) documentation for more information.\n4. Select which permissions you want to enable for the role, as illustrated below.\n5. Once you are done, click on `Save`.\n\n\n\nAfter associating roles with the desired permissions, you may then assign roles to users. To learn more about this, read our [B2B Organizations documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations%23users).\n\n### Available storefront roles\n\nIn the following table, you can see the available storefront roles, their key used for identification in the app’s code, and their description.\n\n| **Role** | **Key** | **Description** |\n| --------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Store Admin | store-admin | Store administrator, that is, a user who has access to the VTEX Admin. |\n| Sales Admin | sales-admin | Sales administrator user who can manage all sales users. |\n| Sales Manager | sales-manager | Sales manager user who can manage sales users in the same organization, as well as assist or impersonate buyers during navigation or purchase. |\n| Sales Representative | sales-representative | Sales representative user who can assist or impersonate buyers in the same cost center during navigation or purchase. |\n| Organization Admin | customer-admin | Main organization user who manages the organization information, as well as its members and cost centers. |\n| Organization Approver | customer-approver | Organization user who can take a saved cart or quote that was created by an **Organization Buyer** and use it to place an order. |\n| Organization Buyer | customer-buyer | Organization user who has the ability to add items to cart. If the **B2B Quotes** app is installed, they are also able to save their cart for future use or create a quote. |\n\n## Theme blocks configuration\n\nIf you only want users with roles that have the required permissions to be able to access determined parts of the content in your storefront, you can also configure conditional blocks in your store’s theme. These types of blocks allow you to validate information in order to display or hide content in your storefront.\n\nIn case you need more information on how to start building your own theme, read our [documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-basicsetup) before you proceed.\n\nIf you are experienced in developing and customizing your store’s theme, follow the steps below to declare the conditional blocks enabled by **Storefront Permissions UI**.\n\n1. Open your store theme app’s repository in your local files.\n2. In the `manifest.json` file, under `dependencies`, add `\"vtex.storefront-permissions-ui\": \"1.x\"`, like in the example below. \n`1 \n \"dependencies\": { \n2 \n \"vtex.storefront-permissions-ui\": \"1.x\" \n3 \n }, \n`\n3. Now, you can use the `check-permission`, `allowed-content` and `disallowed-content` blocks on any files you want in your store’s theme. See more information on these blocks below. \n| **Block name** | **Description** | \n| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | \n| check-permission | Checks if the current user has the required permissions to access the content wrapped with this block.You can wrap content blocks with check-permission when declaring them to validate if the user has the required permissions to see that content. Example: check-permission#carousel | \n| allowed-content | Allows you to define on children blocks the content that will be shown for allowed users – users with roles that have the required permissions to view the block. | \n| disallowed-content | Optional block that allows you to define on children blocks the content that will be shown for disallowed users – users with roles that do not have the required permissions to view the block. | \nThis component will check if the user has permission to see the `allowed-content`, otherwise they will see the `disallowed-content`. \nThe `check-permission` block has a prop named `roles`, which lets you define an array of roles that are allowed to see the blocks defined under the children blocks of `allowed-content`. \n| **Prop name** | **Type** | **Description** | **Required** | **Example** | \n| ------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | -------------------------------- | \n| roles | array of strings | List of the allowed roles, identified by their key. Learn more about each role and its key in the [Available storefront roles](#available-storefront-roles) section. | true | \\[\"store-admin\", \"sales-admin\"\\] |\n\n#### Example\n\nIn the example below, in a store’s home, a carousel with banners will only be visible to logged in users with the `store-admin` or `sales-admin` roles. Users with other roles will see a warning message (`**You don't have access to this content**`) instead.\n\n`1\n\n{ \n\n2\n\n \"store.home\": { \n\n3\n\n \"blocks\": [ \n\n4\n\n+ \"check-permission#carousel\", \n\n5\n\n \"shelf#home\", \n\n6\n\n \"info-card#home\", \n\n7\n\n \"rich-text#question\", \n\n8\n\n \"rich-text#link\" \n\n9\n\n ] \n\n10\n\n }, \n\n11\n\n+ \"check-permission#carousel\": { \n\n12\n\n+ \"props\": { \n\n13\n\n+ \"roles\": [\"store-admin\", \"sales-admin\"] \n\n14\n\n+ }, \n\n15\n\n+ \"blocks\": [\"allowed-content#carousel\",\"disallowed-content#carousel\"] \n\n16\n\n+ }, \n\n17\n\n+ \"allowed-content#carousel\": { \n\n18\n\n+ \"children\": [\"carousel#home\"] \n\n19\n\n+ }, \n\n20\n\n+ \"disallowed-content#carousel\": { \n\n21\n\n+ \"children\": [\"rich-text#disallowed\"] \n\n22\n\n+ }, \n\n23\n\n+ \"rich-text#disallowed\": { \n\n24\n\n+ \"props\": { \n\n25\n\n+ \"text\": \"**You don't have access to this content**\" \n\n26\n\n+ } \n\n27\n\n+ }, \n\n28\n\n \"carousel#home\": { \n\n29\n\n \"props\": { \n\n30\n\n \"autoPlay\": false, \n\n31\n\n \"banners\": [ \n\n32\n\n { \n\n33\n\n \"image\": \"https://storecomponents.vteximg.com.br/arquivos/banner-principal.png\", \n\n34\n\n \"mobileImage\": \"https://storecomponents.vteximg.com.br/arquivos/banner-principal-mobile.jpg\" \n\n35\n\n }, \n\n36\n\n { \n\n37\n\n \"image\": \"https://storecomponents.vteximg.com.br/arquivos/banner.jpg\", \n\n38\n\n \"mobileImage\": \"https://storecomponents.vteximg.com.br/arquivos/banner-principal-mobile.jpg\" \n\n39\n\n } \n\n40\n\n ], \n\n41\n\n \"height\": 720, \n\n42\n\n \"showArrows\": true, \n\n43\n\n \"showDots\": true \n\n44\n\n } \n\n45\n\n }, \n\n`\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/vtex-b2b-suite/vtex-storefront-permissions-ui.md)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui/docs/guides/vtex-storefront-permissions-ui%23before-you-begin)\n\n[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui/docs/guides/vtex-storefront-permissions-ui%23installation)\n\n[Roles management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui/docs/guides/vtex-storefront-permissions-ui%23roles-management)\n\n[Available storefront roles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui/docs/guides/vtex-storefront-permissions-ui%23available-storefront-roles)\n\n[Theme blocks configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui/docs/guides/vtex-storefront-permissions-ui%23theme-blocks-configuration)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/vtex-b2b-suite/vtex-storefront-permissions-ui.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui/docs/guides/vtex-storefront-permissions-ui%23before-you-begin)\n\n[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui/docs/guides/vtex-storefront-permissions-ui%23installation)\n\n[Roles management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui/docs/guides/vtex-storefront-permissions-ui%23roles-management)\n\n[Available storefront roles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui/docs/guides/vtex-storefront-permissions-ui%23available-storefront-roles)\n\n[Theme blocks configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui/docs/guides/vtex-storefront-permissions-ui%23theme-blocks-configuration)\n\nOn this page\n\n[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=)"
}
] |
doc_60c84b95
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX store components buybutton app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/troubleshooting)\n\n[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.store-components/buybutton/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/vtex-io-apps)\n\nBuy Button\n\n[vtex.store-components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components)\n\nVersion: 3.178.5\n\nLatest version: 3.178.5\n\n> Warning\n> \n> **The Buy Button block has been deprecated in favor of the [Add To Cart Button app](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-add-to-cart-button/).** Although support for this block is still granted, we strongly recommend you to update your store theme with the Add to Cart Button's blocks in order to keep up with the component's evolution.\n\n\n\nThe `buy-button` block displays a button that allows users to add products in the [Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-minicart) (`minicart.v1`).\n\n> Warning\n> \n> **The Buy Button block only works for stores using the Minicart v1**. If your store uses the Minicart v2, please refer to the [Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-add-to-cart-button) instead.\n\n\n\n## Configuration\n\n1. Import the `vtex.store-components` app to your theme's dependencies in the `manifest.json` file as in the following example:\n\n`1\n\n \"dependencies\": { \n\n2\n\n+ \"vtex.store-components\": \"3.x\" \n\n3\n\n } \n\n`\n\n1. Add the `buy-button` to other theme block using the product context, such as the `product-summary.shelf`. In the following example, the `buy-button` component was added to the `flex-layout.row` block from the `store.product` template (which uses the product context):\n\n`1\n\n \"store.product\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"flex-layout.row#product\", \n\n4\n\n ] \n\n5\n\n }, \n\n6\n\n \"flex-layout.row#product\": { \n\n7\n\n \"children\": [ \n\n8\n\n+ \"buy-button#product\" \n\n9\n\n ] \n\n10\n\n }, \n\n`\n\n1. Then, declare the `buy-button` block using the props stated in the [Props](#props) table. For example:\n\n`1\n\n \"buy-button#product\": { \n\n2\n\n \"props\": { \n\n3\n\n \"isOneClickBuy\": true, \n\n4\n\n \"showTooltipOnSkuNotSelected\": false \n\n5\n\n } \n\n6\n\n }, \n\n`\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| --------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------- | ---------------- |\n| available | boolean | Whether the Buy Button block is available for using (true) or not (false). | true |\n| customToastURL | string | Defines the link to where users will be redirected when the Buy Button is clicked on and the isOneClickBuy prop is set to true. | /checkout/#/cart |\n| isOneClickBuy | boolean | Whether the user should be redirected to the checkout page (true) or not (false) when the Add To Cart Button is clicked on. | false |\n| large | boolean | Whether the Buy Button should fill its whole width (true) or not (false). | false |\n| shouldOpenMinicart | boolean | Whether the Minicart should be opened when the Buy Button is clicked on (true) or not (false). | false |\n| shouldAddToCart | boolean | Whether the Buy Button should add products to the minicart when clicked on (true) or not (false). | true |\n| showItemsPrice | boolean | Whether the total price of items added to the cart should be displayed (true) or not (false). | false |\n| showToast | boolean | Whether a Toast (pop-up notification) should be displayed when adding an item to the minicart (true) or not (false) | false |\n| showTooltipOnSkuNotSelected | boolean | Whether a tooltip should be displayed when the Buy Button is clicked on with no SKU was selected (true) or not (false). | true |\n\n## Customization\n\nTo apply CSS customizations in this and other blocks, follow the [Using CSS handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization) guide.\n\n| CSS Handles |\n| ------------------- |\n| buttonDataContainer |\n| buttonItemsPrice |\n| buyButtonText |\n\nSee also\n\n[Vtex.store ComponentsVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/apps/vtex.store-components)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/apps/vtex.store-components/buybutton%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/apps/vtex.store-components/buybutton%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton/docs/apps/vtex.store-components/buybutton%23customization)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_839f53d0
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides customer credit integration guide in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/customer-credit-integration-guide)\n\n[Managing a Customer Credit account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/managing-a-customer-credit-account)\n\n[Managing a Customer Credit invoice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/managing-a-customer-credit-invoice)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/customer-credit-integration-guide)\n\n[Managing a Customer Credit account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/managing-a-customer-credit-account)\n\n[Managing a Customer Credit invoice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/managing-a-customer-credit-invoice)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides)\n\nIntegration Guides\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/customer-credit-integration-guide)\n\nCustomer Credit\n\nWith Customer Credit your store can enable credit payments through the checkout. You can also control invoices and the credit limits of your clients.\n\nLearn more about Customer Credit in [Help Center article](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/36grlQ69NK6OCuioeekyCs) and [Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api).\n\n## Structure of this guide\n\n| Article | Description |\n| ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |\n| [Managing a Customer Credit account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account) | How to manage Customer Credit accounts in your store through the Customer Credit API. |\n| [Managing a Customer Credit invoice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice) | How to manage Customer Credit invoices in your store using the Customer Credit API. |\n\nContributors\n\n1\n\n[](https://github.com/ricardoaerobr)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/customer-credit-integration-guide.md)\n\n[FAQ: ERP Integration« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide//docs/guides/faq-erp-integration)[Managing a Customer Credit accountNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide//docs/guides/managing-a-customer-credit-account)\n\nContributors\n\n1\n\n[](https://github.com/ricardoaerobr)\n\nON THIS PAGE\n\n[Structure of this guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/customer-credit-integration-guide%23structure-of-this-guide)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/customer-credit-integration-guide.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Structure of this guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customer-credit-integration-guide/docs/guides/customer-credit-integration-guide%23structure-of-this-guide)\n\nOn this page\n\n[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=)"
}
] |
doc_fc72c1a7
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Explain vtex io apps in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/guides/vtex-io-deprecated-apps)\n\n---\n\nVTEX IO Apps\n\nFind pre-built solutions to grow your business.\n\n\n\nBasic components\n\n[Add To Cart ButtonSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.add-to-cart-button)[AutocompleteSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.search/Autocomplete)[BannerSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.search/banner)[BreadcrumbSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.breadcrumb)[FooterSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.store-footer)[Google One-Tap LoginSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/guides/google-one-tap-login)\n\n[See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/guides/basic-components)\n\nStore Components\n\n[Autocomplete Result ListSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.store-components/autocompleteresults)[Availability SubscriberSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.store-components/availabilitysubscriber)[Back To Top ButtonSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.store-components/backtotopbutton)[ImageSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.store-components/image)[Info CardSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.store-components/infocard)[LogoSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.store-components/logo)\n\n[See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/guides/store-components)\n\nAdvanced components\n\n[Availability NotifySee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.availability-notify)[Category MenuSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.category-menu)[Kit LookSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtexbr.kitlook)[Icon Pack listSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.store-icons/iconpack)[IframeSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.iframe)[Live ShoppingSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtexventures.livestreaming)\n\n[See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/guides/advanced-components)\n\nB2B components\n\n[Order ConfigurationSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.order-configuration)[QuickorderSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.quickorder)[SKU ListSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.sku-list)\n\n[See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/guides/b2b-components)\n\nB2B Suite\n\n[Storefront PermissionsSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.storefront-permissions)[Storefront Permissions UISee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.storefront-permissions-ui)[B2B OrganizationsSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.b2b-organizations)[B2B Checkout SettingsSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.b2b-checkout-settings)[B2B Orders HistorySee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.b2b-orders-history)[B2B Quotes & CartsSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.b2b-quotes)\n\n[See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.b2b-suite)\n\nFunctional Apps\n\n[AB TesterSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtexarg.abtester)[Abandoned Cart ServiceSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.abandoned-cart-service)[BadgesSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.badges)[BroadcasterSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.broadcaster)[Catalog ImagesSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.catalog-images)[Checkout UI CustomSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.checkout-ui-custom)\n\n[See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/guides/functional-apps)\n\nLayout Apps\n\n[Condition LayoutSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.condition-layout)[Disclosure LayoutSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.disclosure-layout)[Flex LayoutSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.flex-layout)[Modal LayoutSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.modal-layout)[Overlay LayoutSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.overlay-layout)[Responsive LayoutSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.responsive-layout)\n\n[See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/guides/layout-apps)\n\nPixel Apps\n\n[Alexa CertifySee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.alexa-certify-code)[AudaraSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.audara)[BluecoreSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.bluecore)[Blueknow appSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.blueknow)[BTG360See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.btg360)[CookiebotSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.cookiebot)\n\n[See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/guides/pixel-apps)\n\nMy Account - StoreV2 version\n\n[My Account CommonsSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.my-account-commons)[My AuthenticationSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.my-authentication)\n\n[See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps/docs/apps/vtex.my-account)\n\n[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=)"
}
] |
doc_377d45f2
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex pick and pack get order status and information api in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/troubleshooting)\n\n[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-pick-and-pack-get-order-status-and-information-api/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n[VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-shipping-network)\n\n[VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-tracking)\n\n[VTEX Pick and Pack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack)\n\n[VTEX Pick and Pack Get Order Status and Information API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api)\n\n[VTEX Pick and Pack Carrriers Integration Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack-carriers-integration-protocol)\n\n[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/multilevel-omnichannel-inventory)\n\n[Pickup point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/setting-up-white-label-seller-as-pickup-point)\n\n[Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/delivery-promise)\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n[VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-shipping-network)\n\n[VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-tracking)\n\n[VTEX Pick and Pack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack)\n\n[VTEX Pick and Pack Get Order Status and Information API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api)\n\n[VTEX Pick and Pack Carrriers Integration Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack-carriers-integration-protocol)\n\n[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/multilevel-omnichannel-inventory)\n\n[Pickup point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/setting-up-white-label-seller-as-pickup-point)\n\n[Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/delivery-promise)\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides)\n\nLogistics\n\n[VTEX Pick and Pack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack)\n\n[VTEX Pick and Pack Get Order Status and Information API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api)\n\nVTEX Pick and Pack Get Order Status and Information API\n\nLearn how to create webhooks and get order status and information from VTEX Pick and Pack API\n\n[VTEX Pick and Pack](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/vtex-pick-and-pack--1OOops3WrUyz7e0bnhkfXU) is a solution to streamline stores’ fulfillment processes by optimizing orders’ picking and packing, and the last-mile delivery. The solution is composed of the [VTEX Fulfillment](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/vtex-pick-and-pack-fulfillment--1zGUEItEEVsal6cuBEBNcA) and the [Last Mile](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/vtex-pick-and-pack-last-mile--HN7WKV0xoq2ssVjsJlfzr) modules.\n\nThis documentation explains how to make a request to the **Get order status and information** REST API to retrieve the status and details of an order in the **VTEX Pick and Pack** context. If you use this API to retrieve orders from other contexts, you will receive 404 error messages.\n\n> The [order statuses in VTEX Pick and Pack](#order-status-in-pick-and-pack) do not correspond to the [order flow and status](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials%5F196) of the Order Management System (OMS).\n\n## Before you begin\n\nBefore making the request, you will need the following:\n\n* [Basic authentication](#basic-authentication)\n* [JSON Web Token (JWT)](#json-web-token-jwt)\n\n### Basic authentication\n\nBasic Authentication is a method for an HTTP user agent to provide a username and password when making a request. The system doesn't store API keys, they need to be generated every time there's a new request.\n\nBelow, you will find an Api-Key for the Development environment that you can use. To find the Api-Key of the environment in Production, Admin users can generate an API Key in the users section of their Pick and Pack settings.\n\n### Production (Prod)\n\n`1\n\n{{alphanumericSequence}} \n\n`\n\n### JSON Web Token (JWT)\n\nJSON Web Token (JWT) is an open standard ([RFC 7519](https://read.calvincode.net/reader?url=https://www.rfc-editor.org/rfc/rfc7519)) that defines a compact and self-contained way for securely transmitting information as a JSON object between parties.\n\nIn order to authorize the [API request](#get-order-status-and-information-api), you will have to generate a JWT. For that, you will use the Api-Key from the previous section.\n\nThe first step is to create a token of authentication with the endpoint below. No authentication is required:\n\n| Method | URL |\n| ------ | ------------------------------------------- |\n| POST | https://auth.pickingnpacking.com/prod/token |\n\n#### Request body example\n\n`1\n\n{ \n\n2\n\n \"apiKey\": \n\n3\n\n\"db5a3cecfef9cb0a9815af7c2eb8f7d6:c400460c165cc9beb146ad4d757e3bb1a24ff15228c424a0bd7c37f0ac356c0f6230568705d93dd6ff68190c0eafe5a74cbb14229748f20d3e53cbcc790ba372\" \n\n4\n\n} \n\n`\n\n#### Response body example\n\n`1\n\n{ \n\n2\n\n \"message\": \"success\", \n\n3\n\n \"data\": \n\n4\n\n\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ2.eyJob4N0bmFtZSI6Im5ld2J1c2luZXNzMDEiLCJpYXQiOjE2MzM3MjE1NzksImV4cCI6MTYzMzcyMjQ3OX0.7QRZpElg1HYgyJpE6QTNgE2IN3vXbzIfulBS0Bvyzds\" \n\n5\n\n} \n\n`\n\n#### Status codes\n\n| Status code | Description |\n| ----------- | ----------------------- |\n| 200 | OK |\n| 401 | Requires authentication |\n| 400 | Bad request |\n| 404 | Resource not found |\n| 500 | Internal error |\n\n#### Headers\n\nAfter you have created the token of authentication, make the request to the endpoint once again, this time sending in the headers the following object:\n\n`1\n\n// Headers \n\n2\n\n{ \n\n3\n\n \"Authorization\": \"{{JWT}}\" \n\n4\n\n} \n\n`\n\n## Get order status and information API\n\nIn order to get the **VTEX Pick and Pack** status and details of a given order, use the endpoint below:\n\n| Method | URL |\n| ------ | ------------------------------------------------------------------ |\n| GET | https://legacy.pickingnpacking.com/prod/picking-tracking/{orderId} |\n\n> The `orderId` is the order's unique code and is the same used in OMS and all VTEX modules.\n\n### Authorization\n\nUse the authorization retrieved from the steps listed in [Before you begin](#before-you-begin) and insert it in the call's header.\n\n### Response body example\n\n`1\n\n{ \n\n2\n\n \"message\": \"string\", \n\n3\n\n \"data\": { \n\n4\n\n \"hostname\": \"string\", \n\n5\n\n \"orderId\": \"string\", \n\n6\n\n \"fulfillmentStatus\": \"string\", \n\n7\n\n \"pickedItems\": [ \n\n8\n\n { \n\n9\n\n \"image\": \"string\", \n\n10\n\n \"sellingPrice\": \"float\", \n\n11\n\n \"ean\": \"string\", \n\n12\n\n \"quantity\": \"number\", \n\n13\n\n \"name\": \"string\", \n\n14\n\n \"id\": \"string\", \n\n15\n\n \"refId\": \"string\", \n\n16\n\n \"categories\": [ \n\n17\n\n { \n\n18\n\n \"name\": \"string\", \n\n19\n\n \"id\": \"string\" \n\n20\n\n } \n\n21\n\n ] \n\n22\n\n } \n\n23\n\n ] \n\n24\n\n \"shipping\"?: { \n\n25\n\n \"trackingId\": \"string\", \n\n26\n\n \"trackingStatus\": \"string\", \n\n27\n\n \"services\"?: [ \n\n28\n\n { \n\n29\n\n \"serviceId\": \"string\", \n\n30\n\n \"agent\"?: \"string\", \n\n31\n\n \"vehicle\"?: \"string\", \n\n32\n\n \"courier\": \"string\", \n\n33\n\n \"trackingUrl\"?: \"string\", \n\n34\n\n \"serviceStatus\": \"string\", \n\n35\n\n \"evidences\"?: \"string\", \n\n36\n\n \"createdAt\": \"string\" \n\n37\n\n } \n\n38\n\n ] \n\n39\n\n } \n\n40\n\n } \n\n41\n\n} \n\n`\n\n### Status codes\n\n| Status code | Internal response Code | Message |\n| ----------- | ---------------------- | ---------------------------------------------------- |\n| 200 | OK | OK |\n| 401 | 1000 | Internal server |\n| 404 | 1001 | Resource not found |\n| 400 | 1002 | OrderId is not found \\| Order not found by {orderId} |\n| 500 | 1003 | Internal error |\n\n## Webhook\n\nYou will need to create a webhook to receive the response of the request, used for receiving notifications for invoicing purposes, for example.\n\nYour webhook may have your desired setting for URL, path, method, and authentication, it is flexible.\n\nThe order’s information and status change notifications received will be an object like the following example:\n\n### Example\n\n`1\n\n{ \n\n2\n\n \"orderId\": \"XDE-1253881550433-01\", \n\n3\n\n \"oldStatus\": \"PENDING\", \n\n4\n\n \"newStatus\": \"READY_FOR_PICKING\", \n\n5\n\n \"hostname\": \"picknpackstore\" \n\n6\n\n} \n\n`\n\n## Order status in Pick and Pack\n\nIn the table below, you will find the possible order statuses in the **VTEX Pick and Pack** context:\n\n| Status | Description |\n| ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| READY\\_FOR\\_HANDLING | An order imported from the Order Management System (OMS) that is ready to be fulfilled. |\n| IDLE (Inactive) | The order was an external fulfillment, and _VTEX Pick and Pack_ will not be able to process it. If the order is invoiced in OMS in a status different from Ready for invoicing, the system will also consider it an external fulfillment and change the order status to Idle. |\n| READY\\_FOR\\_PICKING | The order was assigned to a picker and is depending on the picker’s confirmation to move to the next status. |\n| PICKING | The picker is collecting the order items. |\n| READY\\_FOR\\_PACKING | The picker has finished the picking process and the order is ready to be packed. |\n| PACKING | The order’s items are being packed. |\n| READY\\_FOR\\_INVOICING | The order can be invoiced. _VTEX Pick and Pack_ solution does not invoice orders. |\n| INVOICING | The invoice is being processed. |\n| INVOICED | The order was invoiced. |\n| PREPARING\\_SHIPPING | Shipping services are being created for the order. |\n| READY\\_FOR\\_SHIPPING | Once Shipping Services are created, service is awaiting carrier pickup. |\n| WAITING\\_FOR\\_DELIVERY\\_COMPANY | The order is packed and the shipping service was successfully created. |\n| ON\\_ROUTE | The courier (driver) has collected the package in the physical store or warehouse, for example. |\n| DELIVERED | The order was delivered to the customer. |\n| RETURNED | The customer couldn’t be reached or refused to receive the package, so the order was returned. |\n| WAITING\\_FOR\\_PICKUP | The package is ready to be picked up by the customer at the physical store or at another pickup point. |\n| CANCELED | The order was canceled. |\n\n> The statuses above are related to VTEX Pick and Pack only, and do not correspond to the order flow and status of the Order Management System (OMS).\n\nContributors\n\n4\n\n[](https://github.com/karenkrieger)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/jumeyermattosarruda)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Fulfillment/vtex-pick-and-pack/vtex-pick-and-pack-get-order-status-and-information-api.md)\n\n[VTEX Pick and Pack« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api//docs/guides/vtex-pick-and-pack)[VTEX Pick and Pack Carrriers Integration ProtocolNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api//docs/guides/vtex-pick-and-pack-carriers-integration-protocol)\n\nSee also\n\n[VTEX Pick and PackGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack)[VTEX Pick and Pack Carriers Integration ProtocolGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack-carriers-integration-protocol)\n\nContributors\n\n4\n\n[](https://github.com/karenkrieger)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/jumeyermattosarruda)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api%23before-you-begin)\n\n[Basic authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api%23basic-authentication)[Production (Prod)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api%23production-prod)[JSON Web Token (JWT)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api%23json-web-token-jwt)\n\n[Get order status and information API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api%23get-order-status-and-information-api)\n\n[Authorization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api%23authorization)[Response body example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api%23response-body-example)[Status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api%23status-codes)\n\n[Webhook](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api%23webhook)\n\n[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api%23example)\n\n[Order status in Pick and Pack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api%23order-status-in-pick-and-pack)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Fulfillment/vtex-pick-and-pack/vtex-pick-and-pack-get-order-status-and-information-api.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api%23before-you-begin)\n\n[Basic authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api%23basic-authentication)[Production (Prod)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api%23production-prod)[JSON Web Token (JWT)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api%23json-web-token-jwt)\n\n[Get order status and information API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api%23get-order-status-and-information-api)\n\n[Authorization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api%23authorization)[Response body example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api%23response-body-example)[Status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api%23status-codes)\n\n[Webhook](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api%23webhook)\n\n[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api%23example)\n\n[Order status in Pick and Pack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api/docs/guides/vtex-pick-and-pack-get-order-status-and-information-api%23order-status-in-pick-and-pack)\n\nOn this page\n\n[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=)"
}
] |
doc_40893f21
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX search graphql app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/troubleshooting)\n\n[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.search-graphql/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.checkout-ui-custom)\n\n[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.messages)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/affiliates-program-app)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.checkout-ui-custom)\n\n[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.messages)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/affiliates-program-app)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/vtex-io-apps)\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/functional-apps)\n\nSearch GraphQL\n\nOfficial extension\n\nVersion: 0.69.4\n\nLatest version: 0.69.4\n\nThis app exports a GraphQL schema for search results on VTEX Stores.\n\nThe default implementation for this schema is on [vtex.search-resolver](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/search-resolver) app.\n\n### Usage\n\nTo use it in your app, declare it on your `manifest.json` file, as demonstrated below:\n\n`1\n\n\"dependencies\": { \n\n2\n\n \"vtex.search-graphql\": \"0.x\" \n\n3\n\n} \n\n`\n\nYou may then use it in your front end component queries, for example, write file `productQuery.gql`:\n\n`1\n\nquery ProductQuery($slug: String) { \n\n2\n\n product(identifier: { field: slug, value: $slug}) @context(provider: \"vtex.search-graphql\") { \n\n3\n\n productName \n\n4\n\n } \n\n5\n\n} \n\n`\n\nTo resolve this query, you need to have an app that implements the schema declared in this app, such as: [vtex.search-resolver](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/search-resolver).\n\n**Table of Contents**\n* [Query](#query)\n* [Objects](#objects) \n * [AssemblyOption](#assemblyoption) \n * [Attachment](#attachment) \n * [Banners](#banners) \n * [Benefit](#benefit) \n * [BenefitItem](#benefititem) \n * [Brand](#brand) \n * [BrandFacet](#brandfacet) \n * [CategoriesTreeFacet](#categoriestreefacet) \n * [Category](#category) \n * [ClusterHighlight](#clusterhighlight) \n * [CompositionItem](#compositionitem) \n * [CompositionType](#compositiontype) \n * [Correction](#correction) \n * [DeliverySlaPerTypes](#deliveryslapertypes) \n * [DeliverySlaSamples](#deliveryslasamples) \n * [DepartmentFacet](#departmentfacet) \n * [Discount](#discount) \n * [DomainValues](#domainvalues) \n * [Facet](#facet) \n * [FacetValue](#facetvalue) \n * [Facets](#facets) \n * [FilterFacet](#filterfacet) \n * [FilterFacets](#filterfacets) \n * [Gift](#gift) \n * [GiftImage](#giftimage) \n * [Image](#image) \n * [InputValue](#inputvalue) \n * [Installment](#installment) \n * [ItemMetadata](#itemmetadata) \n * [ItemMetadataUnit](#itemmetadataunit) \n * [ItemPriceTable](#itempricetable) \n * [Items](#items) \n * [KitItem](#kititem) \n * [Offer](#offer) \n * [OnlyProduct](#onlyproduct) \n * [PageType](#pagetype) \n * [PriceRange](#pricerange) \n * [PriceRangesFacet](#pricerangesfacet) \n * [PriceTableItem](#pricetableitem) \n * [Product](#product) \n * [ProductClusters](#productclusters) \n * [ProductPriceRange](#productpricerange) \n * [ProductSearch](#productsearch) \n * [ProductSuggestions](#productsuggestions) \n * [Property](#property) \n * [PropertyGroup](#propertygroup) \n * [QueryArgs](#queryargs) \n * [Range](#range) \n * [Recommendation](#recommendation) \n * [Reference](#reference) \n * [Region](#region) \n * [SKU](#sku) \n * [SKUSpecificationField](#skuspecificationfield) \n * [SKUSpecificationValue](#skuspecificationvalue) \n * [SearchBanner](#searchbanner) \n * [SearchBreadcrumb](#searchbreadcrumb) \n * [SearchCorrection](#searchcorrection) \n * [SearchMetadata](#searchmetadata) \n * [SearchSuggestion](#searchsuggestion) \n * [SearchSuggestionAttribute](#searchsuggestionattribute) \n * [SearchSuggestions](#searchsuggestions) \n * [SearchURLStats](#searchurlstats) \n * [SelectedFacet](#selectedfacet) \n * [SelectedProperty](#selectedproperty) \n * [Seller](#seller) \n * [SkuSpecification](#skuspecification) \n * [SpecificationGroup](#specificationgroup) \n * [SpecificationGroupProperty](#specificationgroupproperty) \n * [Suggestions](#suggestions) \n * [Teaser](#teaser) \n * [TeaserCondition](#teasercondition) \n * [TeaserEffects](#teasereffects) \n * [TeaserValue](#teaservalue) \n * [Video](#video) \n * [productSpecification](#productspecification)\n* [Inputs](#inputs) \n * [AssemblyOptionInput](#assemblyoptioninput) \n * [Options](#options) \n * [ProductUniqueIdentifier](#productuniqueidentifier) \n * [SelectedFacetInput](#selectedfacetinput) \n * [General filters](#general-filters)\n* [Enums](#enums) \n * [CategoryTreeBehavior](#categorytreebehavior) \n * [CrossSelingInputEnum](#crossselinginputenum) \n * [FilterType](#filtertype) \n * [InputValueType](#inputvaluetype) \n * [InstallmentsCriteria](#installmentscriteria) \n * [ItemsFilter](#itemsfilter) \n * [Operator](#operator) \n * [PageEntityIdentifier](#pageentityidentifier) \n * [ProductUniqueIdentifierField](#productuniqueidentifierfield) \n * [SORT](#sort) \n * [SimulationBehavior](#simulationbehavior)\n* [Scalars](#scalars) \n * [Boolean](#boolean) \n * [Float](#float) \n * [ID](#id) \n * [Int](#int) \n * [String](#string) \n * [StringOrBoolean](#stringorboolean)\n\n## Query\n\n| Field | Argument | Type | Description |\n| --------------------------------- | -------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| **product** | [Product](#product) | Returns a specified product. | |\n| slug | [String](#string) | Product slug. | |\n| identifier | [ProductUniqueIdentifier](#productuniqueidentifier) | Product identifier. | |\n| regionId | [String](#string) | Seller ID encoded with base64 according to this format: SW#{sellerId}. | |\n| salesChannel | [Int](#int) | Trade Policy. | |\n| **banners** | [Banners](#banners) | Lists the banners registered for a given query. Check the [configuring banners documentation](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/4ViKEivLJtJsvpaW0aqIQ5) for a full explanation of the banner feature. | |\n| fullText | [String](#string) | Search term. It can contain any character. | |\n| selectedFacets | \\[[SelectedFacetInput](#selectedfacetinput)\\] | List of the selected facets. The order in which the terms appear is not relevant to the search. You can also repeat the same facetKey several times for different values. | |\n| **correction** | [Correction](#correction) | Tries to correct a misspelled term from the search. | |\n| fullText | [String](#string) | Search term. It can contain any character. | |\n| **searchSuggestions** | [SearchSuggestions](#searchsuggestions) | Lists suggested terms similar to the search term. | |\n| fullText | [String](#string)! | Search term. It can contain any character. | |\n| **productSearch** | [ProductSearch](#productsearch) | Lists the products for a given query. | |\n| query | [String](#string) | **Deprecated**. Use fullText instead. | |\n| fullText | [String](#string) | Search term. It can contain any character. | |\n| map | [String](#string) | **Deprecated**. Use selectedFacets instead. | |\n| selectedFacets | \\[[SelectedFacetInput](#selectedfacetinput)\\] | List of the selected facets. The order in which the terms appear is not relevant to the search. You can also repeat the same facetKey several times for different values. | |\n| category | [String](#string) | **Deprecated**. Use selectedFacets instead. | |\n| specificationFilters | \\[[String](#string)\\] | **Deprecated**. Use selectedFacets instead. | |\n| priceRange | [String](#string) | Filter by price range. e.g.: {a} TO {b} - {a} is the minimum price \"from\" and {b} is the highest price \"to\" | |\n| collection | [String](#string) | **Deprecated**. Use selectedFacets instead. | |\n| salesChannel | [String](#string) | Filter by availability at a specific sales channel. e.g.: salesChannel:4 if want filter by available products for the sales channel 4. | |\n| orderBy | [String](#string) | Sort by a criteria: OrderByPriceDESC/OrderByPriceASC: Price, in descending (DESC) or ascending (ASC) order.OrderByTopSaleDESC: Amount of orders in the past 90 days, in descending order.OrderByReviewRateDESC: Review rates, in descending (DESC) order.OrderByNameASC/OrderByNameDESC: Name, in descending (DESC) or ascending (ASC) alphabetical order.OrderByReleaseDateDESC: Release date, in descending (DESC) order. OrderByBestDiscountDESC: Discount percentage in descending (DESC) order.OrderByScoreDESC: Score, in descending (DESC) order. If you want to sort textually by a specification, use the format {specification key}:{asc\\|desc}. For example: material:asc or material:desc. This always sorts values textually (not numerically) and it works only on [vtex.search-resolver@1.x](mailto:vtex.search-resolver@1.x). | |\n| from | [Int](#int) | Pagination item start. Default value: 0. | |\n| to | [Int](#int) | Pagination item end. Default value: 9. | |\n| hideUnavailableItems | [Boolean](#boolean) | If true, uses isAvailablePerSalesChannel\\_ parameter on query with segment's sales channel. Will override any given salesChannel argument. | |\n| simulationBehavior | [SimulationBehavior](#simulationbehavior) | If you want faster searches and do not care about most up to date prices and promotions, use skip value. | |\n| productOriginVtex | [Boolean](#boolean) | Each search engine has its own database, but this database might not have all the product information like clusterHighlights or productClusters. As an alternative, the search engine may use the VTEX API to complete this information by setting this field to true. | |\n| operator | [Operator](#operator) | Indicates how the search engine will deal with the fullText if there is more than one word. Set the value as and if the returned products must have all the words in its metadata. Otherwise, set the value as or. | |\n| fuzzy | [String](#string) | Indicates how the search engine will correct misspelled words by using fuzzy logic. It can be a number representing the max number of misspelled letters, or the string auto suggesting that the search engine should set this value by itself. | |\n| searchState | [String](#string) | As fuzzy and operator, it controls the search state, but it is for general purposes. This field allows the search engines to apply features that are not handled by the other fields. The possible values in this field are defined by each search engine. | |\n| options | [Options](#options) | Search options that customize the search result. | |\n| **searchMetadata** | [SearchMetadata](#searchmetadata) | | |\n| query | [String](#string) | Terms that are used in search, for example eletronics/samsung. | |\n| fullText | [String](#string) | Text inputted by the user as the search term. | |\n| map | [String](#string) | Defines term types: Brand, Category, Department. For example: c,b. | |\n| selectedFacets | \\[[SelectedFacetInput](#selectedfacetinput)\\] | List of the selected facets. The order in which the terms appear is not relevant to the search. You can also repeat the same facetKey several times for different values. | |\n| **products** | \\[[Product](#product)\\] | Returns products list filtered and ordered. | |\n| query | [String](#string) | Terms that are used in search, for example eletronics/samsung. | |\n| map | [String](#string) | Defines term types: Brand, Category, Department. For example: c,b. | |\n| category | [String](#string) | Filter by category. For example, {a}/{b}, where {a} and {b} are categoryIds. | |\n| specificationFilters | \\[[String](#string)\\] | Array of product specification. For example, specificationFilter\\_{a}:{b} where {a} is the specificationId, and {b} is the specification value. | |\n| priceRange | [String](#string) | Filter by price range. For example, {a} TO {b}, where {a} is the minimum price \"from\" and {b} is the highest price \"to\". | |\n| collection | [String](#string) | Filter by collection, also known as productClusterId. | |\n| salesChannel | [String](#string) | Filter by availability at a specific sales channel, also known as trade policy. For example, salesChannel:4 if you want to filter by available products for the sales channel whose ID is 4. | |\n| orderBy | [String](#string) | Sort by a criteria: OrderByPriceDESC/OrderByPriceASC: Price, in descending (DESC) or ascending (ASC) order.OrderByTopSaleDESC: Amount of orders in the past 90 days, in descending order.OrderByReviewRateDESC: Review rates, in descending (DESC) order.OrderByNameASC/OrderByNameDESC: Name, in descending (DESC) or ascending (ASC) alphabetical order.OrderByReleaseDateDESC: Release date, in descending (DESC) order. OrderByBestDiscountDESC: Discount percentage in descending (DESC) order.OrderByScoreDESC: Score, in descending (DESC) order. | |\n| from | [Int](#int) | Pagination item start. Default value: 0. | |\n| to | [Int](#int) | Pagination item end. Default value: 9. | |\n| hideUnavailableItems | [Boolean](#boolean) | If true, uses isAvailablePerSalesChannel\\_ parameter on query with segment's sales channel. Will override any given salesChannel argument. | |\n| simulationBehavior | [SimulationBehavior](#simulationbehavior) | If you want faster searches and do not care about most up to date prices and promotions, use skip value. | |\n| **productRecommendations** | \\[[Product](#product)\\] | | |\n| identifier | [ProductUniqueIdentifier](#productuniqueidentifier) | | |\n| type | [CrossSelingInputEnum](#crossselinginputenum) | | |\n| groupBy | [CrossSelingGroupByEnum](#crossselinggroupbyenum) | | |\n| **productsByIdentifier** | \\[[Product](#product)\\] | | |\n| field | [ProductUniqueIdentifierField](#productuniqueidentifierfield)! | | |\n| values | \\[[ID](#id)!\\] | | |\n| salesChannel | [String](#string) | Filter by availability at a specific sales channel. | |\n| **facets** | [Facets](#facets) | Returns facets category. | |\n| query | [String](#string) | **Deprecated**. Use fullText instead. | |\n| fullText | [String](#string) | Search term. It can contain any character. | |\n| map | [String](#string) | **Deprecated**. Use selectedFacets instead. | |\n| selectedFacets | \\[[SelectedFacetInput](#selectedfacetinput)\\] | List of the selected facets. The order in which the terms appear is not relevant to the search. You can also repeat the same facetKey several times for different values. | |\n| hideUnavailableItems | [Boolean](#boolean) | If true, uses isAvailablePerSalesChannel\\_ parameter on query with segment's sales channel. | |\n| removeHiddenFacets | [Boolean](#boolean) | If true, remove hidden facets from the result. | |\n| behavior | [String](#string) | If Static, ignores SpecificationFilters received on the map and query when returning the facets available, which means the facets never change. | |\n| operator | [Operator](#operator) | Indicates how the search engine will deal with the fullText if there is more than one word. Set the value as and if the returned products must have all the words in its metadata. Otherwise, set the value as or. | |\n| fuzzy | [String](#string) | Indicates how the search engine will correct misspelled words by using fuzzy logic. It can be a number representing the max number of misspelled letters, or the string auto suggesting that the search engine should set this value by itself. | |\n| searchState | [String](#string) | As fuzzy and operator, it controls the search state, but it is for general purposes. This field allows the search engines to apply features that are not handled by the other fields. The possible values in this field are defined by each search engine. | |\n| from | [Int](#int) | Pagination item start. Default value: 0. | |\n| to | [Int](#int) | Pagination item end. Default value: 9. | |\n| categoryTreeBehavior | [CategoryTreeBehavior](#categorytreebehavior) | Determines the behavior of the category tree. | |\n| initialAttributes | [String](#string) | Initial attributes (based on the initialMap parameter). | |\n| **autocomplete** | [Suggestions](#suggestions) | Get autocomplete suggestions in search. | |\n| maxRows | [Int](#int) | Number of items that are returned. | |\n| searchTerm | [String](#string) | Terms that are used in search, for example iphone. | |\n| **topSearches** | [SearchSuggestions](#searchsuggestions) | Lists the 10 most searched terms. | |\n| **autocompleteSearchSuggestions** | [SearchSuggestions](#searchsuggestions) | Lists the suggested terms and attributes similar to the search term. | |\n| fullText | [String](#string)! | Search term. It can contain any character. | |\n| **productSuggestions** | [ProductSuggestions](#productsuggestions) | Get product suggestions. | |\n| fullText | [String](#string)! | Text inputted by the user as the search term. | |\n| facetKey | [String](#string) | Selected facet key. | |\n| facetValue | [String](#string) | Selected facet value. | |\n| productOriginVtex | [Boolean](#boolean) | Each search engine has its own database, but this database might not have all the product information like clusterHighlights or productClusters. As an alternative, the search engine may use the VTEX API to complete this information by setting this field to true. | |\n| simulationBehavior | [SimulationBehavior](#simulationbehavior) | If you want faster searches and do not care about most up to date prices and promotions, use skip value. | |\n| hideUnavailableItems | [Boolean](#boolean) | If true, uses isAvailablePerSalesChannel\\_ parameter on query with segment's sales channel. | |\n| regionId | [String](#string) | Seller ID encoded with base64 according to this format: SW#{sellerId}. | |\n| salesChannel | [Int](#int) | Sales Channel related to the region ID. | |\n| orderBy | [String](#string) | Sort by a criteria: OrderByPriceDESC/OrderByPriceASC: Price, in descending (DESC) or ascending (ASC) order.OrderByTopSaleDESC: Amount of orders in the past 90 days, in descending order.OrderByReviewRateDESC: Review rates, in descending (DESC) order.OrderByNameASC/OrderByNameDESC: Name, in descending (DESC) or ascending (ASC) alphabetical order.OrderByReleaseDateDESC: Release date, in descending (DESC) order. OrderByBestDiscountDESC: Discount percentage in descending (DESC) order.OrderByScoreDESC: Score, in descending (DESC) order. If you want to sort textually by a specification, use the format {specification key}:{asc\\|desc}. For example: material:asc or material:desc. This always sorts values textually (not numerically) and it works only on [vtex.search-resolver@1.x](mailto:vtex.search-resolver@1.x). | |\n| **searchURLsCount** | \\[[SearchURLStats](#searchurlstats)\\] | Get search URLs access stats count. | |\n| limit | [Int](#int) | Number of items that are returned. | |\n| sort | [SORT](#sort) | Sorting strategy, where asc means ascending, and desc means descending. | |\n\n## Objects\n\n### AssemblyOption\n\n| Field | Argument | Type | Description |\n| ----------- | ----------------------------------- | ---- | ----------- |\n| id | [ID](#id) | | |\n| name | [String](#string) | | |\n| required | [Boolean](#boolean) | | |\n| composition | [CompositionType](#compositiontype) | | |\n| inputValues | [InputValue](#inputvalue)\\[\\] | | |\n\n### Attachment\n\n| Field | Argument | Type | Description |\n| ------------ | --------------------------------- | ---- | ----------- |\n| id | [ID](#id) | | |\n| name | [String](#string) | | |\n| required | [Boolean](#boolean) | | |\n| domainValues | [DomainValues](#domainvalues)\\[\\] | | |\n\n### Banners\n\n| Field | Argument | Type | Description |\n| ------- | --------------------------------- | ---------------- | ----------- |\n| banners | [SearchBanner](#searchbanner)\\[\\] | List of banners. | |\n\n### Benefit\n\n| Field | Argument | Type | Description |\n| -------------- | ------------------------------- | ----------------------------------------------------- | ----------- |\n| **featured** | [Boolean](#boolean) | Indicates if the benefit is featured or not. | |\n| **id** | [String](#string) | ID of the product to which the benefit is associated. | |\n| **name** | [String](#string) | Name of the benefit. | |\n| **items** | \\[[BenefitItem](#benefititem)\\] | Items of the benefit. | |\n| **teaserType** | [String](#string) | Type of benefit. | |\n\n### BenefitItem\n\n| Field | Argument | Type | Description |\n| ------------------ | --------------------- | --------------------------------------------------------------------------------- | ----------- |\n| **benefitProduct** | [Product](#product) | Product itself. | |\n| **benefitSKUIds** | \\[[String](#string)\\] | IDs of the SKUs that are taking part in the benefit. | |\n| **discount** | [Float](#float) | Discount applied to the benefit product. | |\n| **minQuantity** | [Int](#int) | Minimum quantity of the benefit product that is required to validate the benefit. | |\n\n### Brand\n\n| Field | Argument | Type | Description |\n| ---------------------- | ------------------- | --------------------------------- | ----------- |\n| **cacheId** | [ID](#id) | Slug is used as cacheId. | |\n| **id** | [Int](#int) | Brand ID. | |\n| **imageUrl** | [String](#string) | Brand logo. | |\n| **slug** | [String](#string) | Text link. | |\n| **name** | [String](#string) | Name of the brand. | |\n| **titleTag** | [String](#string) | Title used by HTML title tag. | |\n| **metaTagDescription** | [String](#string) | Description used by HTML tag. | |\n| **active** | [Boolean](#boolean) | Indicates if the brand is active. | |\n\n### BrandFacet\n\n| Field | Argument | Type | Description |\n| --------------- | -------------------- | ---- | ----------- |\n| **id** | [ID](#id)! | | |\n| **quantity** | [Int](#int)! | | |\n| **name** | [String](#string)! | | |\n| **link** | [String](#string)! | | |\n| **linkEncoded** | [String](#string)! | | |\n| **map** | [String](#string) | | |\n| **value** | [String](#string)! | | |\n| **selected** | [Boolean](#boolean)! | | |\n\n### CategoriesTreeFacet\n\n| Field | Argument | Type | Description |\n| --------------- | ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ----------- |\n| **id** | [ID](#id)! | | |\n| **quantity** | [Int](#int)! | | |\n| **name** | [String](#string) | | |\n| **link** | [String](#string)! | | |\n| **linkEncoded** | [String](#string)! | | |\n| **href** | [String](#string)! | Contains slugified links according to the store structure, such as /:department/d, /:category/:subcategory, etc. | |\n| **map** | [String](#string) | | |\n| **value** | [String](#string)! | | |\n| **children** | \\[[CategoriesTreeFacet](#categoriestreefacet)\\] | | |\n| **selected** | [Boolean](#boolean)! | | |\n\n### Category\n\n| Field | Argument | Type | Description |\n| ---------------------- | ------------------------- | -------------------------------------------------- | ----------- |\n| **cacheId** | [ID](#id) | Category ID is used as cacheId. | |\n| **href** | [String](#string) | URI of category. | |\n| **slug** | [String](#string) | Category text link. | |\n| **id** | [Int](#int) | Category ID. | |\n| **name** | [String](#string) | Category name. | |\n| **titleTag** | [String](#string) | Title used by HTML title tag. | |\n| **hasChildren** | [Boolean](#boolean) | Description used by HTML tag. | |\n| **metaTagDescription** | [String](#string) | Indicates if the category has children categories. | |\n| **children** | \\[[Category](#category)\\] | Category children. | |\n\n### ClusterHighlight\n\n| Field | Argument | Type | Description |\n| -------- | ----------------- | ---- | ----------- |\n| **id** | [ID](#id) | | |\n| **name** | [String](#string) | | |\n\n### CompositionItem\n\n| Field | Argument | Type | Description |\n| ------------------- | ----------------- | ---- | ----------- |\n| **id** | [ID](#id) | | |\n| **minQuantity** | [Int](#int) | | |\n| **maxQuantity** | [Int](#int) | | |\n| **initialQuantity** | [Int](#int) | | |\n| **priceTable** | [String](#string) | | |\n| **seller** | [String](#string) | | |\n\n### CompositionType\n\n| Field | Argument | Type | Description |\n| --------------- | --------------------------------------- | ---- | ----------- |\n| **minQuantity** | [Int](#int) | | |\n| **maxQuantity** | [Int](#int) | | |\n| **items** | \\[[CompositionItem](#compositionitem)\\] | | |\n\n### Correction\n\n| Field | Argument | Type | Description |\n| -------------- | ------------------------------------- | ---- | ----------- |\n| **correction** | [SearchCorrection](#searchcorrection) | | |\n\n### DeliverySlaPerTypes\n\n| Field | Argument | Type | Description |\n| ------------------------------- | ----------------- | ---- | ----------- |\n| **TypeName** | [String](#string) | | |\n| **Price** | [Float](#float) | | |\n| **EstimatedTimeSpanToDelivery** | [String](#string) | | |\n\n### DeliverySlaSamples\n\n| Field | Argument | Type | Description |\n| ----------------------- | ----------------------------------------------- | ---- | ----------- |\n| **DeliverySlaPerTypes** | \\[[DeliverySlaPerTypes](#deliveryslapertypes)\\] | | |\n| **Region** | [Region](#region) | | |\n\n### DepartmentFacet\n\n| Field | Argument | Type | Description |\n| --------------- | -------------------- | ---- | ----------- |\n| **id** | [ID](#id)! | | |\n| **quantity** | [Int](#int)! | | |\n| **name** | [String](#string) | | |\n| **link** | [String](#string)! | | |\n| **linkEncoded** | [String](#string)! | | |\n| **map** | [String](#string) | | |\n| **value** | [String](#string)! | | |\n| **selected** | [Boolean](#boolean)! | | |\n\n### Discount\n\nDiscount object\n\n| Field | Argument | Type | Description |\n| -------- | ----------------- | ------------- | ----------- |\n| **name** | [String](#string) | Discount name | |\n\n### DomainValues\n\n| Field | Argument | Type | Description |\n| ---------------- | ----------------- | ---- | ----------- |\n| **FieldName** | [String](#string) | | |\n| **MaxCaracters** | [String](#string) | | |\n| **DomainValues** | [String](#string) | | |\n\n### Facet\n\n| Field | Argument | Type | Description |\n| ------------ | ----------------------------- | ---- | ----------- |\n| **name** | [String](#string) | | |\n| **values** | \\[[FacetValue](#facetvalue)\\] | | |\n| from | [Int](#int) | | |\n| to | [Int](#int) | | |\n| **type** | [FilterType](#filtertype) | | |\n| **hidden** | [Boolean](#boolean) | | |\n| **quantity** | [Int](#int) | | |\n\n### FacetValue\n\n| Field | Argument | Type | Description |\n| --------------- | ----------------------------- | ---- | ----------- |\n| **id** | [ID](#id) | | |\n| **quantity** | [Int](#int)! | | |\n| **name** | [String](#string) | | |\n| **key** | [String](#string) | | |\n| **value** | [String](#string) | | |\n| **selected** | [Boolean](#boolean) | | |\n| **children** | \\[[FacetValue](#facetvalue)\\] | | |\n| **range** | [Range](#range) | | |\n| **link** | [String](#string) | | |\n| **linkEncoded** | [String](#string) | | |\n| **href** | [String](#string) | | |\n\n### Facets\n\n| Field | Argument | Type | Description |\n| ------------------------ | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| **departments** ⚠️ | \\[[DepartmentFacet](#departmentfacet)\\] | ⚠️ **DEPRECATED**Use facets instead. | |\n| **brands** ⚠️ | \\[[BrandFacet](#brandfacet)\\] | ⚠️ **DEPRECATED**Use facets instead. | |\n| **specificationFilters** | \\[[FilterFacets](#filterfacets)\\] | | |\n| **categoriesTrees** ⚠️ | \\[[CategoriesTreeFacet](#categoriestreefacet)\\] | ⚠️ **DEPRECATED**Use facets instead. | |\n| **priceRanges** | \\[[PriceRangesFacet](#pricerangesfacet)\\] | Price range for the given query. | |\n| **recordsFiltered** ⚠️ | [Int](#int) | ⚠️ **DEPRECATED**Use recordsFiltered from productSearch instead. | |\n| **queryArgs** | [QueryArgs](#queryargs) | Information about the searched query. | |\n| **facets** | \\[[Facet](#facet)\\] | List of facets. | |\n| **sampling** | [Boolean](#boolean) | Indicates whether there was sampling in the aggregation of facets or not. In search results that have many products, only the first 30000 will be aggregated to avoid performance issues. | |\n| **breadcrumb** | \\[[SearchBreadcrumb](#searchbreadcrumb)\\] | Generated breadcrumb for the given query. | |\n\n### FilterFacet\n\n| Field | Argument | Type | Description |\n| --------------- | -------------------- | ---- | ----------- |\n| **quantity** | [Int](#int)! | | |\n| **name** | [String](#string) | | |\n| **link** | [String](#string)! | | |\n| **linkEncoded** | [String](#string)! | | |\n| **map** | [String](#string) | | |\n| **value** | [String](#string)! | | |\n| **selected** | [Boolean](#boolean)! | | |\n\n### FilterFacets\n\n| Field | Argument | Type | Description |\n| ---------- | ------------------------------- | ---- | ----------- |\n| **name** | [String](#string) | | |\n| **facets** | \\[[FilterFacet](#filterfacet)\\] | | |\n\n### Gift\n\n| Field | Argument | Type | Description |\n| --------------- | --------------------------- | ---- | ----------- |\n| **productName** | [String](#string) | | |\n| **skuName** | [String](#string) | | |\n| **brand** | [String](#string) | | |\n| **linkText** | [String](#string) | | |\n| **description** | [String](#string) | | |\n| **images** | \\[[GiftImage](#giftimage)\\] | | |\n\n### GiftImage\n\n| Field | Argument | Type | Description |\n| -------------- | ----------------- | ---- | ----------- |\n| **imageUrl** | [String](#string) | | |\n| **imageLabel** | [String](#string) | | |\n| **imageText** | [String](#string) | | |\n\n### Image\n\n| Field | Argument | Type | Description |\n| -------------- | ----------------- | ---- | ----------- |\n| **cacheId** | [ID](#id) | | |\n| **imageId** | [ID](#id) | | |\n| **imageLabel** | [String](#string) | | |\n| **imageTag** | [String](#string) | | |\n| **imageUrl** | [String](#string) | | |\n| **imageText** | [String](#string) | | |\n\n### InputValue\n\n| Field | Argument | Type | Description |\n| ---------------- | ----------------------------------- | ---- | ----------- |\n| **label** | [String](#string) | | |\n| **maxLength** | [Int](#int) | | |\n| **type** | [InputValueType](#inputvaluetype) | | |\n| **defaultValue** | [StringOrBoolean](#stringorboolean) | | |\n| **domain** | \\[[String](#string)\\] | | |\n\n### Installment\n\n| Field | Argument | Type | Description |\n| ------------------------------ | ----------------- | ---- | ----------- |\n| **Value** | [Float](#float) | | |\n| **InterestRate** | [Float](#float) | | |\n| **TotalValuePlusInterestRate** | [Float](#float) | | |\n| **NumberOfInstallments** | [Int](#int) | | |\n| **PaymentSystemName** | [String](#string) | | |\n| **PaymentSystemGroupName** | [String](#string) | | |\n| **Name** | [String](#string) | | |\n\n### ItemMetadata\n\n| Field | Argument | Type | Description |\n| -------------- | ----------------------------------------- | ---- | ----------- |\n| **items** | \\[[ItemMetadataUnit](#itemmetadataunit)\\] | | |\n| **priceTable** | \\[[ItemPriceTable](#itempricetable)\\] | | |\n\n### ItemMetadataUnit\n\n| Field | Argument | Type | Description |\n| ------------------- | ------------------------------------- | ---- | ----------- |\n| **id** | [ID](#id) | | |\n| **name** | [String](#string) | | |\n| **skuName** | [String](#string) | | |\n| **productId** | [String](#string) | | |\n| **refId** | [String](#string) | | |\n| **ean** | [String](#string) | | |\n| **imageUrl** | [String](#string) | | |\n| **detailUrl** | [String](#string) | | |\n| **seller** | [String](#string) | | |\n| **assemblyOptions** | \\[[AssemblyOption](#assemblyoption)\\] | | |\n\n### ItemPriceTable\n\n| Field | Argument | Type | Description |\n| ---------- | ------------------------------------- | ---- | ----------- |\n| **type** | [String](#string) | | |\n| **values** | \\[[PriceTableItem](#pricetableitem)\\] | | |\n\n### Items\n\n| Field | Argument | Type | Description |\n| ------------- | ----------------- | ---- | ----------- |\n| **thumb** | [String](#string) | | |\n| **name** | [String](#string) | | |\n| **href** | [String](#string) | | |\n| **criteria** | [String](#string) | | |\n| **slug** | [String](#string) | | |\n| **productId** | [String](#string) | | |\n\n### KitItem\n\n| Field | Argument | Type | Description |\n| ----------- | --------------------------- | ---- | ----------- |\n| **itemId** | [ID](#id) | | |\n| **amount** | [Int](#int) | | |\n| **product** | [OnlyProduct](#onlyproduct) | | |\n| **sku** | [SKU](#sku) | | |\n\n### Offer\n\n| Field | Argument | Type | Description |\n| ---------------------------------- | --------------------------------------------- | --------------------------------------------------- | ----------- |\n| **Installments** | \\[[Installment](#installment)\\] | | |\n| criteria | [InstallmentsCriteria](#installmentscriteria) | | |\n| rates | [Boolean](#boolean) | | |\n| excludedPaymentSystems | \\[[String](#string)\\] | | |\n| includedPaymentSystems | \\[[String](#string)\\] | | |\n| **Price** | [Float](#float) | | |\n| **ListPrice** | [Float](#float) | | |\n| **spotPrice** | [Float](#float) | | |\n| **PriceWithoutDiscount** | [Float](#float) | | |\n| **RewardValue** | [Float](#float) | | |\n| **PriceValidUntil** | [String](#string) | | |\n| **AvailableQuantity** | [Float](#float) | | |\n| **Tax** | [Float](#float) | | |\n| **taxPercentage** | [Float](#float) | | |\n| **CacheVersionUsedToCallCheckout** | [String](#string) | | |\n| **DeliverySlaSamples** | \\[[DeliverySlaSamples](#deliveryslasamples)\\] | | |\n| **discountHighlights** | \\[[Discount](#discount)!\\] | List of discount highlights. | |\n| **teasers** | \\[[Teaser](#teaser)!\\] | | |\n| **giftSkuIds** | \\[[String](#string)\\] | List of SKUs for gifts associated with the product. | |\n| **gifts** | \\[[Gift](#gift)\\] | List of gifts associated with the product. | |\n\n### OnlyProduct\n\n| Field | Argument | Type | Description |\n| ---------------------- | ----------------------------------------- | ---- | ----------- |\n| **brand** | [String](#string) | | |\n| **categoryId** | [ID](#id) | | |\n| **categoryTree** | \\[[Category](#category)\\] | | |\n| **clusterHighlights** | \\[[ClusterHighlight](#clusterhighlight)\\] | | |\n| **productClusters** | \\[[ProductClusters](#productclusters)\\] | | |\n| **description** | [String](#string) | | |\n| **link** | [String](#string) | | |\n| **linkText** | [String](#string) | | |\n| **productId** | [ID](#id) | | |\n| **productName** | [String](#string) | | |\n| **properties** | \\[[Property](#property)\\] | | |\n| **propertyGroups** | \\[[PropertyGroup](#propertygroup)\\] | | |\n| **productReference** | [String](#string) | | |\n| **recommendations** | [Recommendation](#recommendation) | | |\n| **jsonSpecifications** | [String](#string) | | |\n\n### PageType\n\n| Field | Argument | Type | Description |\n| -------- | --------------------------------------------- | ---- | ----------- |\n| **id** | [String](#string) | | |\n| **type** | [PageEntityIdentifier](#pageentityidentifier) | | |\n\n### PriceRange\n\n| Field | Argument | Type | Description |\n| ------------- | --------------- | ---- | ----------- |\n| **highPrice** | [Float](#float) | | |\n| **lowPrice** | [Float](#float) | | |\n\n### PriceRangesFacet\n\n| Field | Argument | Type | Description |\n| --------------- | -------------------- | ---- | ----------- |\n| **quantity** | [Int](#int)! | | |\n| **name** | [String](#string) | | |\n| **link** | [String](#string)! | | |\n| **linkEncoded** | [String](#string)! | | |\n| **map** | [String](#string) | | |\n| **value** | [String](#string)! | | |\n| **selected** | [Boolean](#boolean)! | | |\n| **slug** | [String](#string) | | |\n\n### PriceTableItem\n\n| Field | Argument | Type | Description |\n| -------------- | ----------------- | ---- | ----------- |\n| **id** | [String](#string) | | |\n| **assemblyId** | [String](#string) | | |\n| **price** | [Int](#int) | | |\n\n### Product\n\n| Field | Argument | Type | Description |\n| ----------------------- | --------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ----------- |\n| **brand** | [String](#string) | Brand of the product. | |\n| **brandId** | [Int](#int) | ID of the brand of the product. | |\n| **cacheId** | [ID](#id) | LinkText is used as cacheId. | |\n| **categoryId** | [ID](#id) | | |\n| **categories** ⚠️ | \\[[String](#string)\\] | Categories of the product.⚠️ **DEPRECATED** Use categoryTree field for internationalization support. | |\n| **categoryTree** | \\[[Category](#category)\\] | Product's category tree. | |\n| **clusterHighlights** | \\[[ClusterHighlight](#clusterhighlight)\\] | List of related products. | |\n| **productClusters** | \\[[ProductClusters](#productclusters)\\] | | |\n| **description** | [String](#string) | Product description. | |\n| **items** | \\[[SKU](#sku)\\] | SKU objects of the product. | |\n| filter | [ItemsFilter](#itemsfilter) | | |\n| **skuSpecifications** | \\[[SkuSpecification](#skuspecification)\\] | List of SKU Specifications. | |\n| **link** | [String](#string) | Product URL. | |\n| **linkText** | [String](#string) | Product slug. | |\n| **productId** | [ID](#id) | Product ID. | |\n| **productName** | [String](#string) | Product name. | |\n| **properties** | \\[[Property](#property)\\] | Array of product properties. | |\n| **propertyGroups** | \\[[PropertyGroup](#propertygroup)\\] | Array of product properties. | |\n| **productReference** | [String](#string) | Product reference. | |\n| **titleTag** | [String](#string) | Title used by HTML title tag. | |\n| **metaTagDescription** | [String](#string) | Description used by HTML tag. | |\n| **recommendations** | [Recommendation](#recommendation) | Related Products. | |\n| **jsonSpecifications** | [String](#string) | JSON specification of the product. | |\n| **benefits** | \\[[Benefit](#benefit)\\] | List of benefits associated with this product. | |\n| **itemMetadata** | [ItemMetadata](#itemmetadata) | | |\n| **specificationGroups** | \\[[SpecificationGroup](#specificationgroup)\\] | Array of product SpecificationGroup. | |\n| **priceRange** | [ProductPriceRange](#productpricerange) | Returns highest and lowest prices for available SKUs in product. | |\n| **releaseDate** | [String](#string) | Product Release Date, for list ordering and product cluster highlight. | |\n| **selectedProperties** | \\[[SelectedProperty](#selectedproperty)\\] | Product properties that will be selected by default. For example, {key: \"Color\", value: \"Blue\"} | |\n\n### ProductClusters\n\n| Field | Argument | Type | Description |\n| -------- | ----------------- | ---- | ----------- |\n| **id** | [ID](#id) | | |\n| **name** | [String](#string) | | |\n\n### ProductPriceRange\n\n| Field | Argument | Type | Description |\n| ---------------- | ------------------------- | ---- | ----------- |\n| **sellingPrice** | [PriceRange](#pricerange) | | |\n| **listPrice** | [PriceRange](#pricerange) | | |\n\n### ProductSearch\n\n| Field | Argument | Type | Description |\n| ---------------------- | ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| **products** | \\[[Product](#product)\\] | List of products. | |\n| **recordsFiltered** | [Int](#int) | Total number of products. | |\n| **titleTag** | [String](#string) | Title used in the title tag. | |\n| **metaTagDescription** | [String](#string) | String to be used in the <meta name=\"description\"... tag. | |\n| **breadcrumb** ⚠️ | \\[[SearchBreadcrumb](#searchbreadcrumb)\\] | ⚠️ **DEPRECATED**Use breadcrumb from the facets query instead. | |\n| **canonical** | [String](#string) | | |\n| **suggestion** ⚠️ | [SearchSuggestions](#searchsuggestions) | ⚠️ **DEPRECATED**Use the suggestion query instead. | |\n| **correction** | [SearchCorrection](#searchcorrection) | Object that indicates if the term was misspelled and suggests a possible correction. | |\n| **operator** | [Operator](#operator) | Indicates how the search engine deals with the fullText when there is more than one word.and: The results will contain all the words in the query. or: The results will contain at least one word from the original search query.If and was not possible, or will be the fallback. | |\n| **fuzzy** | [String](#string) | Indicates how the search engine corrected the misspelled word by using fuzzy logic. It can be a number representing the max number ofmisspelled letters, or the string auto suggesting that the search engine should set this value by itself. | |\n| **searchState** | [String](#string) | As fuzzy and operator, it controls the search state, but it is for general purposes. This field allows the search engines to applyfeatures that are not handled by the other fields.The possible values in this field are defined by each search engine. | |\n| **banners** ⚠️ | \\[[SearchBanner](#searchbanner)\\] | ⚠️ **DEPRECATED**Use the banners query instead. | |\n| **redirect** | [String](#string) | Returns the redirect URL set for the given query. | |\n\n### ProductSuggestions\n\n| Field | Argument | Type | Description |\n| -------------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |\n| **count** | [Int](#int)! | Number of suggested products. | |\n| **products** | \\[[Product](#product)\\]! | Suggested products. | |\n| **misspelled** | [Boolean](#boolean) | Indicates if the term is misspelled or not. | |\n| **operator** | [Operator](#operator) | Indicates how the search engine will deal with the fullText if there is more than one word. Set the value as and if the returned products must have all the words in its metadata. Otherwise, set the value as or. | |\n\n### Property\n\n| Field | Argument | Type | Description |\n| ---------------- | --------------------- | ---- | ----------- |\n| **originalName** | [String](#string) | | |\n| **name** | [String](#string) | | |\n| **values** | \\[[String](#string)\\] | | |\n\n### PropertyGroup\n\n| Field | Argument | Type | Description |\n| -------------- | --------------------- | ---- | ----------- |\n| **name** | [String](#string) | | |\n| **properties** | \\[[String](#string)\\] | | |\n\n### QueryArgs\n\n| Field | Argument | Type | Description |\n| ------------------ | ----------------------------------- | ---- | ----------- |\n| **map** | [String](#string) | | |\n| **query** | [String](#string) | | |\n| **selectedFacets** | \\[[SelectedFacet](#selectedfacet)\\] | | |\n\n### Range\n\n| Field | Argument | Type | Description |\n| -------- | --------------- | ---- | ----------- |\n| **from** | [Float](#float) | | |\n| **to** | [Float](#float) | | |\n\n### Recommendation\n\n| Field | Argument | Type | Description |\n| ------------ | ----------------------- | ---- | ----------- |\n| **buy** | \\[[Product](#product)\\] | | |\n| **view** | \\[[Product](#product)\\] | | |\n| **similars** | \\[[Product](#product)\\] | | |\n\n### Reference\n\n| Field | Argument | Type | Description |\n| --------- | ----------------- | ---- | ----------- |\n| **Key** | [String](#string) | | |\n| **Value** | [String](#string) | | |\n\n### Region\n\n| Field | Argument | Type | Description |\n| ------------------- | ------------------- | ---- | ----------- |\n| **IsPersisted** | [Boolean](#boolean) | | |\n| **IsRemoved** | [Boolean](#boolean) | | |\n| **Id** | [ID](#id) | | |\n| **Name** | [String](#string) | | |\n| **CountryCode** | [String](#string) | | |\n| **ZipCode** | [String](#string) | | |\n| **CultureInfoName** | [String](#string) | | |\n\n### SKU\n\n### SKU\n\n| Field | Argument | Type | Description |\n| ------------------------ | ----------------------------- | ------------------------------------------- | ----------- |\n| **itemId** | [ID](#id) | | |\n| **name** | [String](#string) | | |\n| **nameComplete** | [String](#string) | | |\n| **complementName** | [String](#string) | | |\n| **ean** | [String](#string) | | |\n| **referenceId** | \\[[Reference](#reference)\\] | | |\n| **measurementUnit** | [String](#string) | | |\n| **unitMultiplier** | [Float](#float) | | |\n| **kitItems** | \\[[KitItem](#kititem)\\] | | |\n| **images** | \\[[Image](#image)\\] | | |\n| quantity | [Int](#int) | | |\n| **videos** | \\[[Video](#video)\\] | | |\n| **sellers** | \\[[Seller](#seller)\\] | | |\n| **variations** | \\[[Property](#property)\\] | | |\n| **attachments** ⚠️ | \\[[Attachment](#attachment)\\] | ⚠️ **DEPRECATED** Use itemMetaData instead. | |\n| **estimatedDateArrival** | [String](#string) | | |\n\n### SKUSpecificationField\n\n| Field | Argument | Type | Description |\n| ---------------- | ----------------- | ---- | ----------- |\n| **originalName** | [String](#string) | | |\n| **name** | [String](#string) | | |\n\n### SKUSpecificationValue\n\n| Field | Argument | Type | Description |\n| ---------------- | ----------------- | ---- | ----------- |\n| **originalName** | [String](#string) | | |\n| **name** | [String](#string) | | |\n\n### SearchBanner\n\n| Field | Argument | Type | Description |\n| -------- | ----------------- | ------------ | ----------- |\n| **id** | [String](#string) | Banner ID. | |\n| **name** | [String](#string) | Banner name. | |\n| **area** | [String](#string) | Banner area. | |\n| **HTML** | [String](#string) | Banner HTML. | |\n\n### SearchBreadcrumb\n\n| Field | Argument | Type | Description |\n| -------- | ----------------- | --------------------------------------- | ----------- |\n| **name** | [String](#string) | Human-readable format of the facet key. | |\n| **href** | [String](#string) | Query link. | |\n\n### SearchCorrection\n\nObject that indicates if the term was misspelled and suggests a possible correction.\n\n| Field | Argument | Type | Description |\n| --------------- | ------------------- | --------------------------------------------------------------------------------------------------- | ----------- |\n| **text** | [String](#string) | Corrected term. If the API was not able to correct the term, it will show the original search term. | |\n| **highlighted** | [String](#string) | The same as text, but it highlights the corrected word. Useful when there is more than one word. | |\n| **misspelled** | [Boolean](#boolean) | Indicates whether the term was misspelled (true) or not (false). | |\n| **correction** | [Boolean](#boolean) | Indicates whether the API was able to suggest a correction (true) or not (false). | |\n\n### SearchMetadata\n\n| Field | Argument | Type | Description |\n| ---------------------- | ----------------- | ---- | ----------- |\n| **titleTag** | [String](#string) | | |\n| **metaTagDescription** | [String](#string) | | |\n\n### SearchSuggestion\n\n| Field | Argument | Type | Description |\n| -------------- | ----------------------------------------------------------- | ------------------------------------------------- | ----------- |\n| **term** | [String](#string)! | Search term. | |\n| **count** | [Int](#int)! | Number of times the term was searched. | |\n| **attributes** | \\[[SearchSuggestionAttribute](#searchsuggestionattribute)\\] | List of facets in which the term can be searched. | |\n\n### SearchSuggestionAttribute\n\n| Field | Argument | Type | Description |\n| -------------- | ------------------ | --------------------------------------- | ----------- |\n| **key** | [String](#string)! | Facet key. | |\n| **value** | [String](#string)! | Facet value. | |\n| **labelValue** | [String](#string)! | Human-readable format of the facet key. | |\n\n### SearchSuggestions\n\n| Field | Argument | Type | Description |\n| ------------ | ----------------------------------------- | ----------------------------- | ----------- |\n| **searches** | \\[[SearchSuggestion](#searchsuggestion)\\] | A list of search suggestions. | |\n\n### SearchURLStats\n\n| Field | Argument | Type | Description |\n| --------- | ------------------ | ---- | ----------- |\n| **path** | [String](#string)! | | |\n| **count** | [Int](#int)! | | |\n\n### SelectedFacet\n\n| Field | Argument | Type | Description |\n| --------- | ----------------- | ---- | ----------- |\n| **key** | [String](#string) | | |\n| **value** | [String](#string) | | |\n\n### SelectedProperty\n\n| Field | Argument | Type | Description |\n| --------- | ----------------- | ---- | ----------- |\n| **key** | [String](#string) | | |\n| **value** | [String](#string) | | |\n\n### Seller\n\n| Field | Argument | Type | Description |\n| ------------------- | ------------------- | ---- | ----------- |\n| **sellerId** | [ID](#id) | | |\n| **sellerName** | [String](#string) | | |\n| **addToCartLink** | [String](#string) | | |\n| **sellerDefault** | [Boolean](#boolean) | | |\n| **commertialOffer** | [Offer](#offer) | | |\n\n### SkuSpecification\n\n| Field | Argument | Type | Description |\n| ---------- | --------------------------------------------------- | ---- | ----------- |\n| **field** | [SKUSpecificationField](#skuspecificationfield) | | |\n| **values** | \\[[SKUSpecificationValue](#skuspecificationvalue)\\] | | |\n\n### SpecificationGroup\n\n| Field | Argument | Type | Description |\n| ------------------ | ------------------------------------------------------------- | ---- | ----------- |\n| **originalName** | [String](#string) | | |\n| **name** | [String](#string) | | |\n| **specifications** | \\[[SpecificationGroupProperty](#specificationgroupproperty)\\] | | |\n\n### SpecificationGroupProperty\n\n| Field | Argument | Type | Description |\n| ---------------- | --------------------- | ---- | ----------- |\n| **originalName** | [String](#string) | | |\n| **name** | [String](#string) | | |\n| **values** | \\[[String](#string)\\] | | |\n\n### Suggestions\n\n| Field | Argument | Type | Description |\n| ----------------- | ------------------- | ------------------------------------------------------ | ----------- |\n| **cacheId** | [ID](#id) | searchTerm from Query autocomplete is used as cacheId. | |\n| **itemsReturned** | \\[[Items](#items)\\] | | |\n\n### Teaser\n\n| Field | Argument | Type | Description |\n| -------------- | ----------------------------------- | ---- | ----------- |\n| **name** | [String](#string) | | |\n| **conditions** | [TeaserCondition](#teasercondition) | | |\n| **effects** | [TeaserEffects](#teasereffects) | | |\n\n### TeaserCondition\n\n| Field | Argument | Type | Description |\n| ------------------- | ------------------------------- | ---- | ----------- |\n| **minimumQuantity** | [Int](#int) | | |\n| **parameters** | \\[[TeaserValue](#teaservalue)\\] | | |\n\n### TeaserEffects\n\n| Field | Argument | Type | Description |\n| -------------- | ------------------------------- | ---- | ----------- |\n| **parameters** | \\[[TeaserValue](#teaservalue)\\] | | |\n\n### TeaserValue\n\n| Field | Argument | Type | Description |\n| --------- | ----------------- | ---- | ----------- |\n| **name** | [String](#string) | | |\n| **value** | [String](#string) | | |\n\n### Video\n\n| Field | Argument | Type | Description |\n| ------------ | ----------------- | ---- | ----------- |\n| **videoUrl** | [String](#string) | | |\n\n### productSpecification\n\n| Field | Argument | Type | Description |\n| --------------- | --------------------- | ---- | ----------- |\n| **fieldName** | [String](#string) | | |\n| **fieldValues** | \\[[String](#string)\\] | | |\n\n## Inputs\n\n### AssemblyOptionInput\n\n| Field | Type | Description |\n| -------------- | ------------------------------------------------ | ----------- |\n| **id** | [ID](#id)! | |\n| **quantity** | [Int](#int)! | |\n| **assemblyId** | [String](#string)! | |\n| **seller** | [String](#string)! | |\n| **options** | \\[[AssemblyOptionInput](#assemblyoptioninput)!\\] | |\n\n### Options\n\n| Field | Type | Description |\n| ----------------- | ------------------- | ------------------------------------------------------------------------------------------------ |\n| **allowRedirect** | [Boolean](#boolean) | If the search has a redirect enabled, this allows (true) or not (false) the redirect to be used. |\n\n### ProductUniqueIdentifier\n\n| Field | Type | Description |\n| --------- | -------------------------------------------------------------- | ----------- |\n| **field** | [ProductUniqueIdentifierField](#productuniqueidentifierfield)! | |\n| **value** | [ID](#id)! | |\n\n### SelectedFacetInput\n\n| Field | Type | Description |\n| --------- | ----------------- | ----------------------------- |\n| **key** | [String](#string) | A key for the selected facet. |\n| **value** | [String](#string) | Facet value. |\n\n#### General filters\n\nThe `key` parameter also allows the following general filters.\n\n| facetKey | Description |\n| ------------- | ------------------------------------------------------------------------------------------------------------------------------------- |\n| category-${n} | Filter the search by category, where n represents the category tree level (1 = department, 2 = category, 3 = subcategory, and so on). |\n| region-id | Filter the search by a region ID, for regionalization purposes. The value is the region ID. |\n\n## Enums\n\n### CategoryTreeBehavior\n\n| Value | Description |\n| ------- | -------------------------------------------------- |\n| default | Uses the default value set by the search provider. |\n| show | Shows the category tree when it is possible. |\n| hide | Hides the category tree in any situation. |\n\n### CrossSelingInputEnum\n\n| Value | Description |\n| ------------- | ----------- |\n| buy | |\n| similars | |\n| view | |\n| viewAndBought | |\n| accessories | |\n| suggestions | |\n\n### CrossSelingGroupByEnum\n\n| Value | Description |\n| ------- | ---------------------------------------------------------------------------------------------------- |\n| PRODUCT | Default behavior. Groups SKUs from the same product and bring only products. Limited to 12 products. |\n| NONE | Returns all SKUs registered in the Catalog for the recommendation. |\n\n### FilterType\n\n| Value | Description |\n| ------------ | ----------- |\n| TEXT | |\n| NUMBER | |\n| CATEGORYTREE | |\n| BRAND | |\n| PRICERANGE | |\n\n### InputValueType\n\n| Value | Description |\n| ------- | ----------- |\n| TEXT | |\n| BOOLEAN | |\n| OPTIONS | |\n\n### InstallmentsCriteria\n\n| Value | Description |\n| ---------------------- | ----------- |\n| MAX\\_WITHOUT\\_INTEREST | |\n| MAX\\_WITH\\_INTEREST | |\n| MAX | |\n| MIN | |\n| ALL | |\n\n### ItemsFilter\n\n| Value | Description |\n| ---------------- | ----------------------------------------------------------------------------- |\n| ALL | Returns all items, same as no filter. |\n| FIRST\\_AVAILABLE | Returns only the first available item. Returns first if no item is available. |\n| ALL\\_AVAILABLE | Returns all available items. Returns first if no item is available. |\n\n### Operator\n\n| Value | Description |\n| ----- | ----------- |\n| and | |\n| or | |\n\n### PageEntityIdentifier\n\n| Value | Description |\n| ----------- | ----------- |\n| brand | |\n| department | |\n| category | |\n| subcategory | |\n| search | |\n\n### ProductUniqueIdentifierField\n\n| Value | Description |\n| --------- | ----------- |\n| id | |\n| slug | |\n| ean | |\n| reference | |\n| sku | |\n\n### SORT\n\n| Value | Description |\n| ----- | ----------- |\n| ASC | |\n| DESC | |\n\n### SimulationBehavior\n\n| Value | Description |\n| ------------- | --------------------------------------------------------------------------------------------- |\n| default | Performs the simulation on the catalog as usual. |\n| only1P | Performs the simulation on catalog only for seller 1P. |\n| regionalize1p | Only first party sellers will include the regionId. |\n| skip | Calls catalog passing a parameter to not simulate each SKU and get its most up to date price. |\n| async | Performs the simulation on the client side. |\n\n## Scalars\n\n### Boolean\n\nThe `Boolean` scalar type represents `true` or `false`.\n\n### Float\n\nThe `Float` scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/IEEE%5Ffloating%5Fpoint).\n\n### ID\n\nThe `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `\"4\"`) or integer (such as `4`) input value will be accepted as an ID.\n\n### Int\n\nThe `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.\n\n### String\n\nThe `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.\n\n### StringOrBoolean\n\nRepresents a [String](#string) or a [Boolean](#boolean) value.\n\n[Responsive Values« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.responsive-values)[Session ClientNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.session-client)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23query)\n\n[Objects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23objects)\n\n[AssemblyOption](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23assemblyoption)[Attachment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23attachment)[Banners](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23banners)[Benefit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23benefit)[BenefitItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23benefititem)[Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23brand)[BrandFacet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23brandfacet)[CategoriesTreeFacet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23categoriestreefacet)[Category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23category)[ClusterHighlight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23clusterhighlight)[CompositionItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23compositionitem)[CompositionType](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23compositiontype)[Correction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23correction)[DeliverySlaPerTypes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23deliveryslapertypes)[DeliverySlaSamples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23deliveryslasamples)[DepartmentFacet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23departmentfacet)[Discount](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23discount)[DomainValues](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23domainvalues)[Facet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23facet)[FacetValue](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23facetvalue)[Facets](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23facets)[FilterFacet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23filterfacet)[FilterFacets](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23filterfacets)[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23gift)[GiftImage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23giftimage)[Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23image)[InputValue](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23inputvalue)[Installment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23installment)[ItemMetadata](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23itemmetadata)[ItemMetadataUnit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23itemmetadataunit)[ItemPriceTable](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23itempricetable)[Items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23items)[KitItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23kititem)[Offer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23offer)[OnlyProduct](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23onlyproduct)[PageType](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23pagetype)[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23pricerange)[PriceRangesFacet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23pricerangesfacet)[PriceTableItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23pricetableitem)[Product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23product)[ProductClusters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23productclusters)[ProductPriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23productpricerange)[ProductSearch](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23productsearch)[ProductSuggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23productsuggestions)[Property](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23property)[PropertyGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23propertygroup)[QueryArgs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23queryargs)[Range](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23range)[Recommendation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23recommendation)[Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23reference)[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23region)[SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23sku)[SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23sku)[SKUSpecificationField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23skuspecificationfield)[SKUSpecificationValue](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23skuspecificationvalue)[SearchBanner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23searchbanner)[SearchBreadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23searchbreadcrumb)[SearchCorrection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23searchcorrection)[SearchMetadata](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23searchmetadata)[SearchSuggestion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23searchsuggestion)[SearchSuggestionAttribute](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23searchsuggestionattribute)[SearchSuggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23searchsuggestions)[SearchURLStats](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23searchurlstats)[SelectedFacet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23selectedfacet)[SelectedProperty](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23selectedproperty)[Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23seller)[SkuSpecification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23skuspecification)[SpecificationGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23specificationgroup)[SpecificationGroupProperty](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23specificationgroupproperty)[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23suggestions)[Teaser](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23teaser)[TeaserCondition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23teasercondition)[TeaserEffects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23teasereffects)[TeaserValue](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23teaservalue)[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23video)[productSpecification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23productspecification)\n\n[Inputs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23inputs)\n\n[AssemblyOptionInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23assemblyoptioninput)[Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23options)[ProductUniqueIdentifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23productuniqueidentifier)[SelectedFacetInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23selectedfacetinput)\n\n[Enums](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23enums)\n\n[CategoryTreeBehavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23categorytreebehavior)[CrossSelingInputEnum](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23crossselinginputenum)[CrossSelingGroupByEnum](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23crossselinggroupbyenum)[FilterType](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23filtertype)[InputValueType](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23inputvaluetype)[InstallmentsCriteria](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23installmentscriteria)[ItemsFilter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23itemsfilter)[Operator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23operator)[PageEntityIdentifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23pageentityidentifier)[ProductUniqueIdentifierField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23productuniqueidentifierfield)[SORT](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23sort)[SimulationBehavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23simulationbehavior)\n\n[Scalars](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23scalars)\n\n[Boolean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23boolean)[Float](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23float)[ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23id)[Int](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23int)[String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23string)[StringOrBoolean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23stringorboolean)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_60dcbe26
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation building a horizontal product summary in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[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-building-a-horizontal-product-summary/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/api-reference)\n\n[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-building-a-horizontal-product-summary/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/storefront-development)\n\n[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-building-a-horizontal-product-summary/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/troubleshooting)\n\n[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-building-a-horizontal-product-summary/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/store-framework-using-components)\n\n[Building a horizontal Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary)\n\n[Building a Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/vtex-io-documentation-building-a-shelf)\n\n[Configuring custom images for the SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector)\n\n[Creating a native form for your store users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users)\n\n[Creating a product availability form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/vtex-io-documentation-creating-a-product-availability-form)\n\n[Overriding native app blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/vtex-io-documentation-overriding-native-app-blocks)\n\n[Using Sandbox blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/vtex-io-documentation-using-sandbox-blocks)\n\n[Using the Assets Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/vtex-io-documentation-using-the-assets-builder)\n\n[Setting up Delivery Promise components (Beta)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/setting-up-delivery-promise-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/store-framework-using-components)\n\n[Building a horizontal Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary)\n\n[Building a Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/vtex-io-documentation-building-a-shelf)\n\n[Configuring custom images for the SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector)\n\n[Creating a native form for your store users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users)\n\n[Creating a product availability form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/vtex-io-documentation-creating-a-product-availability-form)\n\n[Overriding native app blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/vtex-io-documentation-overriding-native-app-blocks)\n\n[Using Sandbox blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/vtex-io-documentation-using-sandbox-blocks)\n\n[Using the Assets Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/vtex-io-documentation-using-the-assets-builder)\n\n[Setting up Delivery Promise components (Beta)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/setting-up-delivery-promise-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/store-framework)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/store-framework-using-components)\n\n[Building a horizontal Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary)\n\nBuilding a horizontal Product Summary\n\nThe [Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary) is a VTEX native app responsible for displaying important product data in your store's components, such as the Shelf and the Minicart.\n\n\n\nThanks to the [Flex Layout app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-flex-layout), it is possible to customize the default presentation showed above and thereby display the Product Summary blocks in a **horizontal alignment** to your users:\n\n\n\nLearn in the instructions below how to use the powerful combination between the Flex Layout and the Product Summary apps in order to display your product data horizontally.\n\n## Instructions\n\n> This recipe requires previous understanding of the [Flex Layout app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-flex-layout). It is strongly advised that you read the app documentation before performing the steps below!\n\n1. Make sure the Flex Layout app has been declared as a theme's dependency in the `manifest.json` file:\n\n`1\n\n\"dependencies\": { \n\n2\n\n \"vtex.flex-layout\": \"0.x\" \n\n3\n\n} \n\n`\n\n1. Add the `flex-layout.row` block as a child of the `product-summary.shelf` and/or the `product-summary` blocks, according to the desired scenario:\n\n`1\n\n\"product-summary.shelf\": { \n\n2\n\n \"children\": [\"flex-layout.row#product-summary-mobile\"] \n\n3\n\n}, \n\n`\n\n> The `flex-layout.row` block allows its children to be displayed side by side on the UI.\n\n> Notice that the block naming always depends on your store scenario. In the example above, `#product-summary-mobile` is only being used for identification purposes.\n\n1. Add the `flex-layout.col` blocks as children of the `flex-layout.row` block to define the desired disposition of elements on the screen - the first `flex-layout.col`'s children will be displayed on the left side of the horizontal Product Summary, whereas the second will be on the right side:\n\n`1\n\n\"flex-layout.row#product-summary-mobile\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"flex-layout.col#product-image\", \n\n4\n\n \"flex-layout.col#product-summary-details\" \n\n5\n\n ], \n\n6\n\n}, \n\n`\n\n1. Add the [product-summary-image block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryimage) to the `flex-layout.col#product-image`'s children list and then declare it as desired:\n\n`1\n\n\"flex-layout.col#product-image\": { \n\n2\n\n \"children\": [\"product-summary-image#shelf\"] \n\n3\n\n}, \n\n4\n\n\"product-summary-image#shelf\": { \n\n5\n\n \"props\": { \n\n6\n\n \"showBadge\": false, \n\n7\n\n \"aspectRatio\": \"1:1\", \n\n8\n\n \"maxHeight\": 300 \n\n9\n\n } \n\n10\n\n}, \n\n`\n\n1. Add the desired blocks responsible for displaying product data to the `flex-layout.col#product-summary-details`'s children list and then declare them as desired. For example:\n\n`1\n\n\"flex-layout.col#product-summary-details\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"product-summary-name\", \n\n4\n\n \"product-summary-space\", \n\n5\n\n \"product-list-price\", \n\n6\n\n \"flex-layout.row#selling-price-savings\", \n\n7\n\n \"product-installments\", \n\n8\n\n \"product-summary-sku-selector#buy-together\" \n\n9\n\n ], \n\n10\n\n \"props\": { \n\n11\n\n \"marginLeft\": 4 \n\n12\n\n }, \n\n13\n\n}, \n\n14\n\n\"flex-layout.row#selling-price-savings\": { \n\n15\n\n \"children\": [ \n\n16\n\n \"product-selling-price\", \n\n17\n\n \"product-price-savings#summary\" \n\n18\n\n ], \n\n19\n\n \"props\": { \n\n20\n\n \"colGap\": 2, \n\n21\n\n \"preserveLayoutOnMobile\": true, \n\n22\n\n \"preventHorizontalStretch\": true, \n\n23\n\n \"marginBottom\": 4 \n\n24\n\n }, \n\n25\n\n}, \n\n26\n\n\"product-price-savings#summary\": { \n\n27\n\n \"props\": { \n\n28\n\n \"markers\": [\"discount\"] \n\n29\n\n } \n\n30\n\n}, \n\n31\n\n\"product-summary-sku-selector#buy-together\": { \n\n32\n\n \"props\": { \n\n33\n\n \"thumbnailImage\": \"skuvariation\", \n\n34\n\n \"imageHeight\": 28, \n\n35\n\n \"blockClass\": \"buyTogether\", \n\n36\n\n \"visibility\": \"more-than-one\" \n\n37\n\n } \n\n38\n\n} \n\n`\n\n1. [Deploy your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-theme-content-public/).\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/concepts-1/vtex-io-documentation-building-a-horizontal-product-summary.md)\n\n[Using components« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary//docs/guides/store-framework-using-components)[Building a ShelfNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary//docs/guides/vtex-io-documentation-building-a-shelf)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary%23instructions)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/concepts-1/vtex-io-documentation-building-a-horizontal-product-summary.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary%23instructions)\n\nOn this page\n\n[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=)"
}
] |
doc_fa1929d2
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore organisms region modal in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-overview)\n\n[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-banner-text)\n\n[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-cart-sidebar)\n\n[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-empty-state)\n\n[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-filter-slider)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-filter)\n\n[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-hero)\n\n[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-image-gallery)\n\n[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-navbar-slider)\n\n[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-navbar)\n\n[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-newsletter)\n\n[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-out-of-stock)\n\n[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-payment-methods)\n\n[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-price-range)\n\n[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-product-grid)\n\n[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-product-shelf)\n\n[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-region-modal)\n\n[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-search-input)\n\n[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-shipping-simulation)\n\n[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-slide-over)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-overview)\n\n[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-banner-text)\n\n[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-cart-sidebar)\n\n[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-empty-state)\n\n[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-filter-slider)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-filter)\n\n[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-hero)\n\n[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-image-gallery)\n\n[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-navbar-slider)\n\n[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-navbar)\n\n[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-newsletter)\n\n[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-out-of-stock)\n\n[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-payment-methods)\n\n[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-price-range)\n\n[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-product-grid)\n\n[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-product-shelf)\n\n[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-region-modal)\n\n[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-search-input)\n\n[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-shipping-simulation)\n\n[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-slide-over)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/components-index)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-overview)\n\nRegionModal\n\nThis component is a modal with some region configurations.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/organisms/RegionModal)\n\nThe `RegionModal` is part of the [Regionalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization) feature and provides a modal interface for selecting and configuring region-specific options. It extends the functionality of the [Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-modal) component, making it adaptable for region-related settings within your FastStore application.\n\nExample\n\nCode\n\nOpen Region Modal\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { RegionModal } from \"@faststore/ui\"; \n\n`\n\n### Import styles\n\nTo apply styles, include the following in your stylesheet:\n\n`1\n\n@import \"@faststore/ui/src/components/organisms/RegionModal/styles.scss\"; \n\n`\n\nFor details, see [Importing FastStore UI component styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles).\n\n---\n\n## Design tokens\n\n| Local token | Default value/Global token linked |\n| ---------------------------------- | --------------------------------- |\n| \\--fs-region-modal-margin-bottom | var(--fs-spacing-6) |\n| \\--fs-region-modal-link-padding | 0 |\n| \\--fs-region-modal-link-column-gap | var(--fs-spacing-0) |\n| \\--fs-region-modal-link-color | var(--fs-color-link) |\n\n---\n\n## Data attributes\n\nYou can target and override `RegionModal` styles using the following data attributes:\n\n`data-fs-region-modal`\n\n`data-fs-region-modal-input`\n\n`data-fs-region-modal-link`\n\n---\n\n## Props\n\n| Name | Type | Description | Default |\n| -------------------------- | -------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |\n| **testId** | string | ID to find this component in testing tools (e.g.: cypress, testing-library, and jest). | fs-region-modal |\n| **title** | string | The region modal's title. | Set your location |\n| **description** | string | Description for region modal. | Offers and availability vary by location. |\n| **closeButtonAriaLabel** | string | Close button aria-label. | Close Region Modal |\n| **idkPostalCodeLinkProps** | Partial<LinkProps<LinkElementType>> | Props for the link \\`I don't know my Postal Code\\`. | |\n| **linkText** | Partial<LinkProps<LinkElementType>> | Props for the \\`I don't know my Postal Code\\` link on modal body content. | |\n| **errorMessage** | string | Message of error for input. | |\n| **inputRef** | MutableRefObject<HTMLInputElement> | Postal code input's ref. | |\n| **inputValue** | string | Postal code input's value. | |\n| **inputLabel** | string | Postal code input's label. | Postal Code |\n| **inputButtonActionText** | string | The text displayed on the InputField Button. Suggestion: maximum 9 characters. | Apply |\n| **fadeOutOnSubmit** | false \\| true | Enables fadeOut effect on modal after onSubmit function | |\n| **overlayProps** | Props | Props forwarded to the \\`Overlay\\` component. | |\n| **onClose** | () => void | Function called when Close button is clicked. | |\n| **onInput** | (event: React.FormEvent<HTMLInputElement>) => void | Callback function when input is typed. | |\n| **onSubmit** | () => void | Callback function when form is submitted. | |\n| **onClear** | () => void | Callback function when the input clear button is clicked. | |\n| **dismissible** | false \\| true | Determines if the modal can be dismissed using the close button or the Escape key. | true |\n| **aria-labelledby** | string | Identifies the element (or elements) that labels the current element. @see aria-labelledby https://www.w3.org/TR/wai-aria-1.1/#aria-labelledby | |\n| **onEntered** | () => void | Callback function when the modal is opened. | |\n| **isOpen** | false \\| true | A boolean value that represents the state of the Modal. | |\n| **onDismiss** | () => void | Event emitted when the modal is closed. | |\n| **disableEscapeKeyDown** | false \\| true | Disable being closed using the Escape key. | |\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/aliceoq)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/organisms/region-modal.mdx)\n\n[ProductShelf« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-product-shelf)[SearchInputNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-search-input)\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/aliceoq)\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-region-modal%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-region-modal%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-region-modal%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-region-modal%23design-tokens)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-region-modal%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-region-modal%23props)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/organisms/region-modal.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-region-modal%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-region-modal%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-region-modal%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-region-modal%23design-tokens)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-region-modal%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-region-modal/docs/guides/faststore/organisms-region-modal%23props)\n\nOn this page\n\n[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=)"
}
] |
doc_45677354
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides graphql ide in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/graphql-in-vtex-io)\n\n[List of GraphQL APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/vtex-io-graphql-api-list)\n\n[Developing a GraphQL API in service apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/developing-a-graphql-api-in-service-apps)\n\n[GraphQL authorization in IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/graphql-authorization-in-io-apps)\n\n[Integrating an app with a GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/integrating-an-app-with-a-graphql-api)\n\n[Implementing cache in GraphQL APIs for IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/implementing-cache-in-graphql-apis-for-io-apps)\n\n[Admin GraphQL IDE](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/graphql-ide)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/graphql-in-vtex-io)\n\n[List of GraphQL APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/vtex-io-graphql-api-list)\n\n[Developing a GraphQL API in service apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/developing-a-graphql-api-in-service-apps)\n\n[GraphQL authorization in IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/graphql-authorization-in-io-apps)\n\n[Integrating an app with a GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/integrating-an-app-with-a-graphql-api)\n\n[Implementing cache in GraphQL APIs for IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/implementing-cache-in-graphql-apis-for-io-apps)\n\n[Admin GraphQL IDE](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/graphql-ide)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/app-development)\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/graphql-in-vtex-io)\n\n[Admin GraphQL IDE](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/graphql-ide)\n\nAdmin GraphQL IDE\n\nLearn how to make GraphQL queries in the Admin and use the IDE features.\n\nAdmin GraphQL IDE is an [Admin app](https://read.calvincode.net/reader?url=https://learn.vtex.com/docs/course-admin-lang-en) that allows users to make GraphQL queries. It includes [Graph_i_QL](https://read.calvincode.net/reader?url=https://github.com/graphql/graphiql), an open-source interface for writing, validating, and testing queries.\n\nAdmin GraphQL IDE allows developers to test and validate GraphQL APIs by providing features, such as:\n\n* Autocomplete.\n* Syntax highlighting.\n* Real-time error reporting.\n* Documentation explorer.\n\n## Before you begin\n\nMake sure you have the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference) installed. If not, follow the instructions in [Installing VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install).\n\n## Installing Admin GraphQL IDE\n\nFollow these steps to install and open Admin GraphQL IDE:\n\n1. In a terminal, use the VTEX IO CLI to [log in to your VTEX account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-usage%23logging-in-to-your-vtex-account).\n2. Run `vtex use {workspaceName} --production` to use a production workspace or [create a production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace) from scratch. \n> Remember to replace the values between curly brackets according to your scenario. To run tests, consider using a [development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace).\n3. Install the GraphQL IDE app by running `vtex install vtex.admin-graphql-ide@3.x` in your terminal.\n4. In your browser, go to `https://{workspace}--{account}.myvtex.com/admin`.\n5. Under **Store Settings** \\> **Storefront**, click **GraphQL IDE**. \n \nOn the right side of your screen, you will now see a dropdown menu with the list of GraphQL APIs installed in the logged VTEX account.\n\n## Using Admin GraphQL IDE\n\nThe Admin GraphQL IDE interface is divided into three main sections:\n\n* One on the top left for writing queries.\n* Another is on the right to check the results.\n* A third one is on the bottom left, named **Query Variables**, which is optional and hidden at the bottom of the screen.\n\n\n\nThe **Query Variables** section is recommended when the same query will be reused many times with different arguments. To use dynamic values, you must place a dollar sign (`$`) before the variable name and then define the values for each field as JSON in the **Query Variables** section.\n\nFollow these steps to make a GraphQL query:\n\n1. In the **Choose an app** dropdown menu, select the app you want to query.\n2. In the top-left box, write your query.\n3. If you need to use variables, click **Query Variables** in the bottom-left corner and insert your variables in the box using JSON format.\n4. Click **Execute Query** ▶️ to send your query. The result will appear on the panel to the right.\n\n\n\n### Documentation Explorer\n\nAnother section of Admin GraphQL IDE is the **Documentation Explorer**, which can be found in the upper right-hand corner of the IDE. The **Documentation Explorer** allows developers to better understand a particular query, mutation, or type structure by providing a description and information about its schema.\n\n\n\n### History\n\nAnother feature of Admin GraphQL IDE is keeping a log of all the queries and mutations that are run, which can be viewed through the History dashboard. If you click one of the queries from the History list, the query code will appear in the top-left box.\n\n\n\n### Shortcuts\n\nWhen writing a query in Admin GraphQL IDE, some useful shortcuts are:\n\n* `Ctrl + Space` (or `Shift + Space`) to display the autocomplete popup.\n* `Ctrl + Enter` to run the GraphQL query.\n* `Ctrl + Shift + P` to fix the indentation.\n\nContributors\n\n1\n\n[](https://github.com/henriquessb)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/GraphQL/graphql-ide.md)\n\n[Implementing cache in GraphQL APIs for IO apps« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide//docs/guides/implementing-cache-in-graphql-apis-for-io-apps)[Policies and permissionsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide//docs/guides/vtex-io-documentation-policies)\n\nContributors\n\n1\n\n[](https://github.com/henriquessb)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/graphql-ide%23before-you-begin)\n\n[Installing Admin GraphQL IDE](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/graphql-ide%23installing-admin-graphql-ide)\n\n[Using Admin GraphQL IDE](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/graphql-ide%23using-admin-graphql-ide)\n\n[Documentation Explorer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/graphql-ide%23documentation-explorer)[History](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/graphql-ide%23history)[Shortcuts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/graphql-ide%23shortcuts)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/GraphQL/graphql-ide.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/graphql-ide%23before-you-begin)\n\n[Installing Admin GraphQL IDE](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/graphql-ide%23installing-admin-graphql-ide)\n\n[Using Admin GraphQL IDE](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/graphql-ide%23using-admin-graphql-ide)\n\n[Documentation Explorer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/graphql-ide%23documentation-explorer)[History](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/graphql-ide%23history)[Shortcuts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide/docs/guides/graphql-ide%23shortcuts)\n\nOn this page\n\n[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=)"
}
] |
doc_cc8e49a8
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore headless cms 1 configuring the vtex account in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-overview)\n\n[1\\. Setting up your environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-1-setting-up-your-environment)\n\n[2\\. Starting a new FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-2-starting-the-project)\n\n[3\\. Running the project locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-3-running-the-project-locally)\n\n[4\\. Understanding the project structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-4-understanding-the-project-structure)\n\n[5\\. Integrating your project with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)\n\n[Setting up the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-setting-up-the-headless-cms)\n\n[Structuring Content Types and Sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-structuring-content-types-and-sections)\n\n[Promoting your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes)\n\n[6\\. Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-6-next-steps)\n\n[Glossary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-glossary)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-overview)\n\n[1\\. Setting up your environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-1-setting-up-your-environment)\n\n[2\\. Starting a new FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-2-starting-the-project)\n\n[3\\. Running the project locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-3-running-the-project-locally)\n\n[4\\. Understanding the project structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-4-understanding-the-project-structure)\n\n[5\\. Integrating your project with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)\n\n[Setting up the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-setting-up-the-headless-cms)\n\n[Structuring Content Types and Sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-structuring-content-types-and-sections)\n\n[Promoting your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes)\n\n[6\\. Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-6-next-steps)\n\n[Glossary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-glossary)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-overview)\n\n5\\. Integrating your project with the Headless CMS\n\nConnect your FastStore project with the Headless CMS to manage and publish your store’s content efficiently.\n\nIn this step, you'll connect your FastStore project to [Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview) so editors can create, preview, and publish content. You'll also configure the webhooks that keep builds and previews in sync—without this integration, CMS changes won't reach your storefront.\n\n## What you'll accomplish\n\nBy the end of this step, you will have:\n\n* Configured Headless CMS webhooks to trigger builds when content is published\n* Set up preview URLs for content editors to see changes before going live\n* Configured WebOps to communicate CMS updates back to your Git repository\n* Established a complete content workflow where CMS changes automatically sync with your codebase\n\nThis integration enables your content team to manage store content independently while keeping everything in sync with your development workflow.\n\n## Step 1: Configuring the Headless CMS\n\nConfigure the URLs of the webhooks used by the Headless CMS app.\n\n1. In the VTEX Admin, access **Storefront > Headless CMS**.\n2. In the FastStore project interface, click on `Settings` (⚙️).\n3. In **Settings**, click the `Build` tab.\n4. In **Build Webhook URL**, click `Add`.\n5. Enter the following value. _Replace the values between curly brackets according to your scenario._ \n`1 \nhttps://app.io.vtex.com/vtex.cms-builder-sf-jamstack/v1/{account}/master/build-releases \n`\n6. Click **SAVE**.\n\n> When an editor clicks to publish a page using the Headless CMS interface, the CMS calls the **Build Webhook URL**, which changes the page's status to `published`. The CMS then waits for the content to be built in the background.\n\n1. Fill in the **Preview URL** field with your production URL. This URL activates the button on the Headless CMS, allowing you to preview the changes made to a page. _Replace the values between curly brackets according to your scenario._\n\n## Step 2: Communicating WebOps updates to the Headless CMS\n\nIf you are developing your FastStore project with CI/CD and Headless CMS, you must ensure that CI/CD is aware of every CMS update performed via the VTEX Admin. To do so, you must configure the WebOps webhooks responsible for communicating with the Headless CMS as follows.\n\n1. Open your FastStore project in any code editor of your preference.\n2. Edit the `discovery.config.js` file in the root directory of your project.\n3. In the Headless CMS configuration, add the `webhookUrls` property corresponding to your store website as follows: \ndiscovery.config.js \n`1 \n\"vtexHeadlessCms\": { \n2 \n webhookUrls: [ \n3 \n \"https://{account}.myvtex.com/cms-releases/webhook-releases\" \n4 \n ] \n5 \n} \n`\n4. Open a Pull Request in your project, including the previous changes.\n5. Merge the Pull Request.\n\nNow you can make changes to the Headless CMS and check if commits are being created in the project. In the following example, the `Hero` title was modified to `10% off on first purchase`, and we can see that it generated a commit in the repository.\n\n\n\n## Next step\n\nNow that Headless CMS is integrated, set up content types and sections for your editors: [Setting up the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-2-setting-up-the-headless-cms)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/getting-started/5-integrating-your-project-with-the-headless-cms.mdx)\n\n[4\\. Understanding the project structure« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-4-understanding-the-project-structure)[Setting up the Headless CMSNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-setting-up-the-headless-cms)\n\nSee also\n\n[VTEX IO CLIGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[What you'll accomplish](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms%23what-youll-accomplish)\n\n[Step 1: Configuring the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms%23step-1-configuring-the-headless-cms)\n\n[Step 2: Communicating WebOps updates to the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms%23step-2-communicating-webops-updates-to-the-headless-cms)\n\n[Next step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms%23next-step)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/getting-started/5-integrating-your-project-with-the-headless-cms.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[What you'll accomplish](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms%23what-youll-accomplish)\n\n[Step 1: Configuring the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms%23step-1-configuring-the-headless-cms)\n\n[Step 2: Communicating WebOps updates to the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms%23step-2-communicating-webops-updates-to-the-headless-cms)\n\n[Next step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms%23next-step)\n\nOn this page\n\n[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=)"
}
] |
doc_de6d6c72
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides segmenting campaigns in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/vtex-ads)\n\n[Getting started with VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/getting-started-with-vtex-ads-api)\n\n[Synchronizing the catalog with VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/synchronizing-the-catalog-with-vtex-ads)\n\n[Retrieving ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/retrieving-ads)\n\n[Segmenting campaigns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/segmenting-campaigns)\n\n[Digital Signage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/digital-signage)\n\n[Ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/ads-events)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/vtex-ads)\n\n[Getting started with VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/getting-started-with-vtex-ads-api)\n\n[Synchronizing the catalog with VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/synchronizing-the-catalog-with-vtex-ads)\n\n[Retrieving ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/retrieving-ads)\n\n[Segmenting campaigns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/segmenting-campaigns)\n\n[Digital Signage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/digital-signage)\n\n[Ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/ads-events)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides)\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/vtex-ads)\n\n[Getting started with VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/getting-started-with-vtex-ads-api)\n\n[Retrieving ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/retrieving-ads)\n\n[Segmenting campaigns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/segmenting-campaigns)\n\nSegmenting campaigns\n\nUse customer data and contexts to serve personalized campaigns through VTEX Ads API.\n\nCampaign targeting allows meta-information to be provided during an ad query, which can be used in real time to prioritize campaigns aimed at that specific audience.\n\n> 🚧 Campaigns with targeting will have higher priority during the query process, meaning they are considered more relevant to the audience they were directed to. However, the presence of targeting does not prevent non-targeted campaigns from also being displayed.\n\n## Targeting attributes\n\nAttributes are the types of information that the audience can have and consequently that a campaign can have during its creation.\n\nLearn more about targeting attributes on `POST` [Get ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-ads-api%23post-/v1/rma/-publisher%5Fid-).\n\n## Ad search with targeting\n\nDuring the ad request, targeting information can be sent in two ways: directly in the request body or based on the audiences associated with a `user_id`.\n\n### Sending targeting in the request body (segmentation)\n\nIn this approach, targeting information is sent directly in the request body, in the \"segmentation\" field. This data is prioritized over information that could be obtained based on the user\\_id, allowing for more detailed and temporary personalization according to the conditions of the ad query.\n\nRequest example:\n\n`1\n\nPOST https://api-retail-media.newtail.com.br/v1/rma/:publisher_id HTTP/1.1 \n\n2\n\nContent-Type: application/json \n\n3\n\n \n4\n\n{ \n\n5\n\n \"context\": \"search\", \n\n6\n\n \"term\": \"desodorante\", \n\n7\n\n \"session_id\": \"f361661f-5986-4779-9009-a34562f18347\", \n\n8\n\n \"tags\": [\"Mega Maio\"], \n\n9\n\n \"placements\": { \n\n10\n\n \"nomePlacement1\": { \"quantity\": 3, \"size\": \"desktop\", \"types\": [\"banner\"] } \n\n11\n\n }, \n\n12\n\n \"segmentation\": [ \n\n13\n\n { \n\n14\n\n \"key\": \"AGE\", \n\n15\n\n \"values\": [\"22\"] \n\n16\n\n }, \n\n17\n\n { \n\n18\n\n \"key\": \"STATE\", \n\n19\n\n \"values\": [\"SP\"] \n\n20\n\n } \n\n21\n\n ] \n\n22\n\n} \n\n`\n\n### Targeting based on `user_id`\n\nIn this approach, targeting information is obtained based on the audiences associated with the `user_id`. These audiences must have been previously imported into the system.\n\n> 🚧 When using this approach, don't send data in the `segmentation` field, since this field would take priority over `user_id`. The system will automatically fetch the audiences associated with the `user_id`.\n\nRequest example:\n\n`1\n\nPOST https://api-retail-media.newtail.com.br/v1/rma/:publisher_id HTTP/1.1 \n\n2\n\nContent-Type: application/json \n\n3\n\n \n4\n\n{ \n\n5\n\n \"context\": \"search\", \n\n6\n\n \"term\": \"desodorante\", \n\n7\n\n \"user_id\": \"6a746448-cf59-42bc-aa3d-a426844ad115\", \n\n8\n\n \"session_id\": \"f361661f-5986-4779-9009-a34562f18347\", \n\n9\n\n \"tags\": [\"Mega Maio\"], \n\n10\n\n \"placements\": { \n\n11\n\n \"nomePlacement1\": { \"quantity\": 3, \"size\": \"desktop\", \"types\": [\"banner\"] } \n\n12\n\n } \n\n13\n\n} \n\n`\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX Ads/getting-started-with-vtex-ads-api/retrieving-ads/segmenting-campaigns.md)\n\n[Retrieving ads« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns//docs/guides/retrieving-ads)[Digital SignageNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns//docs/guides/digital-signage)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Targeting attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/segmenting-campaigns%23targeting-attributes)\n\n[Ad search with targeting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/segmenting-campaigns%23ad-search-with-targeting)\n\n[Sending targeting in the request body (segmentation)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/segmenting-campaigns%23sending-targeting-in-the-request-body-segmentation)[Targeting based on user\\_id](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/segmenting-campaigns%23targeting-based-on-userid)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX Ads/getting-started-with-vtex-ads-api/retrieving-ads/segmenting-campaigns.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Targeting attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/segmenting-campaigns%23targeting-attributes)\n\n[Ad search with targeting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/segmenting-campaigns%23ad-search-with-targeting)\n\n[Sending targeting in the request body (segmentation)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/segmenting-campaigns%23sending-targeting-in-the-request-body-segmentation)[Targeting based on user\\_id](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/segmenting-campaigns/docs/guides/segmenting-campaigns%23targeting-based-on-userid)\n\nOn this page\n\n[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=)"
}
] |
doc_82db6510
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Explain the VTEX api reference pick and pack order changes api API and how to use it."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/pick-and-pack-order-changes-api/)\n\nOrder changes\n\nBIN locations\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/pick-and-pack-order-changes-api/)\n\nOrder changes\n\nBIN locations\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[PoCreate on hold service« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/pick-and-pack-protocol-api%23post-/on-hold/-carrierId-/-serviceId-)[PuUpdate order deadlineNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api/docs/api-reference/pick-and-pack-order-changes-api%23put-/orders/-orderId-/deadline)\n\n[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=)"
}
] |
doc_fabd0a18
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore storefront features building navigation menus in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/storefront-features-overview)\n\n[Adding third-party scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/storefront-features-handling-third-party-scripts)\n\n[Building navigation menus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/storefront-features-building-navigation-menus)\n\n[Displaying content for authenticated users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users)\n\n[Implementing regionalization features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/storefront-features-implementing-regionalization-features)\n\n[Implementing search features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/storefront-features-implementing-search-features)\n\n[Managing product images in specific contexts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/storefront-features-managing-product-images-in-specific-contexts)\n\n[Implementing Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/delivery-promise-implementation)\n\n[Implementing Live Shopping for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/storefront-features-overview)\n\n[Adding third-party scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/storefront-features-handling-third-party-scripts)\n\n[Building navigation menus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/storefront-features-building-navigation-menus)\n\n[Displaying content for authenticated users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users)\n\n[Implementing regionalization features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/storefront-features-implementing-regionalization-features)\n\n[Implementing search features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/storefront-features-implementing-search-features)\n\n[Managing product images in specific contexts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/storefront-features-managing-product-images-in-specific-contexts)\n\n[Implementing Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/delivery-promise-implementation)\n\n[Implementing Live Shopping for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/storefront-features-overview)\n\nBuilding navigation menus\n\nThis feature enables customers to navigate among the store pages.\n\n## Overview\n\nThis feature aims to group the main store's page header components. These components perform specific functions such as navigation among the store pages, navigation to the login flow and others.\n\n---\n\n## Usage\n\nWe recommend the usage of the components together, keeping the `Navbar` as the wrapper of the others.\n\nThere is an available example of the usage of all the related components in our starter store [here](https://read.calvincode.net/reader?url=https://starter.vtex.app/).\n\n---\n\n## Components\n\n* Storefront \n[Login](#) \nSet location \n * [Office](#) \n * [Home Appliances](#) \n * [Computer and Software](#) \n * [Technology](#) \nNavbar \nRepresents the page header and groups features like Search and Regionalization. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/organisms-navbar)\n* Open Menu \nNavbarSlider \nAs part of the Navbar, this component it its mobile version used to list the navigation links. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/organisms-navbar-slider)\n* Set location \n * [Office](#) \n * [Home Appliances](#) \n * [Computer and Software](#) \n * [Technology](#) \nNavbarLinks \nDisplays a set of navigation links. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/molecules-navbar-links)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/storefront-features/building-navigation-menus.mdx)\n\n[Adding third-party scripts« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/storefront-features-handling-third-party-scripts)[Displaying content for authenticated usersNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/storefront-features-building-navigation-menus%23overview)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/storefront-features-building-navigation-menus%23usage)\n\n[Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/storefront-features-building-navigation-menus%23components)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/storefront-features/building-navigation-menus.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/storefront-features-building-navigation-menus%23overview)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/storefront-features-building-navigation-menus%23usage)\n\n[Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-building-navigation-menus/docs/guides/faststore/storefront-features-building-navigation-menus%23components)\n\nOn this page\n\n[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=)"
}
] |
doc_ccc4e8b2
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX telemarketing app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/troubleshooting)\n\n[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.telemarketing/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.checkout-ui-custom)\n\n[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.messages)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/guides/affiliates-program-app)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.checkout-ui-custom)\n\n[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.messages)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/guides/affiliates-program-app)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/vtex-io-apps)\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/guides/functional-apps)\n\nVTEX Telemarketing\n\nOfficial extension\n\nVersion: 2.12.1\n\nLatest version: 2.12.1\n\n## Description\n\nThe VTEX Telemarketing app is a store component that enables a call center operator impersonate a costumer in the store, and this app is used by store theme.\n\n:loudspeaker: **Disclaimer:** Don't fork this project, use, contribute, or open issue with your feature request.\n\n## Release schedule\n\n| Release | Status | Initial Release | Maintenance LTS Start | End-of-life | Store Compatibility |\n| ------- | ------------------- | --------------- | --------------------- | ----------- | ------------------- |\n| \\[2.x\\] | **Current Release** | 2018-11-08 | 2.x | | |\n| \\[1.x\\] | **Maintenance LTS** | 2018-08-15 | 2018-11-08 | March 2019 | 1.x |\n\nSee our [LTS policy](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/awesome-io%23lts-policy) for more information.\n\n## Table of Contents\n\n* [Usage](#usage) \n * [Blocks API](#blocks-api) \n * [Configuration](#configuration) \n * [Styles API](#styles-api) \n * [CSS namespaces](#css-namespaces)\n* [Troubleshooting](#troubleshooting)\n* [Contributing](#contributing)\n* [Tests](#tests)\n\n## Usage\n\nThis app uses our store builder with the blocks architecture. To know more about the Store Builder [click here](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/understanding-storebuilder-and-stylesbuilder%23structuring-and-configuring-our-store-with-object-object).\n\nWe add the telemarketing as a block in our [Store Header](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-header/blob/master/store/interfaces.json).\n\nTo configure or customize this app, you need to import it in your dependencies in `manifest.json`.\n\n`1\n\n dependencies: { \n\n2\n\n \"vtex.telemarketing\": \"2.x\" \n\n3\n\n } \n\n`\n\nThen, add `telemarketing` block into your app theme as we do in our [Store theme app](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-theme/blob/master/store/blocks.json).\n\n:loudspeaker: **Disclaimer:** This component will only be displayed for the users that have the role of `2 - Televendas (Call center operator)` in their access profile.\n\nTo give an user the permission of call center operator you need to follow these steps on VTEX admin management page:\n\n* Access the page: Account Management -> Access Profiles -> Click in New Profile -> Select `2 - Televendas (Call center operator)`\n* Add the email of the users that are responsable for impersonating customers(call center operators).\n\n### Blocks API\n\nWhen implementing this app as a block, various inner blocks may be available. The following interface lists the available blocks within telemarketing and describes if they are required or optional.\n\n`1\n\n{ \n\n2\n\n \"telemarketing\": { \n\n3\n\n \"component\": \"index\" \n\n4\n\n } \n\n5\n\n} \n\n`\n\nAs you can see, this app has no required or optional block.\n\n#### Configuration\n\nThis app has no configuration yet.\n\n### Styles API\n\nThis app provides some CSS classes as an API for style customization.\n\nTo use this CSS API, you must add the `styles` builder and create an app styling CSS file.\n\n1. Add the `styles` builder to your `manifest.json`:\n\n`1\n\n \"builders\": { \n\n2\n\n \"styles\": \"1.x\" \n\n3\n\n } \n\n`\n\n1. Create a file called `vtex.telemarketing.css` inside the `styles/css` folder. Add your custom styles:\n\n`1\n\n.container { \n\n2\n\n margin-top: 10px; \n\n3\n\n} \n\n`\n\n#### Customization\n\n| CSS Handles |\n| ----------------------- |\n| container |\n| popoverArrowUp |\n| popoverBox |\n| popoverContentContainer |\n| popoverContainer |\n| login |\n| loginForm |\n| loginFormMessage |\n| emailInput |\n| clientName |\n| clientNameBar |\n| logout |\n| logoutForm |\n| popoverHeaderIcon |\n| popoverHeaderEmail |\n| loginButton |\n| loginAsText |\n| popoverHeader |\n| loginFormContainer |\n| logoutInfoContainer |\n| emailContainer |\n| emailField |\n| emailValue |\n| documentContainer |\n| documentField |\n| documentValue |\n| phoneContainer |\n| phoneField |\n| phoneValue |\n| logoutButtonsContainer |\n| wrapper |\n| telemarketingBar |\n| attendantContainer |\n| attendantEmail |\n\nIn order to apply CSS customizations in this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization)\n\n## Troubleshooting\n\nYou can check if others are passing through similar issues [here](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/telemarketing/issues). Also feel free to [open issues](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/telemarketing/issues/new) or contribute with pull requests.\n\n## Contributing\n\nCheck it out [how to contribute](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/awesome-io%23contributing) with this project.\n\n## Tests\n\nTo execute our tests go to `react/` folder and run `yarn test`\n\n### Travis CI\n\n[](https://travis-ci.org/vtex-apps/telemarketing) [](https://coveralls.io/github/vtex-apps/telemarketing?branch=master)\n\n[Store Sitemap« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.store-sitemap)[Assembly OptionsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/guides/assembly-options-app)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.telemarketing%23description)\n\n[Release schedule](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.telemarketing%23release-schedule)\n\n[Table of Contents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.telemarketing%23table-of-contents)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.telemarketing%23usage)\n\n[Blocks API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.telemarketing%23blocks-api)[Styles API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.telemarketing%23styles-api)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.telemarketing%23troubleshooting)\n\n[Contributing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.telemarketing%23contributing)\n\n[Tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.telemarketing%23tests)\n\n[Travis CI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.telemarketing/docs/apps/vtex.telemarketing%23travis-ci)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_2d2e7365
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX seller selector app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/troubleshooting)\n\n[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.seller-selector/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtexventures.livestreaming)\n\n[PayPal Checkout with Smart Payment Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.product-gifts)\n\n[Product Highlight by VTEX Segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtexarg.product-highlight-by-vtex-segment)\n\n[Product Specification Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.reviews-and-ratings)\n\n[Querying personal MasterData Information with SafeData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.shipping-option-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtexventures.livestreaming)\n\n[PayPal Checkout with Smart Payment Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.product-gifts)\n\n[Product Highlight by VTEX Segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtexarg.product-highlight-by-vtex-segment)\n\n[Product Specification Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.reviews-and-ratings)\n\n[Querying personal MasterData Information with SafeData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.shipping-option-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/vtex-io-apps)\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/guides/advanced-components)\n\nSeller Selector\n\nOfficial extension\n\nVersion: 0.6.0\n\nLatest version: 0.6.0\n\nSeller Selector displays the number of [**sellers**](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/what-is-a-seller--5FkLvhZ3Few4CWWIuYOK2w) your marketplace has for each product. It enables users to compare prices from each seller and add the desired product to their cart.\n\n\n\n## Configuration\n\n1. Install the Seller Selector app to your store with the following command:\n\n`1\n\nvtex install vtex.seller-selector@0.x \n\n`\n\n1. Add the Seller Selector app to your theme's dependencies in the `manifest.json` as shown below:\n\n`1\n\n\"dependencies\": { \n\n2\n\n \"vtex.seller-selector\": \"0.x\" \n\n3\n\n} \n\n`\n\n1. Add the `link-seller` block, exported by the `vtex.seller-selector` app, inside your product page (`store.product` template). When rendered, the block will create a link to the Seller Selector main page. For example:\n\n`1\n\n \"flex-layout.col#right-col\": { \n\n2\n\n \"props\": { \n\n3\n\n \"preventVerticalStretch\": true, \n\n4\n\n \"rowGap\": 0 \n\n5\n\n }, \n\n6\n\n \"children\": [ \n\n7\n\n \"product-name\", \n\n8\n\n+ \"link-seller\" \n\n9\n\n \"product-price#product-details\", \n\n10\n\n \"product-separator\", \n\n11\n\n \"flex-layout.row#buy-button\", \n\n12\n\n \"availability-subscriber\", \n\n13\n\n \"shipping-simulator\", \n\n14\n\n \"share#default\" \n\n15\n\n ] \n\n16\n\n }, \n\n`\n\nBy declaring the `link-seller` block, a page containing all available sellers will be displayed automatically. However, you can configure the Seller Selector page layout, using props for each one of the blocks used to build it behind the scenes.\n\n### Advanced Configuration\n\nBehind the scenes, the Seller Selector page uses the following default implementation:\n\n`1\n\n{ \n\n2\n\n \"store.sellers\": { \n\n3\n\n \"blocks\": [ \n\n4\n\n \"seller-table\" \n\n5\n\n ] \n\n6\n\n }, \n\n7\n\n \"seller-table\": { \n\n8\n\n \"children\": [ \n\n9\n\n \"vtex.store-components:product-name\", \n\n10\n\n \"seller-simulate-shipping\", \n\n11\n\n \"seller-head\", \n\n12\n\n \"seller-body\" \n\n13\n\n ] \n\n14\n\n }, \n\n15\n\n \"seller-head\": { \n\n16\n\n \"children\": [ \n\n17\n\n \"seller-head-cell#Seller\", \n\n18\n\n \"seller-head-cell#Price\", \n\n19\n\n \"seller-head-cell#Shipping\", \n\n20\n\n \"seller-head-cell#PriceWithShipping\", \n\n21\n\n \"seller-head-cell#BuyButton\" \n\n22\n\n ] \n\n23\n\n }, \n\n24\n\n \"seller-head-cell#Seller\": { \n\n25\n\n \"props\": { \n\n26\n\n \"title\": \"Seller\" \n\n27\n\n } \n\n28\n\n }, \n\n29\n\n \"seller-head-cell#Price\": { \n\n30\n\n \"props\": { \n\n31\n\n \"title\": \"Price\" \n\n32\n\n } \n\n33\n\n }, \n\n34\n\n \"seller-head-cell#Shipping\": { \n\n35\n\n \"props\": { \n\n36\n\n \"title\": \"Shipping\" \n\n37\n\n } \n\n38\n\n }, \n\n39\n\n \"seller-head-cell#PriceWithShipping\": { \n\n40\n\n \"props\": { \n\n41\n\n \"title\": \"Price With Shipping\" \n\n42\n\n } \n\n43\n\n }, \n\n44\n\n \"seller-head-cell#BuyButton\": { \n\n45\n\n \"props\": { \n\n46\n\n \"title\": \"Add To Cart\" \n\n47\n\n } \n\n48\n\n }, \n\n49\n\n \"seller-body\": { \n\n50\n\n \"children\": [ \n\n51\n\n \"seller-row\" \n\n52\n\n ] \n\n53\n\n }, \n\n54\n\n \"seller-row\": { \n\n55\n\n \"children\": [ \n\n56\n\n \"seller-name\", \n\n57\n\n \"seller-price\", \n\n58\n\n \"seller-shipping\", \n\n59\n\n \"seller-price-with-shipping\", \n\n60\n\n \"seller-add-to-cart\" \n\n61\n\n ] \n\n62\n\n }, \n\n63\n\n \"seller-add-to-cart\":{ \n\n64\n\n \"blocks\":[ \n\n65\n\n \"add-to-cart-button\" \n\n66\n\n ] \n\n67\n\n } \n\n68\n\n} \n\n`\n\n| Block name | Description |\n| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| seller-table | Layout block that provides a table to build the Seller Selector page with other blocks. It is possible to build the page using three main blocks: seller-simulate-shipping, seller-head and seller-body (declared as children of seller-head). |\n| seller-simulate-shipping | Builds a form so users can add a postal code and then simulate the shipping costs to the desired address. |\n| seller-head | Builds a header to be used on the Seller Selector table. You can pass to it the seller-head-cell block as children. |\n| seller-head-cell | Defines a title for each column in the table header. |\n| seller-body | Defines the page main content. It is responsible for displaying all sellers' data in the table body. |\n| seller-row | Used inside the Seller Selector table to separate seller's data into columns. You can use the blocks listed below (seller-name, seller-price, seller-shipping, seller-price-with-shipping, seller-add-to-cart) as seller-row's children in order to provide all needed seller's data. |\n| seller-name | Displays the seller name. |\n| seller-price | Displays the seller price for a given product. |\n| seller-shipping | Displays shipping cost considering the sellers' data. |\n| seller-price-with-shipping | Displays the purchase final cost (shipping cost + product price). |\n| seller-add-to-cart | Displays a Buy button that adds a given seller's product to the shopping cart. It is possible to use two different blocks inside of it buy-button or add-to-cart-button |\n| buy-button | Default buy button, will be used if nothing is provided in the blocks section of seller-add-to-cart |\n| add-to-cart-button | Buy button to use with Minicart.V2 and GoCommerce Stores |\n\n#### `link-seller` props\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | ------------------------------ | -------------------------- |\n| message | string | Text displayed on link counter | store/seller-link.linkText |\n\n| Message variables | Type | Description | Example |\n| ----------------- | ------ | ----------------------------------- | ----------------------------------------------------------------------------- |\n| sellerQuantity | number | Number of sellers sell this product | View {**sellerQuantity**, plural, one {1 more seller} other {# more sellers}} |\n\nThis block uses the [ICU Message Format](https://read.calvincode.net/reader?url=https://format-message.github.io/icu-message-format-for-translators/), making it possible to fully edit the text message and variables displayed on block.\n\n#### `seller-table` props\n\n| Prop name | Type | Description | Default value |\n| ----------------------------- | ------ | ----------------------------------------------- | ------------- |\n| limitShownShippingInformation | number | Max number of shipping options to be displayed. | 3 |\n\n#### `seller-add-to-cart` props\n\n| Prop name | Type | Description | Default value |\n| ------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| isOneClickBuy | boolean | Defines if users will keep navigating in the same page once the Buy button was clicked on (true) or if they will be redirected (false) | false |\n\n#### `seller-head-cell` props\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | --------------------------------------------------- | ------------- |\n| title | string | Text displayed on the table header for each column. | undefined |\n\n## Modus operandi\n\nThe Seller Selector app fetch seller's data automatically from the [admin's Catalog ](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/configuring-the-seller--tutorials%5F392). Behind the scenes, the blocks exported from the app use the product context in which they are inserted to identify the seller's data in the SKU registry. Based on this, they are able to display seller data without having to declare each desired seller in your theme.\n\n## Customization\n\nIn order to apply CSS customizations in this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization).\n\n| CSS Handles |\n| ----------------------- |\n| linkSellerContainer |\n| linkSeller |\n| linkSellerText |\n| linkSellerNumber |\n| sellerMasterContainer |\n| sellerBuyContainer |\n| sellerList |\n| sellerBodyCell |\n| sellerHead |\n| sellerHeadCell |\n| sellerHeadText |\n| sellerName |\n| sellerPrice |\n| sellerPriceShipping |\n| sellerPriceShippingText |\n| sellerRow |\n| sellerShipping |\n| sellerShippingText |\n| sellerRow |\n| simulateShipping |\n| simulateShippingSearch |\n| simulateShippingSpinner |\n\n[Querying personal MasterData Information with SafeData« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.safedata)[Similar Products VariantsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.similar-products-variants)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.seller-selector%23configuration)\n\n[Advanced Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.seller-selector%23advanced-configuration)\n\n[Modus operandi](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.seller-selector%23modus-operandi)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.seller-selector/docs/apps/vtex.seller-selector%23customization)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_cf705207
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore organisms filter slider in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-overview)\n\n[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-banner-text)\n\n[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-cart-sidebar)\n\n[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-empty-state)\n\n[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-filter-slider)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-filter)\n\n[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-hero)\n\n[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-image-gallery)\n\n[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-navbar-slider)\n\n[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-navbar)\n\n[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-newsletter)\n\n[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-out-of-stock)\n\n[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-payment-methods)\n\n[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-price-range)\n\n[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-product-grid)\n\n[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-product-shelf)\n\n[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-region-modal)\n\n[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-search-input)\n\n[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-shipping-simulation)\n\n[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-slide-over)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-overview)\n\n[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-banner-text)\n\n[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-cart-sidebar)\n\n[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-empty-state)\n\n[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-filter-slider)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-filter)\n\n[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-hero)\n\n[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-image-gallery)\n\n[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-navbar-slider)\n\n[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-navbar)\n\n[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-newsletter)\n\n[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-out-of-stock)\n\n[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-payment-methods)\n\n[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-price-range)\n\n[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-product-grid)\n\n[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-product-shelf)\n\n[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-region-modal)\n\n[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-search-input)\n\n[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-shipping-simulation)\n\n[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-slide-over)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/components-index)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-overview)\n\nFilterSlider\n\nThe mobile `Filter` view that is rendered inside a `SlideOver` component.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/blob/main/packages/components/src/organisms/Filter/FilterSlider.tsx)\n\nThe mobile `Filter` view that is rendered inside a `SlideOver` component.The `FilterSlider` component is a compound of the following:\n\n* `FilterSlider`: `SlideOver` that wraps the `Filter` for small screen dimensions.\n* `Filter`: wraps an `Accordion` along with the component title.\n* `FilterFacets`: wraps an `AccordionItem` with its `AccordionButton` and an `AccordionPanel` for every Facet.\n* `FilterFacetBoolean`: wraps the list of the `FilterFacetBooleanItem`.\n* `FilterFacetBooleanItem`: wraps a `Checkbox` with its `Label` and the `Badge` that represents the child of the `FilterFacetBoolean`.\n* `FilterFacetRange`: wraps a `PriceRange` for a given Facet with the Range type.\n\nExample\n\nCode\n\nOpen Filters\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { \n\n2\n\n FilterSlider, \n\n3\n\n Filter, \n\n4\n\n FilterFacets, \n\n5\n\n FilterFacetBoolean, \n\n6\n\n FilterFacetBooleanItem, \n\n7\n\n FilterFacetRange, \n\n8\n\n} from \"@faststore/ui\"; \n\n`\n\n### Import styles\n\nTo apply styles, include the following in your stylesheet:\n\n`1\n\n@import \"@faststore/ui/src/components/organisms/FilterSlider/styles.scss\"; \n\n`\n\nFor details, see [Importing FastStore UI component styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles).\n\n---\n\n## Design tokens\n\n### Content\n\n| Local token | Default value/Global token linked |\n| ----------------------------------- | --------------------------------------------------------------------------------------------------------- |\n| \\--fs-filter-slider-content-height | calc(100vh - var(--fs-filter-slider-footer-height)) |\n| \\--fs-filter-slider-content-padding | var(--fs-spacing-3) var(--fs-spacing-3) calc(var(--fs-filter-slider-footer-height) + var(--fs-spacing-3)) |\n\n### Title\n\n| Local token | Default value/Global token linked |\n| ------------------------------------- | --------------------------------- |\n| \\--fs-filter-slider-title-font-size | var(--fs-text-size-4) |\n| \\--fs-filter-slider-title-font-weight | var(--fs-text-weight-bold) |\n| \\--fs-filter-slider-title-line-height | 1.12 |\n\n### Footer\n\n| Local token | Default value/Global token linked |\n| ------------------------------------- | --------------------------------- |\n| \\--fs-filter-slider-footer-width | 100% |\n| \\--fs-filter-slider-footer-height | 5rem |\n| \\--fs-filter-slider-footer-padding | var(--fs-spacing-3) |\n| \\--fs-filter-slider-footer-bkg-color | var(--fs-color-neutral-0) |\n| \\--fs-filter-slider-footer-box-shadow | 0 0 6px rgb(0 0 0 / 20%) |\n\n### Footer Buttons\n\n| Local token | Default value/Global token linked |\n| ---------------------------------------------------- | --------------------------------- |\n| \\--fs-filter-slider-footer-button-clear-width | 40% |\n| \\--fs-filter-slider-footer-button-clear-margin-right | var(--fs-spacing-3) |\n| \\--fs-filter-slider-footer-button-apply-width | 60% |\n\n---\n\n## Data attributes\n\nYou can target and override `FilterSlider` styles using the following data attributes:\n\n`data-fs-filter-slider`\n\n`data-fs-filter-slider-content`\n\n`data-fs-filter-slider-title`\n\n`data-fs-filter-slider-footer`\n\n`data-fs-filter-slider-footer-button-apply`\n\n`data-fs-filter-slider-footer-button-clear`\n\n---\n\n## Props\n\n### FilterSlider\n\n| Name | Type | Description | Default |\n| ---- | ---- | ----------- | ------- |\n\nContributors\n\n3\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/aliceoq)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/organisms/filter-slider.mdx)\n\n[EmptyState« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-empty-state)[FilterNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-filter)\n\nContributors\n\n3\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/aliceoq)\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-filter-slider%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-filter-slider%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-filter-slider%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-filter-slider%23design-tokens)\n\n[Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-filter-slider%23content)[Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-filter-slider%23title)[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-filter-slider%23footer)[Footer Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-filter-slider%23footer-buttons)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-filter-slider%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-filter-slider%23props)\n\n[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-filter-slider%23filterslider)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/organisms/filter-slider.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-filter-slider%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-filter-slider%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-filter-slider%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-filter-slider%23design-tokens)\n\n[Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-filter-slider%23content)[Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-filter-slider%23title)[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-filter-slider%23footer)[Footer Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-filter-slider%23footer-buttons)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-filter-slider%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-filter-slider%23props)\n\n[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter-slider/docs/guides/faststore/organisms-filter-slider%23filterslider)\n\nOn this page\n\n[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=)"
}
] |
doc_b49c1d29
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides payments integration implementing a payment provider in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-guide)\n\n[Integrating a new payment provider on VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/integrating-a-new-payment-provider-on-vtex)\n\n[Payment Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-payment-provider-protocol)\n\n[Payment Provider Protocol for Point of Sale (POS) - VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-ppp-applied-to-pos)\n\n[Implementing a Payment Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-implementing-a-payment-provider)\n\n[Payment Provider Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-payment-provider-framework)\n\n[Purchase Flows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-purchase-flows)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-payment-app)\n\n[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-payment-methods)\n\n[Payment Provider Homologation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-payment-provider-homologation)\n\n[Antifraud Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works)\n\n[PCI - DSS Compliance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-pci-dss-compliance)\n\n[Secure Proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-secure-proxy)\n\n[Split Payouts on Payment Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/split-payouts-on-payment-provider-protocol)\n\n[Layout Development Guide for payment methods in Smart Checkout VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex)\n\n[Custom Auto Capture Feature](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/custom-auto-capture-feature)\n\n[Pix: Instant Payments in Brazil](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-pix-instant-payments-in-brazil)\n\n[PSE Payment Method](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/pse-payment-method)\n\n[Google Pay: processing information for payment providers and anti-fraud](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-guide)\n\n[Integrating a new payment provider on VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/integrating-a-new-payment-provider-on-vtex)\n\n[Payment Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-payment-provider-protocol)\n\n[Payment Provider Protocol for Point of Sale (POS) - VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-ppp-applied-to-pos)\n\n[Implementing a Payment Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-implementing-a-payment-provider)\n\n[Payment Provider Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-payment-provider-framework)\n\n[Purchase Flows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-purchase-flows)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-payment-app)\n\n[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-payment-methods)\n\n[Payment Provider Homologation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-payment-provider-homologation)\n\n[Antifraud Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works)\n\n[PCI - DSS Compliance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-pci-dss-compliance)\n\n[Secure Proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-secure-proxy)\n\n[Split Payouts on Payment Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/split-payouts-on-payment-provider-protocol)\n\n[Layout Development Guide for payment methods in Smart Checkout VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex)\n\n[Custom Auto Capture Feature](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/custom-auto-capture-feature)\n\n[Pix: Instant Payments in Brazil](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-pix-instant-payments-in-brazil)\n\n[PSE Payment Method](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/pse-payment-method)\n\n[Google Pay: processing information for payment providers and anti-fraud](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides)\n\nIntegration Guides\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-guide)\n\n[Implementing a Payment Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-implementing-a-payment-provider)\n\nImplementing a Payment Provider\n\nThe following sections show how to develop the middleware that will interpret the calls made between VTEX and the provider.\n\nIt also shows that the payment provider protocol consists of nine endpoints, divided into two sessions: **Payment flow** and **Configuration flow**. The middleware must be able to receive the information supplied by all these calls properly.\n\n> To develop a new payment connector, it is mandatory to follow the **prerequisites determined by VTEX**. You can learn about them in the [Implementation prerequisites section of our Payment Provider Protocol article](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/payment-provider-protocol--RdsT2spdq80MMwwOeEq0m%23implementation-prerequisites).\n\n## Developing the middleware\n\n### Requirements\n\nThe middleware can be developed using any programming language, there are no restrictions. However, we established four requirements for this stage:\n\n* The endpoint must be served over HTTPS on port 443 with TLS 1.2 support. **That format is required,** in no case endpoints served over HTTP will be accepted in the implementation process.\n* The partner’s API must be public. In the homologation process, we will \\*\\*not \\*\\*accept any kind of restricted APIs.\n* The partner must create a subdomain or a domain name to the endpoint. IP addresses will not be accepted as names under any circumstances.\n* We want our processes to run quickly, so it is important that the endpoint responds in less than 5 seconds to the homologation tests. Also, the endpoint must respond in less than 20 seconds to any call.\n\nWith the requirements aligned, we can proceed to the Payment Flow.\n\n## Payment Flow\n\nThe following endpoints are used to implement the operations that happen in the authorization, cancellation or refund, and settlement flows.\n\n**1\\. GET Manifest**\n\nThrough this endpoint, the provider's manifest is displayed, consisting of a variety of metadata settings such as payment methods, split configuration, and custom fields.\n\n`1\n\n{ \n\n2\n\n \"paymentMethods\": [ \n\n3\n\n { \n\n4\n\n \"name\": \"Visa\", \n\n5\n\n \"allowsSplit\": \"onCapture\" \n\n6\n\n }, \n\n7\n\n { \n\n8\n\n \"name\": \"Pix\", \n\n9\n\n \"allowsSplit\": \"disabled\" \n\n10\n\n }, \n\n11\n\n { \n\n12\n\n \"name\": \"MasterCard\", \n\n13\n\n \"allowsSplit\": \"onCapture\" \n\n14\n\n }, \n\n15\n\n { \n\n16\n\n \"name\": \"American Express\", \n\n17\n\n \"allowsSplit\": \"onCapture\" \n\n18\n\n }, \n\n19\n\n { \n\n20\n\n \"name\": \"BankInvoice\", \n\n21\n\n \"allowsSplit\": \"onAuthorize\" \n\n22\n\n }, \n\n23\n\n { \n\n24\n\n \"name\": \"Privatelabels\", \n\n25\n\n \"allowsSplit\": \"disabled\" \n\n26\n\n }, \n\n27\n\n { \n\n28\n\n \"name\": \"Promissories\", \n\n29\n\n \"allowsSplit\": \"disabled\" \n\n30\n\n } \n\n31\n\n ] \n\n32\n\n } \n\n`\n\n> If you support any type of [custom payment](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-to-configure-a-custom-payment--tutorials%5F451), please indicate only the method supported type (Cobranded, Privatelabels or Promissories) in the `\"name\"` field. It is not necessary to describe the specific name of the supported custom payment (e.g., Colombian Bank Promissory).\n\nFor more information about this step, you can check the [GET List Payment Provider Manifest](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23get-/manifest) endpoint documentation.\n\n**2\\. POST Create Payment**\n\nWhen a customer makes a purchase at the checkout, the provider must create a payment related to the order. Therefore, the provider must be ready to receive the request body that will contain all the cart information:\n\n`1\n\n{ \n\n2\n\n \"reference\": \"32478982\", \n\n3\n\n \"orderId\": \"1047232106697\", \n\n4\n\n \"selerId\": \"xpto\", \n\n5\n\n \"transactionId\": \"611966\", \n\n6\n\n \"paymentId\": \"5B127F1E0C944EF9ACE264FEC1FC0E91\", \n\n7\n\n \"paymentMethod\": \"cash\", \n\n8\n\n \"paymentMethodCustomCode\": \"{{paymentMethodCustomCode}}\", \n\n9\n\n \"merchantName\": \"lojaexemplo\", \n\n10\n\n \"value\": \"29,90\", \n\n11\n\n \"currency\": \"BRL\", \n\n12\n\n \"installments\": \"0\", \n\n13\n\n \"deviceFingerprint\": \"12ade389087fe\", \n\n14\n\n \"card\": { \n\n15\n\n \"holder\": \"{{cardHolder}}\", \n\n16\n\n \"number\": \"{{cardNumber}}\", \n\n17\n\n \"csc\": \"{{cardSecurityCode}}\", \n\n18\n\n \"expiration\": { \n\n19\n\n \"month\": \"{{cardExpirationMonth}}\", \n\n20\n\n \"year\": \"{{cardExpirationYear}}\" \n\n21\n\n } \n\n22\n\n }, \n\n23\n\n \"miniCart\": { \n\n24\n\n \"shippingValue\": 11.44, \n\n25\n\n \"taxValue\": 10.01, \n\n26\n\n \"buyer\": { \n\n27\n\n \"id\": \"c1245228-1c68-11e6-94ac-0afa86a846a5\", \n\n28\n\n \"firstName\": \"John\", \n\n29\n\n \"lastName\": \"Doe\", \n\n30\n\n \"document\": \"01234567890\", \n\n31\n\n \"documentType\": \"CPF\", \n\n32\n\n \"email\": \"john.doe@example.com\", \n\n33\n\n \"phone\": \"+12125357200\" \n\n34\n\n }, \n\n35\n\n \"shippingAddress\": { \n\n36\n\n \"country\": \"USA\", \n\n37\n\n \"street\": \"12 E 49th St\", \n\n38\n\n \"number\": \"10017\", \n\n39\n\n \"complement\": \"Tower 49 Gallery\", \n\n40\n\n \"neighborhood\": \"Central Midtown\", \n\n41\n\n \"postalCode\": \"10017\", \n\n42\n\n \"city\": \"New York\", \n\n43\n\n \"state\": \"NY\" \n\n44\n\n }, \n\n45\n\n \"billingAddress\": { \n\n46\n\n \"country\": \"USA\", \n\n47\n\n \"street\": \"12 E 49th St\", \n\n48\n\n \"number\": \"10017\", \n\n49\n\n \"complement\": \"Tower 49 Gallery\", \n\n50\n\n \"neighborhood\": \"Central Midtown\", \n\n51\n\n \"postalCode\": \"10017\", \n\n52\n\n \"city\": \"New York\", \n\n53\n\n \"state\": \"NY\" \n\n54\n\n }, \n\n55\n\n \"items\": [ \n\n56\n\n { \n\n57\n\n \"id\": \"132981\", \n\n58\n\n \"name\": \"My First Product\", \n\n59\n\n \"price\": 2134.90, \n\n60\n\n \"quantity\": 2, \n\n61\n\n \"discount\": 5.00 \n\n62\n\n }, \n\n63\n\n { \n\n64\n\n \"id\": \"123242\", \n\n65\n\n \"name\": \"My Second Product\", \n\n66\n\n \"price\": 21.98, \n\n67\n\n \"quantity\": 1, \n\n68\n\n \"discount\": 1.00 \n\n69\n\n } \n\n70\n\n ] \n\n71\n\n }, \n\n72\n\n \"url\": \"https://admin.mystore.example.com/orders/v32478982\", \n\n73\n\n \"callbackUrl\": \"{{callbackUrl}}\", \n\n74\n\n \"returnUrl\": \"{{returnUrl}}\" \n\n75\n\n} \n\n`\n\nThe `callbackURL` is a URL used to make retries in the operation flow. In addition, if the partner adopts redirect as a payment flow, you should also include the `returnURL` in the request payload. Thus, VTEX will be able to realize the redirect flow, if necessary.\n\n> Both `callbackURL` and `returnURL` are developed by the provider.\n\nOn the other hand, we need that your provider returns this call with the following response:\n\n`1\n\n \n2\n\n{ \n\n3\n\n \"paymentId\": \"5B127F1E0C944EF9ACE264FEC1FC0E91\", \n\n4\n\n \"status\": \"undefined\", \n\n5\n\n \"authorizationId\": \"AUT-E4B9C36034-ASYNC\", \n\n6\n\n \"paymentUrl\": \"https://exemplo2.vtexpayments.com.br/api/pub/fake-payment-provider/payment-redirect/611966/payments/5B127F1E0C944EF9ACE264FEC1FC0E91\", \n\n7\n\n \"nsu\": \"NSU-171BE62CB7-ASYNC\", \n\n8\n\n \"tid\": \"TID-20E659E8E5-ASYNC\", \n\n9\n\n \"acquirer\": \"TestPay\", \n\n10\n\n \"code\": \"2000-ASYNC\", \n\n11\n\n \"message\": null, \n\n12\n\n \"delayToAutoSettle\": 21600, \n\n13\n\n \"delayToAutoSettleAfterAntifraud\": 1800, \n\n14\n\n \"delayToCancel\": 21600 \n\n15\n\n} \n\n`\n\nThe parameters `delayToAutoSettle` and `delayToAutoSettleAfterAntifraud` define the total of time that the system will wait to start the capture flow. A similar process happens for the parameter `delayToCancel`, but after the timeout, the system will proceed to the cancellation flow.\n\n> All of these three periods of time are established by the provider and should be counted in seconds.\n\nAlso, the parameters `code` and `message` are fields to which the provider can send us any information about the process. Both are optional and will appear in the next calls.\n\nAll the fields are described in the [POST Create Payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments) documentation.\n\n**3\\. POST Cancel Payment**\n\nTo cancel a payment, you must already have created one. Your provider must be ready to receive only two information: the `paymentId`, the identifier of the payment that will be canceled, and the `requestId`, the identifier that ensures its idempotency.\n\nFor “idempotency”, we mean an action ability to be done several times. As we explained in the [Operations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows%23operations-in-the-payment-flow) section, the cancellation flow can be retried during a whole day until the provider responds to the call.\n\n`1\n\n{ \n\n2\n\n \"paymentId\": \"F5C1A4E20D3B4E07B7E871F5B5BC9F91\", \n\n3\n\n \"requestId\": \"1234\" \n\n4\n\n} \n\n`\n\nAfter the provider realizes the payment cancelation, we expect a response like this:\n\n`1\n\n{ \n\n2\n\n \"paymentId\": \"F5C1A4E20D3B4E07B7E871F5B5BC9F91\", \n\n3\n\n \"message\": \"Successfully cancelled\", \n\n4\n\n \"code\": null, \n\n5\n\n \"cancellationId\": \"1457BD07E6\", \n\n6\n\n \"requestId\": \"1234\" \n\n7\n\n} \n\n`\n\nRefer to the [complete documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments/-paymentId-/cancellations) for more details.\n\n**4\\. POST Capture Payment**\n\nIf your transaction was completed successfully, the provider can capture the payment. In fact, it is really important for you to know that VTEX supports partial captures.\n\nThis happens because the payment can be captured in two different moments:\n\n* When the store invoices the order.\n* After the period defined in the fields `delayToAutoSettle` and `delayToAutoSettleAfterAntifraud` is timeout.\n\nIn this context, the field `value` is mandatory and crucial for the operation to be realized properly.\n\nVTEX will send the information below to capture a payment:\n\n`1\n\n{ \n\n2\n\n \"paymentId\": \"5B127F1E0C944EF9ACE264FEC1FC0E91\", \n\n3\n\n \"transactionId\": \"611966\", \n\n4\n\n \"value\": 20.0, \n\n5\n\n \"requestId\": \"5678\" \n\n6\n\n} \n\n`\n\nThe response will be similar to the request body. But the parameter `value` can be fulfilled with the full amount that was sent in the request or with a smaller one. It all depends on how much the provider wants to capture.\n\n`1\n\n{ \n\n2\n\n \"paymentId\": \"5B127F1E0C944EF9ACE264FEC1FC0E91\", \n\n3\n\n \"settleId\": \"CEE16492C6\", \n\n4\n\n \"value\": 20.0, \n\n5\n\n \"code\": null, \n\n6\n\n \"message\": null, \n\n7\n\n \"requestId\": \"5678\" \n\n8\n\n} \n\n`\n\nRefer to the [Capture Payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments/-paymentId-/settlements) endpoint documentation for more details.\n\n**5\\. POST Refund Payment**\n\nVTEX also supports partial refunds, it is a similar logic for the capture.\n\nFor example, consider a purchasing cart with two items. One scenario that can happen is that the store needs to return just one of the purchased items. In this case, we can refund just the value of that one single item instead of refunding the full value that includes both items and shipping.\n\nIn any case, the provider should be ready to receive the following request:\n\n`1\n\n{ \n\n2\n\n \"paymentId\": \"VQKIIBUVOFDBIDLKZPOWSKETDYWCMJSACDVXWFCJVSKXGYVBBVISZRJLLQEKERJEMDYEINOUMFAZZGNEDVBQBABLUKLFBSEEIGLCAQTOGOGURKLFCAHJQTDMBNKYBIST\", \n\n3\n\n \"transactionId\": \"611966\", \n\n4\n\n \"settleId\": \"31018A3281\", \n\n5\n\n \"value\": 10.0, \n\n6\n\n \"requestId\": \"5678\" \n\n7\n\n} \n\n`\n\nThe response expected is:\n\n`1\n\n{ \n\n2\n\n \"paymentId\": \"VQKIIBUVOFDBIDLKZPOWSKETDYWCMJSACDVXWFCJVSKXGYVBBVISZRJLLQEKERJEMDYEINOUMFAZZGNEDVBQBABLUKLFBSEEIGLCAQTOGOGURKLFCAHJQTDMBNKYBIST\", \n\n3\n\n \"refundId\": null, \n\n4\n\n \"value\": 0.0, \n\n5\n\n \"code\": \"refund-manually\", \n\n6\n\n \"message\": \"Refund should be done manually\", \n\n7\n\n \"requestId\": \"5678\" \n\n8\n\n} \n\n`\n\nRemember that, if needed, the provider can return the call with the field `value` fulfilled with an amount smaller than the value informed in the request to realize a partial refund.\n\nRefer to the [Post Refund Payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments/-paymentId-/refunds) endpoint for more details.\n\n**6\\. POST Inbound Request (BETA)**\n\nThe Inbound Request (BETA) implements a URL that facilitates a direct connection between our Gateway service and the Payment Provider.\n\nIt is responsible for the communication with the provider's backend through our gateway, relying on the security of sending the context of the transaction by VTEX.\n\nAn example of the request is:\n\n`1\n\n{ \n\n2\n\n \"requestId\": \"LA4E20D3B4E07B7E871F5B5BC9F91\", \n\n3\n\n \"transactionId\": \"D3AA1FC8372E430E8236649DB5EBD08E\", \n\n4\n\n \"paymentId\": \"F5C1A4E20D3B4E07B7E871F5B5BC9F91\", \n\n5\n\n \"authorizationId\": \"{{authorizationId}}\", \n\n6\n\n \"tid\": \"{{tid}}\", \n\n7\n\n \"requestData\": { \n\n8\n\n \"body\": \"{{originalRequestBody}}\" \n\n9\n\n } \n\n10\n\n} \n\n`\n\nAn expected response would be:\n\n`1\n\n{ \n\n2\n\n \"requestId\": \"LA4E20D3B4E07B7E871F5B5BC9F91\", \n\n3\n\n \"paymentId\": \"F5C1A4E20D3B4E07B7E871F5B5BC9F91\", \n\n4\n\n \"responseData\": { \n\n5\n\n \"statusCode\": 200, \n\n6\n\n \"contentType\": \"application/json\", \n\n7\n\n \"content\": \"{\\\"myAttribute\\\":\\\"anyValue\\\"}\" \n\n8\n\n } \n\n9\n\n} \n\n`\n\nRefer to the [Post Inbound Request (BETA)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments/-paymentId-/inbound-request/-action-) endpoint for more details.\n\n## Configuration Flow\n\nIn VTEX, the merchant has to enable one or more connectors through the Admin. The setup is basically the same for all the partners and you can check the [tutorial](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/afiliacoes-de-gateway--tutorials%5F444) on our Help Center.\n\nHowever, this operation follows an authentication flow that allows the provider to recognize and authorize the merchant’s solicitation. The following endpoints generate three credentials - `appKey`, `appToken` and `applicationId` \\- that are saved by the VTEX system, which allows the merchant to enable the connector without copying and pasting any credentials.\n\n> This flow is optional and does not impact your connection with VTEX. If you do not intend to implement it, skip to the [Homologation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation) section.\n\n**1\\. POST Create Authorization Token**\n\nFor the first step, the request body will be:\n\n`1\n\n{ \n\n2\n\n \"applicationId\": \"vtex\", \n\n3\n\n \"returnUrl\": \"https://admin.mystore.example.com/provider-return?authorizationCode=\" \n\n4\n\n} \n\n`\n\n> The `applicationId` will always be \"vtex\".\n\nThen, the provider should return an identification token so we can redirect the merchant to the provider application.\n\n`1\n\n{ \n\n2\n\n \"applicationId\": \"vtex\", \n\n3\n\n \"token\": \"auth_token_39766d98535d43a491d03b8c3bea060f\" \n\n4\n\n} \n\n`\n\nRefer to the [Create Authorization Token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/authorization/token) endpoint documentation to check all the details.\n\n**2\\. GET Provider Authentication**\n\nThis call enables the merchant to analyse the provider’s terms and conditions to use its service.\n\nWith the token supplied in the previous response body, VTEX can redirect the merchant to the provider login page.\n\nIn the response body, we expect an `authorizationCode` related to the `returnUrl` sent to you in the first step of the configuration flow.\n\n`1\n\n{ \n\n2\n\n \"authorizationCode\": \"auth_code_5b7be276c8e04e95bb1e\", \n\n3\n\n Grant access to \"vtex\" application \n\n4\n\n} \n\n`\n\nRefer to the [Get Provider Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23get-/authorization/redirect) endpoint for more details.\n\n**3\\. GET Credentials**\n\nFinally, the provider must send us the values of the three credentials.\n\nWe expect a response similar to this one:\n\n`1\n\n{ \n\n2\n\n \"applicationId\": \"vtex\", \n\n3\n\n \"appKey\": \"test_key_AE06E97A8C5B45DFA2DC665D6BE91E\", \n\n4\n\n \"appToken\": \"test_token_90FB36380D114B37BC0557AEEE40ED\" \n\n5\n\n} \n\n`\n\nWith that, the credentials will be saved in our system and activated at the moment the merchant decides to enable the conector.\n\nRefer to the [Get Credentials](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23get-/authorization/credentials) endpoint to check all the details.\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/payments-integration-guide/payments-integration-implementing-a-payment-provider.md)\n\n[Payment Provider Protocol for Point of Sale (POS) - VTEX Sales App« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider//docs/guides/payments-integration-ppp-applied-to-pos)[Payment Provider FrameworkNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider//docs/guides/payments-integration-payment-provider-framework)\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Developing the middleware](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-implementing-a-payment-provider%23developing-the-middleware)\n\n[Requirements](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-implementing-a-payment-provider%23requirements)\n\n[Payment Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-implementing-a-payment-provider%23payment-flow)\n\n[Configuration Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-implementing-a-payment-provider%23configuration-flow)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/payments-integration-guide/payments-integration-implementing-a-payment-provider.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Developing the middleware](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-implementing-a-payment-provider%23developing-the-middleware)\n\n[Requirements](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-implementing-a-payment-provider%23requirements)\n\n[Payment Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-implementing-a-payment-provider%23payment-flow)\n\n[Configuration Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider/docs/guides/payments-integration-implementing-a-payment-provider%23configuration-flow)\n\nOn this page\n\n[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=)"
}
] |
doc_433e1022
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides calling commerce apis on vtex io in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/vtex-io-documentation-service)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[1\\. Getting the Service app boilerplate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate)\n\n[2\\. Discovering VTEX Commerce APIs and authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication)\n\n[3\\. Using VTEX IO clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/calling-commerce-apis-3-using-vtex-io-clients)\n\n[Calling Commerce APIs - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/calling-commerce-apis-conclusion)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/vtex-io-documentation-clients)\n\nHandling events\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/service-path-patterns)\n\n[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/configuring-dynamic-routes-in-vtex-io-services)\n\n[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/vtex-io-documentation-developing-service-configuration-apps)\n\n[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/node-builder-7x-migration-guide)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/vtex-io-documentation-service)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[1\\. Getting the Service app boilerplate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate)\n\n[2\\. Discovering VTEX Commerce APIs and authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication)\n\n[3\\. Using VTEX IO clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/calling-commerce-apis-3-using-vtex-io-clients)\n\n[Calling Commerce APIs - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/calling-commerce-apis-conclusion)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/vtex-io-documentation-clients)\n\nHandling events\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/service-path-patterns)\n\n[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/configuring-dynamic-routes-in-vtex-io-services)\n\n[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/vtex-io-documentation-developing-service-configuration-apps)\n\n[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/node-builder-7x-migration-guide)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/app-development)\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/app-development-guides)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/calling-commerce-apis-on-vtex-io)\n\nCalling Commerce APIs on VTEX IO\n\nWhen developing a VTEX IO app, one of the possible needs is to access VTEX Core Services (Catalog, OMS, Logistics, etc.), which can be done using our APIs. In this course, you will understand some basic concepts about **VTEX Commerce APIs** and how to use them in your application running on VTEX IO.\n\nBy the end of this course, you will be able to:\n\n* Understand how authentication works for VTEX apps and use it to access external resources.\n* Use Clients in an app to make requests and access VTEX Core Services.\n\nYou can check following documentation on our Developer Portal, which explains with more details some concepts used through this course:\n\n* [Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients)\n* [Policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies)\n\n## Overview\n\n1. [Getting the Service app boilerplate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate)\n2. [Understanding VTEX Commerce APIs and authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication)\n3. [Using VTEX IO Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients)\n\n## Before you begin\n\nThis course will teach you how to call VTEX Commerce APIs from a VTEX IO app. To get started, you will need to meet the following prerequisites:\n\n* Know [TypeScript programming language](https://read.calvincode.net/reader?url=https://www.typescriptlang.org/).\n* Install [Git](https://read.calvincode.net/reader?url=https://git-scm.com).\n* Install the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install).\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Calling Commerce APIs/calling-commerce-apis-on-vtex-io.mdx)\n\n[Services - Conclusion« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io//docs/guides/services-conclusion)[1\\. Getting the Service app boilerplateNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io//docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/calling-commerce-apis-on-vtex-io%23overview)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/calling-commerce-apis-on-vtex-io%23before-you-begin)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Calling Commerce APIs/calling-commerce-apis-on-vtex-io.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/calling-commerce-apis-on-vtex-io%23overview)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-on-vtex-io/docs/guides/calling-commerce-apis-on-vtex-io%23before-you-begin)\n\nOn this page\n\n[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=)"
}
] |
doc_e54aa6f0
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation becoming a sponsor account in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[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-becoming-a-sponsor-account/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/api-reference)\n\n[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-becoming-a-sponsor-account/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/storefront-development)\n\n[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-becoming-a-sponsor-account/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/troubleshooting)\n\n[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-becoming-a-sponsor-account/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/managing-edition-apps)\n\n[Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-documentation-edition-app)\n\n[Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-documentation-sponsor-account)\n\n[Becoming a Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-documentation-becoming-a-sponsor-account)\n\n[Developing an Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-documentation-configuring-an-edition-app)\n\n[Updating Edition apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-documentation-updating-edition-apps)\n\n[Seller Portal Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/seller-portal-edition-app)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/managing-edition-apps)\n\n[Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-documentation-edition-app)\n\n[Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-documentation-sponsor-account)\n\n[Becoming a Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-documentation-becoming-a-sponsor-account)\n\n[Developing an Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-documentation-configuring-an-edition-app)\n\n[Updating Edition apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-documentation-updating-edition-apps)\n\n[Seller Portal Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/seller-portal-edition-app)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/app-development)\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/managing-edition-apps)\n\n[Becoming a Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-documentation-becoming-a-sponsor-account)\n\nBecoming a Sponsor Account\n\nCheck all requirements to become a Sponsor Account if you want to publish Edition apps for child accounts.\n\nTo become a [Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account) and be able to manage apps and configurations across multiple accounts using [Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app), you must first check whether your account meets the conditions described in the [Prerequisites](#prerequisites) section.\n\nIf your account is qualified to become a Sponsor Account, follow the [Instructions](#instructions) section to activate this feature for your account.\n\n## Prerequisites\n\nTo be eligible to become a Sponsor Account, ensure you have the following:\n\n* Access to three or more accounts related to the same group or holding.\n* An Edition App published by `vtex` installed on your account (`vtex.edition-business@0.x` or `vtex.edition-store@2.x`). \n> You can check the Edition App installed on your account by running `vtex edition get` in your terminal. If you see the following error: `Message: Edition not set`, [open a support ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/support) requesting the installation of either `vtex.edition-business@0.x` or `vtex.edition-store@2.x`. See [Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app) for more information.\n\n## Instructions\n\nIf your account meets the prerequisites described in the previous section, take the following steps to become a Sponsor Account.\n\n1. [Open a ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/support) with the VTEX Support team, expressing your desire to become a Sponsor Account and develop your own Edition Apps. Remember to include the following information in your ticket: \n * The name of the main account. \n * The names of the accounts that the main account will sponsor. \nThe VTEX team will evaluate your request and take the necessary steps to enable your main account to sponsor other accounts.\n2. Once you receive a successful reply to your support ticket, you must [create, deploy, and release your Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app).\n3. [Open a new ticket](https://read.calvincode.net/reader?url=https://help-tickets.vtex.com/smartlink/sso/login/zendesk) with the VTEX Support team, requesting the installation of your new Edition App for the desired accounts.\n\nOnce you receive a successful reply to your support ticket, you'll be able to sponsor child accounts using the account you used to develop and release your new Edition App.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/managing-edition-apps/vtex-io-documentation-becoming-a-sponsor-account.md)\n\n[Sponsor Account« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account//docs/guides/vtex-io-documentation-sponsor-account)[Developing an Edition AppNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account//docs/guides/vtex-io-documentation-configuring-an-edition-app)\n\nSee also\n\n[Edition AppGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-documentation-edition-app)[Sponsor AccountGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-documentation-sponsor-account)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Prerequisites](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-documentation-becoming-a-sponsor-account%23prerequisites)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-documentation-becoming-a-sponsor-account%23instructions)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/managing-edition-apps/vtex-io-documentation-becoming-a-sponsor-account.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Prerequisites](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-documentation-becoming-a-sponsor-account%23prerequisites)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account/docs/guides/vtex-io-documentation-becoming-a-sponsor-account%23instructions)\n\nOn this page\n\n[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=)"
}
] |
doc_3801d5fc
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides master data best practices in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/master-data-best-practices)\n\n[Extracting data from Master Data with search and scroll](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/extracting-data-from-master-data-with-search-and-scroll)\n\n[Pagination in the Master Data API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/pagination-in-the-master-data-api)\n\n[Avoiding CORS in Master Data requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/avoiding-cors-in-master-data-requests)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/master-data-v1)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/master-data-best-practices)\n\n[Extracting data from Master Data with search and scroll](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/extracting-data-from-master-data-with-search-and-scroll)\n\n[Pagination in the Master Data API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/pagination-in-the-master-data-api)\n\n[Avoiding CORS in Master Data requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/avoiding-cors-in-master-data-requests)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/master-data-v1)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides)\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/master-data-best-practices)\n\nMaster Data best practices\n\nGet started with Master Data document management, data entity customization, and trigger utilization.\n\nBelow, you can check some guides to help you get started with Master Data.\n\n## Manage documents\n\nSee Master Data v2 endpoints for managing documents:\n\n* `POST` \\- [Create new document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23post-/api/dataentities/-dataEntityName-/documents)\n* `GET` \\- [Get document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23get-/api/dataentities/-dataEntityName-/documents/-id-)\n* `PUT` \\- [Update entire document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23put-/api/dataentities/-dataEntityName-/documents/-id-)\n* `PATCH` \\- [Update partial document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23patch-/api/dataentities/-dataEntityName-/documents/-id-)\n* `DELETE` \\- [Delete document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23delete-/api/dataentities/-dataEntityName-/documents/-id-)\n\n## Customize data entities\n\nSee these articles about customizing data entities and schemas:\n\n* [How to create a data entity](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-data-entity--tutorials%5F1265)\n* [Starting to work on Master Data with JSON Schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/working-with-json-schemas-in-master-data-v2)\n\n## Search documents\n\nBelow, you can see Master Data v2 endpoints for searching documents.\n\n* `GET` \\- [Search documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23get-/api/dataentities/-dataEntityName-/search)\n* `GET` \\- [Scroll documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23get-/api/dataentities/-dataEntityName-/scroll)\n\n## Working with triggers\n\nA Master Data trigger is an action executed after the insert or update of a given document.\n\n* [Create triggers with Master Data v1](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-trigger-in-master-data--tutorials%5F1270)\n* [Setting up triggers in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/master-data-best-practices/master-data-best-practices.md)\n\n[Data consistency and synchronization in Master Data« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices//docs/guides/data-consistency-and-synchronization-in-master-data)[Extracting data from Master Data with search and scrollNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices//docs/guides/extracting-data-from-master-data-with-search-and-scroll)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Manage documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/master-data-best-practices%23manage-documents)\n\n[Customize data entities](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/master-data-best-practices%23customize-data-entities)\n\n[Search documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/master-data-best-practices%23search-documents)\n\n[Working with triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/master-data-best-practices%23working-with-triggers)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/master-data-best-practices/master-data-best-practices.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Manage documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/master-data-best-practices%23manage-documents)\n\n[Customize data entities](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/master-data-best-practices%23customize-data-entities)\n\n[Search documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/master-data-best-practices%23search-documents)\n\n[Working with triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-best-practices/docs/guides/master-data-best-practices%23working-with-triggers)\n\nOn this page\n\n[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=)"
}
] |
doc_7e645bb5
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation vtex io cli update in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[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-vtex-io-cli-update/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/api-reference)\n\n[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-vtex-io-cli-update/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/storefront-development)\n\n[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-vtex-io-cli-update/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/troubleshooting)\n\n[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-vtex-io-cli-update/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n[Installing VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-documentation-vtex-io-cli-install)\n\n[Updating VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-documentation-vtex-io-cli-update)\n\n[Using VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-documentation-vtex-io-cli-usage)\n\n[Managing plugins](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-documentation-vtex-io-cli-plugins)\n\n[Command reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-documentation-vtex-io-cli-command-reference)\n\n[Uninstalling VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-documentation-vtex-io-cli-uninstall)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n[Installing VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-documentation-vtex-io-cli-install)\n\n[Updating VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-documentation-vtex-io-cli-update)\n\n[Using VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-documentation-vtex-io-cli-usage)\n\n[Managing plugins](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-documentation-vtex-io-cli-plugins)\n\n[Command reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-documentation-vtex-io-cli-command-reference)\n\n[Uninstalling VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-documentation-vtex-io-cli-uninstall)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/app-development)\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n[Updating VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-documentation-vtex-io-cli-update)\n\nUpdating VTEX IO's CLI\n\nIf the VTEX IO’s CLI version installed on your machine is outdated or deprecated, run the command relative to your operating system to update it.\n\nMacOS \n* Brew\n\nUpdate\n\n`1\n\nbrew upgrade vtex \n\n`\n\nReinstall\n\n`1\n\nbrew unlink vtex \n\n2\n\nbrew install vtex/vtex \n\n`\n\n \nLinux \n* Standalone\n\n`1\n\nvtex autoupdate \n\n`\n\n> The standalone update is a tarball with a binary that contains its own node.js binary.\n\n \nWindows \n* Standalone.exe\n\n`1\n\nvtex autoupdate \n\n`\n\n \n## Updating VTEX IO's CLI via NPM\n\nIf you have [installed VTEX IO's CLI via NPM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install), run the following command to update or handle a deprecated version:\n\n`1\n\nyarn global add vtex \n\n`\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/vtex-io-documentation-vtex-io-cli-update.md)\n\n[Installing VTEX IO CLI« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update//docs/guides/vtex-io-documentation-vtex-io-cli-install)[Using VTEX IO's CLINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update//docs/guides/vtex-io-documentation-vtex-io-cli-usage)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Updating VTEX IO's CLI via NPM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-documentation-vtex-io-cli-update%23updating-vtex-ios-cli-via-npm)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/vtex-io-documentation-vtex-io-cli-update.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Updating VTEX IO's CLI via NPM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update/docs/guides/vtex-io-documentation-vtex-io-cli-update%23updating-vtex-ios-cli-via-npm)\n\nOn this page\n\n[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=)"
}
] |
doc_47b752d9
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore headless cms previewing changes in development mode in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/headless-cms-overview)\n\n[Managing content with 'scopes' and 'requiredScopes'](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes)\n\n[Multiple page templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/headless-cms-multiple-page-template)\n\n[Previewing Headless CMS in development mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode)\n\n[Widgets for Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/headless-cms-widgets)\n\n[Customizing pages with Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/dynamic-content-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/headless-cms-overview)\n\n[Managing content with 'scopes' and 'requiredScopes'](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes)\n\n[Multiple page templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/headless-cms-multiple-page-template)\n\n[Previewing Headless CMS in development mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode)\n\n[Widgets for Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/headless-cms-widgets)\n\n[Customizing pages with Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/dynamic-content-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/headless-cms-overview)\n\nPreviewing Headless CMS in development mode\n\nDuring the implementation of a new section or component in the Headless CMS, you can use the `dev mode` to preview the Headless CMS before pushing the changes to your live store.\n\n## Instructions\n\n1. Open your FastStore project and start a development server.\n2. After making changes to your FastStore project directory and syncing them with the Headless CMS, access the VTEX Admin and navigate to **Storefront > Headless CMS**.\n3. Open the **Developer Tool** or right-click on the page and choose **Inspect**.\n4. In the Developer Tool terminal, run the following command: \n`1 \nlocalStorage.setItem('cmsDevMode', 1) \n`\n5. Refresh the page, and you should see the section **Development Mode** in the right sidebar. \n\n6. Click the `Preview` button. A new tab will open.\n7. Copy the link from this tab, which will contain the `contentType`, `documentId`, and `versionId` parameters. The link should be similar to the following: \n`1 \nhttps://faststore.vtex.app/?contentType=page&documentId=bd9e01d6-534e-4e54-aa76-f864dcbad024&versionId=405118e9-7509-11ed-83ab-0eeee363631w \n`\n8. Now, access the local preview by replacing the following parameters accordingly: \n`1 \nlocalhost:3000/api/preview/?contentType={contentType}&documentId={documentId}&versionId={versionId} \n` \n> Replace `{contentType}`, `{documentId}`, and `{versionId}` with the values from your preview link.\n9. Once you have reviewed your changes, open the terminal in the `Developer Tools` and run the following command in the Headless CMS page to terminate the development mode: \n`1 \nlocalStorage.removeItem('cmsDevMode') \n`\n10. Refresh the page, and the development mode session will now be ended.\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/headless-cms/previewing-changes-in-development-mode.mdx)\n\n[Multiple page templates« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/headless-cms-multiple-page-template)[Widgets for Headless CMSNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/headless-cms-widgets)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode%23instructions)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/headless-cms/previewing-changes-in-development-mode.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode%23instructions)\n\nOn this page\n\n[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=)"
}
] |
doc_995c0466
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX flex layout app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/troubleshooting)\n\n[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.flex-layout/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/guides/layout-apps)\n\n[Condition Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/apps/vtex.condition-layout)\n\n[Disclosure Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/apps/vtex.disclosure-layout)\n\n[Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/apps/vtex.flex-layout)\n\n[Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/apps/vtex.modal-layout)\n\n[Overlay Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/apps/vtex.overlay-layout)\n\n[Responsive Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/apps/vtex.responsive-layout)\n\n[Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/apps/vtex.slider-layout)\n\n[Stack Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/apps/vtex.stack-layout)\n\n[Sticky Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/apps/vtex.sticky-layout)\n\n[Tab Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/apps/vtex.tab-layout)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/guides/layout-apps)\n\n[Condition Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/apps/vtex.condition-layout)\n\n[Disclosure Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/apps/vtex.disclosure-layout)\n\n[Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/apps/vtex.flex-layout)\n\n[Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/apps/vtex.modal-layout)\n\n[Overlay Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/apps/vtex.overlay-layout)\n\n[Responsive Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/apps/vtex.responsive-layout)\n\n[Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/apps/vtex.slider-layout)\n\n[Stack Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/apps/vtex.stack-layout)\n\n[Sticky Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/apps/vtex.sticky-layout)\n\n[Tab Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/apps/vtex.tab-layout)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/vtex-io-apps)\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/guides/layout-apps)\n\nFlex Layout\n\nOfficial extension\n\nVersion: 0.21.5\n\nLatest version: 0.21.5\n\nFlex Layout is a **layout structure** built within VTEX IO Store Framework. It allows building complex custom layouts using the concept of **rows** and **columns**, setting the desired block structure and positioning in a page.\n\n\n\n_Example of a page layout built using Flex Layout, following the one row with two columns model_ \n\n## Configuration\n\n**Flex Layout has two basic building blocks**: `flex-layout.row` and `flex-layout.col`. You should **never** use `flex-layout`.\n\nIf you are already familiar with the [flexbox](https://read.calvincode.net/reader?url=https://css-tricks.com/snippets/css/a-guide-to-flexbox/) layout used in CSS, Flex Layout should be easy to grasp since this is what `flex-layout.row` and `flex-layout.col` are using under the hood.\n\nYou can use **any** array of blocks as children for `flex-layout.row` and `flex-layout.col`.\n\nThe props below support [responsive-values](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/responsive-values), meaning that you can define different values for the same prop based on device screen size, such as mobile and desktop.\n\n### `flex-layout.row`\n\n| Prop name | Type | Description | Default value |\n| ------------------------ | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| blockClass | String | Block container class. The set value of this prop functions as a block identifier for CSS customizations. ( | \"\" |\n| borderColor | String | The color of the border. | undefined |\n| borderWidth | 0...5 | A number or string magnitude for applying the bw Tachyons token to the row. | undefined |\n| border | String \\| String\\[\\] | An array to define on which sides of the row a border should apply (top, right, bottom, left, or all). | undefined |\n| colGap | 0...10 | A number or string magnitude for applying the pr Tachyons token to the columns in the flex-layout.row. | undefined |\n| colSizing | equal\\|auto | Controls the width of the columns in the flex-layout.row. | equal |\n| fullWidth | Boolean | Whether the component should occupy all the available width from its parent. | false |\n| horizontalAlign | left\\|right|center|between|around | Controls horizontal alignment for the items in the flex-layout.row. It defaults to between if colSizing is auto and to left otherwise. | left |\n| colJustify | enum | Controls the space between columns and borders of the flex-layout.row, following the justify-content CSS property. Possible values are between (no space added between borders and columns) and around (space added). | between |\n| marginBottom | 0...10 | A number or string magnitude for applying the mb Tachyons token to the row. | undefined |\n| marginTop | 0...10 | A number or string magnitude for applying the mt Tachyons token to the row. | undefined |\n| paddingBottom | 0...10 | A number or string magnitude for applying the pb Tachyons token to the row. | undefined |\n| paddingTop | 0...10 | A number or string magnitude for applying the pt Tachyons token to the row. | undefined |\n| preserveLayoutOnMobile | Boolean | Whether the flex-layout.row should break into a column layout on mobile. | false |\n| preventHorizontalStretch | Boolean | Prevents the row from stretching horizontally to fill its parent's width. | false |\n| preventVerticalStretch | Boolean | Prevents the row from stretching vertically to fill its parent's height with the items-stretch token. | false |\n| rowGap | 0...10 | A number or string magnitude for applying the pb Tachyons token to columns in the flex-layout.row. | undefined |\n| htmlId | String | This prop adds an HTML id to flexRow. This allows accessing a page section using links. | undefined |\n| arialabel | string | Aria-label to be included for accessibility purposes | undefined |\n\n### `flex-layout.col`\n\n| Prop name | Type | Description | Default value |\n| ---------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------ | ------------- |\n| blockClass | String | Block container class. The set value of this prop functions as a block identifier for CSS customizations | \"\" |\n| borderColor | String | The color of the border. | undefined |\n| borderWidth | 0...5 | A number or string magnitude for applying the bw Tachyons token to the column. | undefined |\n| border | String \\| String\\[\\] | An array to define on which sides of the row a border should apply (top, right, bottom, left, or all). | undefined |\n| horizontalAlign | left\\|right|center | Controls horizontal alignment for the items in the flex-layout.col. | left |\n| marginLeft | 0...10 | A number or string magnitude for applying the ml Tachyons token to the column. | undefined |\n| marginRight | 0...10 | A number or string magnitude for applying the mr Tachyons token to the column. | undefined |\n| paddingLeft | 0...10 | A number or string magnitude for applying the pl Tachyons token to the column. | undefined |\n| paddingRight | 0...10 | A number or string magnitude for applying the pr Tachyons token to the column. | undefined |\n| preventVerticalStretch | Boolean | Prevents the row from stretching vertically to fill its parent's height with height: 100%, using height: \"auto\" instead. | false |\n| rowGap | 0...10 | A number or string magnitude for applying the pb Tachyons token to rows in the flex-layout.col. | undefined |\n| verticalAlign | top\\|middle|bottom | Controls vertical alignment for the items in the flex-layout.col. | top |\n| width | \"0...100%\"\\|\"grow\" | Sets the width of the column. Accepts either a percentage or \"grow\". | undefined |\n| arialabel | string | Aria-label to be included for accessibility purposes | undefined |\n\n## App behavior\n\n* The highest level in a flex layout is **always** a row. Therefore, you can only add a `flex-layout.col` inside a `flex-layout.row` — never as a first-level block.\n* Every row and column can have as **many levels as needed**.\n* When creating levels, you have to **alternate between rows and columns**. You can only place columns within a row and rows within a column.\n* Keep in mind that the structure that you set in your flex layout does not only affect your code organization, but will also reflect in the way that blocks will be shown and managed through the Site Editor admin. Therefore, it is always important to **take the organization of both code and Site Editor into account when planning to apply the flex layout** to a page.\n\nTo better understand Flex Layout's practical operation, you can access the recipe for [Using Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout)\n\n## Customization\n\nTo apply CSS customizations to this and other blocks, follow the instructions given in the recipe for [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).\n\n| CSS Handles |\n| -------------- |\n| flexColChild |\n| flexCol |\n| flexRowContent |\n| flexRow |\n\n[Disclosure Layout« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/apps/vtex.disclosure-layout)[Modal LayoutNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/apps/vtex.modal-layout)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/apps/vtex.flex-layout%23configuration)\n\n[flex-layout.row](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/apps/vtex.flex-layout%23flex-layoutrow)[flex-layout.col](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/apps/vtex.flex-layout%23flex-layoutcol)\n\n[App behavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/apps/vtex.flex-layout%23app-behavior)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout/docs/apps/vtex.flex-layout%23customization)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_c1c0838c
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides external marketplace integration recommendations in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-guide)\n\n[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-architecture)\n\n[Store setup for VTEX Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-vtex-seller-setup)\n\n[Creating an integration app from a Template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-app-template)\n\n[Catalog Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-catalog)\n\n[Catalog logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-logs)\n\n[Get product list for an initial load](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-product-load)\n\n[How to get a new product to offer in the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-new-products)\n\n[How to get product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-product-updates)\n\n[Product and Category Mappings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-catalog-mapping)\n\n[How to keep prices updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-price-update)\n\n[How to keep stock updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-stock-update)\n\n[Order Integration overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-recommendations)\n\n[New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-collect-orders)\n\n[Update Order Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-update-order-status)\n\n[How to validate if items are available for delivery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-delivery-validation)\n\n[Sending invoice and tracking code to the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-invoice-tracking)\n\n[How to update a canceled order’s status in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-canceled-orders)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-guide)\n\n[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-architecture)\n\n[Store setup for VTEX Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-vtex-seller-setup)\n\n[Creating an integration app from a Template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-app-template)\n\n[Catalog Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-catalog)\n\n[Catalog logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-logs)\n\n[Get product list for an initial load](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-product-load)\n\n[How to get a new product to offer in the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-new-products)\n\n[How to get product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-product-updates)\n\n[Product and Category Mappings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-catalog-mapping)\n\n[How to keep prices updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-price-update)\n\n[How to keep stock updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-stock-update)\n\n[Order Integration overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-recommendations)\n\n[New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-collect-orders)\n\n[Update Order Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-update-order-status)\n\n[How to validate if items are available for delivery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-delivery-validation)\n\n[Sending invoice and tracking code to the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-invoice-tracking)\n\n[How to update a canceled order’s status in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-canceled-orders)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides)\n\nIntegration Guides\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-guide)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations/docs/guides/external-marketplace-integration-recommendations)\n\nRecommendations\n\nTo avoid processing gaps due to the big volume of information of the initial load of products, we recommend:\n\n* Using an async messaging architecture, using individual queues by context and store.\n* Creating mechanisms that respect the marketplace API limit rates. We suggest the standard use of the _Circuit Breaker_ integration.\n* In case any of the steps listed above presents failures in communication, we suggest using the contingency mechanism of _deadLetters_.\n* Being TotalReader: whenever possible, in the data transformation process, using standard values accepted by the marketplace, in case the information is not filled or sent by VTEX.\n* In case the marketplace’s processing is in lots - meaning that the connector assembles a group of SKUs, guaranteeing the the limit of records per lot is respected, according to marketplace riles, and sending them to the marketplace at once - it is fundamental to control the lot’s processing, to avoid sending SKU updates without making sure that the product exists in the marketplace.\n* Keeping a states table to know which SKUs have not been integrated with success, attempt date and the response received. This allows the system to use the contingency flow effectively, avoiding infinite loops, and avoiding reaching the request limit.\n\nContributors\n\n1\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-marketplace-integration-guide/external-marketplace-integration-recommendations.md)\n\n[Order Integration overview« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations//docs/guides/external-marketplace-integration-orders)[New Order IntegrationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-recommendations//docs/guides/external-marketplace-integration-collect-orders)\n\nContributors\n\n1\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-marketplace-integration-guide/external-marketplace-integration-recommendations.md)\n\nCopy page\n\nOn this page\n\nOn this page\n\n[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=)"
}
] |
doc_3e70ee04
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides integration flow in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n[VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/vtex-shipping-network)\n\n[Getting started with VTEX IO for VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/getting-started-with-vtex-io-for-vtex-shipping-network)\n\n[Integration flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/integration-flow)\n\n[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/notification-1)\n\n[Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/tracking-1)\n\n[VTEX Shipping Network Labels Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/vtex-shipping-network-labels-integration)\n\n[VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/vtex-tracking)\n\n[VTEX Pick and Pack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/vtex-pick-and-pack)\n\n[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/multilevel-omnichannel-inventory)\n\n[Pickup point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/setting-up-white-label-seller-as-pickup-point)\n\n[Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/delivery-promise)\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n[VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/vtex-shipping-network)\n\n[Getting started with VTEX IO for VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/getting-started-with-vtex-io-for-vtex-shipping-network)\n\n[Integration flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/integration-flow)\n\n[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/notification-1)\n\n[Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/tracking-1)\n\n[VTEX Shipping Network Labels Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/vtex-shipping-network-labels-integration)\n\n[VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/vtex-tracking)\n\n[VTEX Pick and Pack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/vtex-pick-and-pack)\n\n[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/multilevel-omnichannel-inventory)\n\n[Pickup point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/setting-up-white-label-seller-as-pickup-point)\n\n[Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/delivery-promise)\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides)\n\nLogistics\n\n[VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/vtex-shipping-network)\n\n[Integration flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/integration-flow)\n\nIntegration flow\n\nThe typical cycle of an order shipped through a carrier that is integrated with VTEX goes through these stages:\n\n1. **Invoice**: a package starts its path in VTEX Shipping Network only after the order is invoiced.\n2. **Notification**: after the order has been invoiced, the VTEX hub notifies the carrier app. It informs the carrier that there is a package to be collected, specifying the details.\n3. **Shipping**: then, the store can print a shipping label with the appropriate shipping information and dispatch it to the carrier.\n4. **Tracking**: while the package is in transit, the carrier app sends tracking updates to the VTEX tracking hub, so that information can be made available to the store and customer.\n5. **Delivery**: finally, the package gets to the customer.\n\nSince the notification and tracking stages consist of exchanging information between the carrier and VTEX, these are the processes that should be handled by your apps.\n\nOne of the advantages of building IO apps is modularity, which allows for flexible customization of a store’s features. Because of that, we provide separate boilerplate repositories for [notification](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/carrier-hubs-examples/tree/main/carrier-notifier-example) and [tracking](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/carrier-hubs-examples/tree/main/carrier-tracking-example). You can develop one app to perform the two tasks or two separate apps for each of them.\n\nBoth apps should be able to read data that will be sent from VTEX in a specific format and respond with the appropriate information in a specific format. Below you can find out more about the particularities of each of those tasks.\n\n## Learn more\n\nSee this guide on [how to develop carrier apps on IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/getting-started-with-vtex-io-for-carriers). Also, learn more about [notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/notification-1) and [tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/tracking-1) for carrier apps.\n\nContributors\n\n1\n\n[](https://github.com/Isabella-Veloso)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Fulfillment/vtex-shipping-network/integration-flow.md)\n\n[Getting started with VTEX IO for VTEX Shipping Network« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow//docs/guides/getting-started-with-vtex-io-for-vtex-shipping-network)[NotificationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow//docs/guides/notification-1)\n\nContributors\n\n1\n\n[](https://github.com/Isabella-Veloso)\n\nON THIS PAGE\n\n[Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/integration-flow%23learn-more)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Fulfillment/vtex-shipping-network/integration-flow.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-flow/docs/guides/integration-flow%23learn-more)\n\nOn this page\n\n[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=)"
}
] |
doc_50bb4143
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX product customizer app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[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-customizer/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/troubleshooting)\n\n[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-customizer/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/guides/basic-components)\n\nProduct Customizer\n\nOfficial extension\n\nVersion: 2.12.4\n\nLatest version: 2.12.4\n\n[](#contributors-)\n\nThe Product Customizer component can be used on the Product Details Page (PDP) to display [attachments](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/o-que-e-um-anexo--aGICk0RVbqKg6GYmQcWUm) and/or a [subscription form](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-subscriptions-work--frequentlyAskedQuestions%5F4453).\n\nAn attachment is the optional and cost-free customization of a product.\n\n\n\n_Example of a PDP with the Product Customizer component displaying product attachments._ \n\nProduct subscriptions facilitate recurring sales by automatically scheduling the purchase of a specific product at the frequency requested by the customer.\n\n\n\n_Example of a PDP with the Product Customizer component displaying the product subscription._ \n\n## Before you start\n\n* If you plan to use the Product Customizer component to display **attachments**, make sure to [set up Assembly Options.](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH)\n* If you plan to use the Product Customizer component to display a **subscription form**, make sure to [set up Subscriptions.](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/setting-up-subscription-v2--1FA9dfE7vJqxBna9Nft5Sj) The Product Customizer integration with the Subscription module is native and will be automatically enabled when subscription settings are detected.\n\n## Configuring Product Customizer\n\n1. Add the `product-customizer` app to your theme dependencies in the `manifest.json`. For example:\n\n`1\n\n dependencies: { \n\n2\n\n+ \"vtex.product-customizer\": \"2.x\" \n\n3\n\n } \n\n`\n\n1. Add the `product-assembly-options` block as a child of the `store.product` template (PDP template). This is enough to enable the subscription form.\n\n`1\n\n \"store.product\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"flex-layout.row#product-breadcrumb\", \n\n4\n\n \"flex-layout.row#product-main\", \n\n5\n\n \"flex-layout.row#description\", \n\n6\n\n \"shelf.relatedProducts\", \n\n7\n\n \"product-reviews\", \n\n8\n\n \"product-questions-and-answers\", \n\n9\n\n+ \"product-assembly-options\" \n\n10\n\n ] \n\n11\n\n }, \n\n`\n\n1. Declare the [product-assembly-options props](#product-assembly-options-props) for your scenario.\n\n### Displaying attachments (optional)\n\n1. To display attachments of a product on the Product Detail Page (PDP), declare the `product-assembly-options` block and add the `assembly-option-input-values` block as its child.\n\n`1\n\n \"product-assembly-options\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"assembly-option-input-values\" \n\n4\n\n ] \n\n5\n\n }, \n\n`\n\n1. Use the blocks exported by the `product-customizer` app to create a solution that best suits your specific scenario.\n\n| Block name | Description |\n| ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |\n| assembly-option-item-image | Displays the attachment image. |\n| assembly-option-item-quantity-selector | Displays a quantity selector. |\n| assembly-option-item-name | Displays the attachment name. |\n| assembly-option-item-price | Displays the attachment price. |\n| assembly-option-item-customize | Displays the Customize button. When clicked, it opens a modal that allows customers to customize the attachment. |\n| assembly-option-item-children-description | Displays a summary with all selected attachments. |\n\n1. Declare the [props](#props) for the chosen blocks according to your scenario. For example:\n\n`1\n\n\"product-assembly-options\": { \n\n2\n\n \"props\":{ \n\n3\n\n \"initiallyOpened\": \"always\" \n\n4\n\n }, \n\n5\n\n \"children\": [ \n\n6\n\n \"flex-layout.row#product-assembly-options\", \n\n7\n\n \"assembly-option-input-values\" \n\n8\n\n ] \n\n9\n\n}, \n\n`\n\nWhile building your solution, note that you can receive inputs from three types of [attachments](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/adding-an-attachment?locale=en):\n\n* **Predefined options**: Predefined attachment options set in the `Permitted Values` field. Set up the `optionsDisplay` prop from the `assembly-option-input-values` block to define how these options are displayed.\n* **Free text**: Text input. Depending on the value set in the **Maximum Number of Characters** field in the attachment settings, shoppers may or may not have a character limit for this attachment.\n* **Boolean**: Boolean attachment options set in the `Permitted Values` field. Customers can select the attachment by clicking the checkbox.\n\nCheck the following example where the three attachment types are implemented:\n\n\n\nCheck out below how the product attachment displayed above was added to the Catalog:\n\n\n\nWhen an attachment is set as **required**, all attachment options are automatically made available to consumers. On the other hand, if an attachment is **not required**, the `Add customization` button is rendered, as shown in the example above. This gives shoppers the option to add or not an attachment to their product.\n\nAlso, keep in mind that the **Checkout** does not natively display the customized product option selected by the customer. To display the product in the Checkout with the selected attachments, it is necessary to customize the Checkout page, allowing it to read and render product information.\n\n## Props\n\n### `product-assembly-options` props\n\n| Prop name | Type | Description | Default value |\n| --------------- | ---- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| initiallyOpened | enum | Defines whether the customization box will be opened even if an attachment is not required (always) or if the customization box will be opened only if the attachment is required (required). | required |\n\n### `assembly-option-input-values` props\n\n| Prop name | Type | Description | Default value |\n| -------------- | ---- | ----------------------------------------------------------------------------------------------------------------------- | ------------- |\n| optionsDisplay | enum | Defines whether a checkbox (box) or a dropdown list (select) will be used to select the attachment pre-defined options. | select |\n\n### `assembly-option-item-customize`props\n\n| Prop name | Type | Description | Default value |\n| ----------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| buttonProps | object | Defines the behavior of the Customize button. In addition to the collapse prop, the buttonProps object can include child blocks to build the content of the modal triggered when the button is clicked. | undefined |\n\n* **`buttonProps` object:**\n\n| Prop name | Type | Description | Default value |\n| --------- | ---- | ----------------------------------------------------------------- | ------------- |\n| collapse | enum | Customize button positioning. Possible values are: left or right. | left |\n\n## Customization\n\nTo apply CSS customizations to this and other blocks, please see the [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) guide.\n\n| CSS handles |\n| ------------------------------------------- |\n| booleanInputValue |\n| inputValueOptionBox |\n| itemContainer |\n| modalViewDoneButton |\n| modalViewProductContainer |\n| modalViewProductImage |\n| modalViewProductInfos |\n| modalViewProductName |\n| multipleItemQuantitySelector |\n| optionsInputValue |\n| optionsInputValueDropdown |\n| optionsInputValueLabel |\n| optionsInputValueLabelContainer |\n| optionsInputValueOptionBoxContainer |\n| productAssemblyGroupName |\n| productAssemblyGroupNameRow |\n| productAssemblyGroupRequiredTag |\n| productAssemblyOptionItemCustomize |\n| productAssemblyOptionItemCustomize\\_\\_label |\n| productAssemblyOptionItemImage |\n| productAssemblyOptionItemName |\n| textInputValue |\n\n[Order Placed« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.order-placed)[Product HighlightsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-highlights)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Before you start](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-customizer%23before-you-start)\n\n[Configuring Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-customizer%23configuring-product-customizer)\n\n[Displaying attachments (optional)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-customizer%23displaying-attachments-optional)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-customizer%23props)\n\n[product-assembly-options props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-customizer%23product-assembly-options-props)[assembly-option-input-values props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-customizer%23assembly-option-input-values-props)[assembly-option-item-customizeprops](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-customizer%23assembly-option-item-customizeprops)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-customizer/docs/apps/vtex.product-customizer%23customization)\n\nWas this helpful?\n\n[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=)"
}
] |
doc_db85273a
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore atoms textarea in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-overview)\n\n[Badge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-badge)\n\n[Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-button)\n\n[Checkbox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-checkbox)\n\n[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-icon)\n\n[Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-input)\n\n[Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-label)\n\n[Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-link)\n\n[List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-list)\n\n[Loader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-loader)\n\n[Overlay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-overlay)\n\n[Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-price)\n\n[Radio](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-radio)\n\n[Select](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-select)\n\n[SROnly](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-sr-only)\n\n[Skeleton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-skeleton)\n\n[Slider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-slider)\n\n[Textarea](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-textarea)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-overview)\n\n[Badge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-badge)\n\n[Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-button)\n\n[Checkbox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-checkbox)\n\n[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-icon)\n\n[Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-input)\n\n[Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-label)\n\n[Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-link)\n\n[List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-list)\n\n[Loader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-loader)\n\n[Overlay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-overlay)\n\n[Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-price)\n\n[Radio](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-radio)\n\n[Select](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-select)\n\n[SROnly](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-sr-only)\n\n[Skeleton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-skeleton)\n\n[Slider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-slider)\n\n[Textarea](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-textarea)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-overview)\n\nTextarea\n\nMulti-line fields to get long user inputs.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/atoms/Textarea)\n\nThe `Textarea` component allows users to enter multi-line text. It is commonly used for longer inputs such as comments, messages, or descriptions.\n\nExample\n\nCode\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { Textarea } from \"@faststore/ui\"; \n\n`\n\n### Import styles\n\nTo apply styles, include the following in your stylesheet:\n\n`1\n\n@import \"@faststore/ui/src/components/atoms/Textarea/styles.scss\"; \n\n`\n\nFor details, see [Importing FastStore UI component styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles).\n\n---\n\n## Examples\n\n### Resize\n\n#### Vertical\n\nExample\n\nCode\n\n#### Horizontal\n\nExample\n\nCode\n\n#### Both (default)\n\nExample\n\nCode\n\n### Disabled\n\nExample\n\nCode\n\n---\n\n## Design tokens\n\n| Local token | Default value/Global token linked |\n| ---------------------------------- | ---------------------------------------------------------- |\n| \\--fs-textarea-padding | var(--fs-spacing-1) var(--fs-spacing-2) |\n| \\--fs-textarea-height | calc(var(--fs-control-tap-size) \\* 3) |\n| \\--fs-textarea-bkg-color | var(--fs-color-body-bkg) |\n| \\--fs-textarea-box-shadow | none |\n| \\--fs-textarea-box-shadow-hover | 0 0 0 var(--fs-border-width) var(--fs-border-color-active) |\n| \\--fs-textarea-border-radius | var(--fs-border-radius) |\n| \\--fs-textarea-border-width | var(--fs-border-width) |\n| \\--fs-textarea-border-color | var(--fs-border-color) |\n| \\--fs-textarea-border-color-hover | var(--fs-border-color-active) |\n| \\--fs-textarea-text-color | var(--fs-color-text) |\n| \\--fs-textarea-text-size | var(--fs-text-size-body) |\n| \\--fs-textarea-line-height | 1.25 |\n| \\--fs-textarea-transition-function | var(--fs-transition-function) |\n| \\--fs-textarea-transition-property | var(--fs-transition-property) |\n| \\--fs-textarea-transition-timing | var(--fs-transition-timing) |\n\n### Design tokens: Disabled\n\nDisabled textareas reduce contrast and remove interactive indicators to show a non-editable state, while maintaining layout stability and keeping content readable.\n\n| Local token | Default value/Global token linked |\n| ------------------------------------ | --------------------------------- |\n| \\--fs-textarea-disabled-bkg-color | var(--fs-color-disabled-bkg) |\n| \\--fs-textarea-disabled-border-width | var(--fs-border-width) |\n| \\--fs-textarea-disabled-text-color | var(--fs-color-disabled-text) |\n| \\--fs-textarea-disabled-border-color | var(--fs-border-color) |\n\n---\n\n## Data attributes\n\nYou can target and override `Textarea` styles using the following data attributes:\n\n`data-fs-textarea`\n\n`data-fs-textarea-resize`\n\n---\n\n## Props\n\n| Name | Type | Description | Default | | |\n| ---------- | -------------------- | -------------------------------------------------------------------------------------- | ----------- | -------------------------------------------------------------------------------------------------------- | ---- |\n| **testId** | string | ID to find this component in testing tools (e.g.: cypress, testing library, and jest). | fs-textarea | | |\n| **resize** | \"none\" \\| \"vertical\" | \"horizontal\" | \"both\" | Controls the resize property of the textare (e.g.: none, vertical, horizontal, both). Default is 'both'. | both |\n\n---\n\n## Best practices\n\n### ✅ Do's\n\n* Provide a [Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label) to help users understand the purpose of the form control.\n* Ensure each `Textarea` has an associated `id` that matches the `for` attribute of its label.\n* Use placeholders only for examples or hints, not as replacements for labels.\n* Set a height that shows multiple lines without requiring immediate resizing.\n* Add validation messages when specific input formats or lengths are required.\n* Make disabled or error states visually clear and accessible to screen readers.\n\n### ❌ Don'ts\n\n* Don't overuse resizing. If resizing is enabled, ensure it doesn't break the layout or cause accessibility issues.\n* Don't use `Textarea` for short inputs. For single-line or brief text, such as names or emails, use the [Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input) component.\n\n---\n\n## Related components\n\n* Label \nTextareaField \nTextareaField wraps a Textarea and its corresponding Label. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/molecules-textarea-field)\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/barbara-celi)\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/atoms/textarea.mdx)\n\n[Slider« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-slider)[MoleculesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/molecules-overview)\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/barbara-celi)\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-textarea%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-textarea%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-textarea%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-textarea%23examples)\n\n[Resize](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-textarea%23resize)[Disabled](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-textarea%23disabled)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-textarea%23design-tokens)\n\n[Design tokens: Disabled](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-textarea%23design-tokens-disabled)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-textarea%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-textarea%23props)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-textarea%23best-practices)\n\n[✅ Do's](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-textarea%23-dos)[❌ Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-textarea%23-donts)\n\n[Related components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-textarea%23related-components)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/atoms/textarea.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-textarea%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-textarea%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-textarea%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-textarea%23examples)\n\n[Resize](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-textarea%23resize)[Disabled](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-textarea%23disabled)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-textarea%23design-tokens)\n\n[Design tokens: Disabled](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-textarea%23design-tokens-disabled)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-textarea%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-textarea%23props)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-textarea%23best-practices)\n\n[✅ Do's](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-textarea%23-dos)[❌ Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-textarea%23-donts)\n\n[Related components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea/docs/guides/faststore/atoms-textarea%23related-components)\n\nOn this page\n\n[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=)"
}
] |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.