id
stringlengths 12
53
| messages
listlengths 3
3
|
|---|---|
doc_08bb2fe6
|
[
{
"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 icons 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-icons/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-icons/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-icons/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-icons/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-icons/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-icons/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-icons/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-icons/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-icons/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/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-icons/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/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-icons/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/styling-overview)\n\n[Themes reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/themes-overview)\n\n[Global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/global-tokens-overview)\n\n[Iconography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/styling-icons)\n\n[Using themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/using-themes-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/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-icons/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-icons/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-icons/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-icons/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/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-icons/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-icons/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/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-icons/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-icons/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/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-icons/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/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-icons/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/styling-overview)\n\n[Themes reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/themes-overview)\n\n[Global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/global-tokens-overview)\n\n[Iconography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/styling-icons)\n\n[Using themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/using-themes-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/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-icons/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-icons/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-icons/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-icons/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/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-icons/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-icons/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-icons/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/styling-overview)\n\nIconography\n\nThis set of icons uses SVGs from Phosphor icons.\n\nIcons help build web pages by illustrating concepts and improving website navigation.FastStore offers a set of icons that our components use, and you can also use them on your application. This set of icons uses SVGs from [Phosphor icons](https://read.calvincode.net/reader?url=https://phosphoricons.com/).\n\n---\n\n## Import\n\nImport the component from [@faststore/ui](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index)\n\n`1\n\nimport { Icon } from '@faststore/ui' \n\n`\n\nYou can find more details about the `Icon` component [here](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon).\n\n## Usage\n\n`1\n\n<Icon name=\"X\" weight=\"bold\" /> \n\n2\n\n<Icon name=\"MagnifyingGlass\" weight=\"regular\" /> \n\n3\n\n<Icon name=\"House\" weight=\"thin\" /> \n\n`\n\n`1\n\n<Icon name=\"X\" weight=\"bold\" width={16} height={16} /> \n\n2\n\n<Icon name=\"MagnifyingGlass\" weight=\"regular\" width={20} height={20} /> \n\n3\n\n<Icon name=\"House\" weight=\"thin\" width={32} height={32} /> \n\n`\n\n---\n\n### UI Actions\n\n* X\n* Plus\n* PlusCircle\n* Minus\n* MinusCircle\n* XCircle\n* ArrowLeft\n* ArrowRight\n* ArrowElbowDownRight\n* CaretDown\n* CaretRight\n* CaretLeft\n* CaretUp\n* Checked\n* MagnifyingGlass\n* FadersHorizontal\n\n### Payment Flags\n\n* Visa\n* Amex\n* ApplePay\n* EloCard\n* Diners\n* GooglePay\n* Mastercard\n* PayPal\n* Pix\n* Stripe\n* GooglePay\n* ApplePay\n* Visa\n\n### Social\n\n* Facebook\n* Instagram\n* Twitter\n* Pinterest\n\n### Others\n\n* House\n* Star\n* Heart\n* DotsThree\n* Ruler\n* ShoppingCart\n* Tag\n* BellRinging\n* Bell\n* MapPin\n* ArrowSquareOut\n* Envelop\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/icons.mdx)\n\n[Typography« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/global-tokens-typography)[Using themesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/using-themes-overview)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Import](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/styling-icons%23import)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/styling-icons%23usage)\n\n[UI Actions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/styling-icons%23ui-actions)[Payment Flags](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/styling-icons%23payment-flags)[Social](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/styling-icons%23social)[Others](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/styling-icons%23others)\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/icons.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Import](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/styling-icons%23import)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/styling-icons%23usage)\n\n[UI Actions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/styling-icons%23ui-actions)[Payment Flags](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/styling-icons%23payment-flags)[Social](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/styling-icons%23social)[Others](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/styling-icons/docs/guides/faststore/styling-icons%23others)\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_d1e16612
|
[
{
"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 my account commons 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.my-account-commons/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/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.my-account-commons/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.my-account-commons/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.my-account-commons/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.my-account-commons/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.my-account-commons/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/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.my-account-commons/docs/apps/vtex.my-account)\n\n[My Account Commons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/apps/vtex.my-account-commons)\n\n[My Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/apps/vtex.my-authentication)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/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.my-account-commons/docs/apps/vtex.my-account)\n\n[My Account Commons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/apps/vtex.my-account-commons)\n\n[My Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/apps/vtex.my-authentication)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/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.my-account-commons/docs/vtex-io-apps)\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/apps/vtex.my-account)\n\nMy Account Commons\n\nOfficial extension\n\nVersion: 1.7.2\n\nLatest version: 1.7.2\n\nMy Account Commons is a bundle of canonical components that can be used to create new tabs to be inserted on the `vtex.my-account` app.\n\nDISCLAIMER: In order to this components work, they need to be children of `vtex.my-account` app.\n\nTo import it into your code:\n\n`1\n\nimport { \n\n2\n\n ContentWrapper, \n\n3\n\n BaseLoading, \n\n4\n\n GenericError, \n\n5\n\n} from 'vtex.my-account-commons' \n\n`\n\n## Usages\n\n### ContentWrapper\n\nYou can use it in your code like a React component with the jsx tag: `<ContentWrapper>`.\n\n`` 1\n\n<ContentWrapper \n\n2\n\n namespace=\"my-custom-page\" \n\n3\n\n title={`$\\{orderTitle\\} $\\{orderNumber\\}`} \n\n4\n\n backButton={backButton}> \n\n5\n\n {({ handleError }) => children} \n\n6\n\n</ContentWrapper> \n\n ``\n\n| Prop name | Type | Description |\n| ------------------ | ------- | ---------------------------------------------------------------------------- |\n| title | String | The string that will appear on the page title. |\n| titleId | String | Intl message id that will be translated and inserted on the page title. |\n| backbutton.title | String | The string that will appear as a message on the backbutton. |\n| backbutton.titleId | String | Intl message id that will be translated and inserted as the go back message. |\n| backbutton.path | String! | Location which the user will be lead to when hit the backbutton. |\n| headerContent | node | JSX that wil be inserted as children of the vtex.style-guide/PageHeader. |\n| namespace | String! | Css namespace that will be added to the page body. |\n\nThe `ContentWrapper` uses the render prop pattern and returns to its children an object with the following props:\n\n#### Render prop\n\n| Prop name | Type | Description |\n| ---------- | -------- | ----------------------------------------------------------------------- |\n| handlError | Function | Function that will be called when the user dismisses the error message. |\n\n### BaseLoading\n\nThis component should be used to implement your own Loader, it analyses the result of a graphql query and displays the loader Skeleton or an error message if any error occurs with retry option to call refetch on the query.\n\n`1\n\n<BaseLoading queryData={data} headerConfig={object}> \n\n2\n\n {children} \n\n3\n\n</BaseLoading> \n\n`\n\n| Prop name | Type | Description |\n| ------------ | ------------- | ------------------------------------------------------------------------------------------------------------- |\n| queryData | QueryResult | Apollo Graphql query result. |\n| headerConfig | ContentWProps | The props that will be passed to the ContentWrapper. |\n| nameSpace | String | The name space prop that will be passed to the ContentWrapper. vtex-base-loading is applied if none is passed |\n| parseError | Function | Function that parses the graphql error and returns a messageId. |\n\n### GenericError\n\nA wrapper for the `vtex.styleguide/Alert` component.\n\n`1\n\n<GenericError onDismiss={handleError} errorId={error} /> \n\n`\n\n| Prop name | Type | Description |\n| --------- | -------- | ------------------------------------------------------------------ |\n| error | String | The error message that will be displayed on the Alert. |\n| errorId | String | Intl message id that will be translated and inserted on the Alert. |\n| onDismiss | Function | Function that will be called when the user hits the close button. |\n\n### Disclaimer about react/Router.js file\n\nRead carefully the instructions within the file before editing it.\n\n[My Account - StoreV2 version« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/apps/vtex.my-account)[My AuthenticationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/apps/vtex.my-authentication)\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[Usages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/apps/vtex.my-account-commons%23usages)\n\n[ContentWrapper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/apps/vtex.my-account-commons%23contentwrapper)[BaseLoading](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/apps/vtex.my-account-commons%23baseloading)[GenericError](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/apps/vtex.my-account-commons%23genericerror)[Disclaimer about react/Router.js file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-account-commons/docs/apps/vtex.my-account-commons%23disclaimer-about-reactrouterjs-file)\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_26237281
|
[
{
"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 b2b 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/b2b-components/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-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/b2b-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/b2b-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/b2b-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/b2b-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/b2b-components/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/guides/b2b-components)\n\n[Order Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/apps/vtex.order-configuration)\n\n[Quickorder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/apps/vtex.quickorder)\n\n[SKU List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/apps/vtex.sku-list)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/guides/b2b-components)\n\n[Order Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/apps/vtex.order-configuration)\n\n[Quickorder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/apps/vtex.quickorder)\n\n[SKU List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/apps/vtex.sku-list)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/vtex-io-apps)\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/guides/guides/b2b-components)\n\nB2B components\n\n[Challenge Trade Policy ConditionThis app checks if a user can access the current trade policy based on a specified condition ruleSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/apps/vtex.challenge-tp-condition)[Order ConfigurationDesigned for B2B scenarios, the Order Configuration app displays a form for collecting order data in a modalSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/apps/vtex.order-configuration)[Order QuoteProvides B2B features to save a cart (its items, quantities, and price) for further useSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/apps/vtex.orderquote)[QuickorderDesigned for B2B scenarios, it allows users to add multiple products to the cart at onceSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/apps/vtex.quickorder)[SKU ListThe SKU List app is an essential B2B feature for rendering a SKU list on the product details pageSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components/docs/apps/vtex.sku-list)\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/b2b-components.md)\n\n[Shipping Option Components« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components//docs/apps/vtex.shipping-option-components)[Order ConfigurationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/b2b-components//docs/apps/vtex.order-configuration)\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/Store-Framework-Apps/b2b-components.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_594559ed
|
[
{
"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 gift 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-gift/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-gift/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-gift/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-gift/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-gift/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-gift/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-gift/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-gift/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-gift/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/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-gift/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/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-gift/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/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-gift/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-gift/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-gift/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-gift/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/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-gift/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-gift/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/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-gift/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-gift/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/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-gift/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/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-gift/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/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-gift/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-gift/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-gift/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-gift/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/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-gift/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-gift/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-gift/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/components-index)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-overview)\n\nGift\n\nDisplays an additional item to purchase as a gift.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/Gift)\n\nThe `Gift` component is a compound of the following:\n\n* `Gift`: renders a `<div>` as wrapper with an `Icon`, `GiftImage`, and `GiftContent`.\n* `GiftImage`: renders a `<div>` as wrapper with an `Image`.\n* `GiftContent`: renders a `<div>` as wrapper with the gift information as children.\n\nExample\n\nCode\n\n\n\n### Get a Apple Magic Mouse\n\nOriginal price:$999\n\nFree\n\n\n\n### Get a Apple Magic Mouse\n\nOriginal price:$999\n\nFree\n\n\n\n### Get a Apple Magic Mouse\n\nOriginal price:$999\n\nFree\n\n\n\n### Get a Apple Magic Mouse\n\nOriginal price:$999\n\nFree\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { Gift, GiftImage, GiftContent } 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/Gift/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-gift-height | var(--fs-spacing-12) |\n| \\--fs-gift-bkg-color | var(--fs-control-bkg) |\n| \\--fs-gift-border-width | var(--fs-border-width) |\n| \\--fs-gift-border-color | var(--fs-border-color-light) |\n| \\--fs-gift-border-radius | var(--fs-border-radius) |\n\n---\n\n### Content\n\n| Local token | Default value/Global token linked |\n| -------------------------- | ---------------------------------------------------------- |\n| \\--fs-gift-content-padding | var(--fs-gift-gap) var(--fs-gift-gap) var(--fs-gift-gap) 0 |\n| \\--fs-gift-content-row-gap | var(--fs-spacing-0) |\n\n### Title\n\n| Local token | Default value/Global token linked |\n| ---------------------------- | --------------------------------- |\n| \\--fs-gift-title-line-height | 1.25 |\n| \\--fs-gift-title-size | var(--fs-text-size-body) |\n| \\--fs-gift-title-color | var(--fs-color-text) |\n\n### Icon\n\n| Local token | Default value/Global token linked |\n| ------------------------- | --------------------------------- |\n| \\--fs-gift-icon-size | 1.75rem |\n| \\--fs-gift-icon-padding | var(--fs-spacing-0) |\n| \\--fs-gift-icon-color | var(--fs-gift-title-color) |\n| \\--fs-gift-icon-bkg-color | var(--fs-color-body-bkg) |\n\n### Price\n\n| Local token | Default value/Global token linked |\n| --------------------- | --------------------------------- |\n| \\--fs-gift-price-size | var(--fs-text-size-legend) |\n\n---\n\n## Data attributes\n\nYou can target and override `Gift` styles using the following data attributes:\n\n`data-fs-gift`\n\n`data-fs-gift-icon`\n\n`data-fs-gift-wrapper`\n\n`data-fs-gift-image`\n\n`data-fs-gift-content`\n\n`data-fs-gift-product-title`\n\n`data-fs-gift-product-summary`\n\n---\n\n## Props\n\nAll gift-related components support all attributes also supported by the `<div>` tag.\n\nBesides those attributes, the following props are also supported:\n\n### Gift\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-gift | | | | | | |\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\n### GiftContent\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-gift-content |\n| **productName\\*** | string | Specifies the product's name. | |\n| **price\\*** | PriceDefinition | Specifies product's prices. | |\n| **badgeLabel** | string | Badge's label | Free |\n| **titleMessage** | string | Additional message in the title | Get a |\n\n### GiftImage\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-gift-image |\n\n### Other Resources\n\n#### PriceDefinition\n\n| Name | Type | Description | Default |\n| ------------- | -------------- | --------------------------------------------------- | ------- |\n| **value** | number | The raw price value. | |\n| **listPrice** | number | Product's list price | |\n| **formatter** | PriceFormatter | (price: number, variant: PriceVariant) => ReactNode | |\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/molecules/gift.mdx)\n\n[Dropdown« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-dropdown)[IconButtonNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-icon-button)\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/molecules-gift/docs/guides/faststore/molecules-gift%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-gift%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-gift%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-gift%23design-tokens)\n\n[Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-gift%23content)[Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-gift%23title)[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-gift%23icon)[Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-gift%23price)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-gift%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-gift%23props)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-gift%23gift)[GiftContent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-gift%23giftcontent)[GiftImage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-gift%23giftimage)[Other Resources](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-gift%23other-resources)\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/gift.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-gift/docs/guides/faststore/molecules-gift%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-gift%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-gift%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-gift%23design-tokens)\n\n[Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-gift%23content)[Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-gift%23title)[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-gift%23icon)[Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-gift%23price)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-gift%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-gift%23props)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-gift%23gift)[GiftContent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-gift%23giftcontent)[GiftImage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-gift%23giftimage)[Other Resources](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-gift/docs/guides/faststore/molecules-gift%23other-resources)\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_af8ce418
|
[
{
"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 multi language stores 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-multi-language-stores/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-multi-language-stores/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-multi-language-stores/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-multi-language-stores/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-multi-language-stores/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-multi-language-stores/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-multi-language-stores/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-multi-language-stores/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-multi-language-stores/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/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-multi-language-stores/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-multi-language-stores/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/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-multi-language-stores/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-multi-language-stores/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-multi-language-stores/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/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-multi-language-stores/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-multi-language-stores/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-multi-language-stores/docs/guides/vtex-io-multi-language-stores)\n\n[Internationalizing product prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/guides/vtex-io-documentation-internationalizing-product-prices)\n\n[Disabling automatic translation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/guides/vtex-io-documentation-disabling-automatic-translation)\n\n[Translating storefront content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/guides/storefront-content-internationalization)\n\n[Translating Catalog content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/guides/catalog-internationalization)\n\n[Overwriting the Messages app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/guides/vtex-io-documentation-overwriting-the-messages-app)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/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-multi-language-stores/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-multi-language-stores/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-multi-language-stores/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-multi-language-stores/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/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-multi-language-stores/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-multi-language-stores/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/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-multi-language-stores/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-multi-language-stores/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/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-multi-language-stores/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-multi-language-stores/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-multi-language-stores/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/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-multi-language-stores/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-multi-language-stores/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-multi-language-stores/docs/guides/vtex-io-multi-language-stores)\n\n[Internationalizing product prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/guides/vtex-io-documentation-internationalizing-product-prices)\n\n[Disabling automatic translation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/guides/vtex-io-documentation-disabling-automatic-translation)\n\n[Translating storefront content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/guides/storefront-content-internationalization)\n\n[Translating Catalog content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/guides/catalog-internationalization)\n\n[Overwriting the Messages app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/guides/vtex-io-documentation-overwriting-the-messages-app)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/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-multi-language-stores/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-multi-language-stores/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-multi-language-stores/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-multi-language-stores/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-multi-language-stores/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/guides/store-framework)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/guides/vtex-io-multi-language-stores)\n\nInternationalization\n\nGet to know the internationalization process for creating a multi-language ecommerce store using Store Framework.\n\nThis document outlines the internationalization process for creating a multi-language ecommerce store using Store Framework. Internationalization is crucial for reaching global markets and providing a seamless shopping experience for customers from different locales. This guide covers how Store Framework handles internationalization for both storefront content and catalog data, highlighting the tools and libraries used for translations.\n\n## Before you begin\n\nBefore delving into the internationalization process, it's essential to understand the distinction between frontend app messages and catalog data. In general, **storefront content** can be sourced from either **frontend React apps** or the **[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23overview)**. More precisely, app messages are translatable strings defined within a frontend app, while catalog messages comprise external data from the Catalog API. Therefore, it is crucial to consider these differences when translating storefront content, as internationalization is handled differently for each case.\n\n## Frontend app messages\n\nA Store Framework storefront consists of multiple frontend apps built with VTEX IO and React. For translations, Store Framework uses the [react-intl](https://read.calvincode.net/reader?url=https://www.npmjs.com/package/react-intl) library and the VTEX IO Messages app.\n\nMoreover, developers can designate text components as translatable messages when developing a frontend app using the `<Formatted*>` component from the `react-intl` library. This enables translatable messages to be automatically translated by an automatic translation service based on the user's locale.\n\n### Automatic translations\n\nBy leveraging the automatic translation service, the Messages app can automatically translate frontend app messages according to the user's locale. The user's current locale and the translated messages, obtained from the automatic translation system, become accessible at the root of the component tree and available to each component.\n\nHowever, automatic translations may not always be culturally accurate. To address this, the Messages app provides functionalities to manage custom translations. If preferred, it is also possible to [disable the automatic translation service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-disabling-automatic-translation).\n\n### Customizing automatic translations\n\nTo address potential cultural inaccuracies in automatic translations, the Messages app provides functionalities to manage custom translations. Developers can overwrite an automatic translation with more specific or representative content for their store, such as providing a special login message for Spanish-speaking users from Argentina.\n\nCustom translations can be implemented at either the app or account level:\n\n* **App-level translations**: Developers can set personalized translations for each locale within the frontend app's `/messages` folder. These translations are applied, by default, to any store using the app. To learn how to set messages during the development of a React app, please follow this [guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component).\n* **Account-level translations**: Developers can overwrite a message imported from a frontend app with a completely customized message making the appropriate GraphQL API request to the Messages app. To learn how to overwrite a message from a frontend app, please follow this [guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization).\n\n> The Messages app is a standalone translation application and should not be confused with a string repository. It requires providing a source language, source content, and destination language. The output will be the translation of the source content from the source language to the destination language.\n\n### Translation decision flow\n\nWhen translating a message, the Messages app follows a specific decision flow:\n\n1. Check for custom account-level translations.\n2. If no custom definitions are found, it checks for frontend app translations in the app's `/messages` folder.\n3. If a specific translation is still not found, the Messages app falls back to the automatic translation service.\n\nMessagesMessages APIFrontend appTranslation servicealt\\[Frontend app translations found\\]\\[No frontend app translations found\\]alt\\[Account-level translations found\\]\\[No account-level translations found\\]Checks for account-level translationsReturns account-level translationsChecks for frontend app translations in the messages folderReturns frontend app translationRequests automatic translationReturns automatic translationMessagesMessages APIFrontend appTranslation service\n\nAs translating an app to every language can be daunting, it is recommended to structure precise translations for the target audience and rely on automatic translation for other languages.\n\nNote that after detecting a user locale, every message from your frontend component set as translatable will be automatically translated either by the automatic translation service, the frontend app's messages, or custom content personalized through a GraphQL mutation at the account level.\n\n## Catalog data\n\nSo far, we've discussed app messages, which are text messages exported from a frontend app. However, we must also consider catalog messages, which include messages related to a product name or product description from the store catalog.\n\nEvery data from the Catalog API is already set as translatable. Therefore, it is possible to overwrite an automatic catalog translation by sending the appropriate GraphQL query either to the Catalog API or to the Messages app.\n\nTo learn how to overwrite a catalog message via the Catalog API, please follow this [guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-internationalization).\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/vtex-io-multi-language-stores.md)\n\n[Indicating alternate versions of localized pages in cross border stores« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores//docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores)[Internationalizing product pricesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores//docs/guides/vtex-io-documentation-internationalizing-product-prices)\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-multi-language-stores/docs/guides/vtex-io-multi-language-stores%23before-you-begin)\n\n[Frontend app messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/guides/vtex-io-multi-language-stores%23frontend-app-messages)\n\n[Automatic translations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/guides/vtex-io-multi-language-stores%23automatic-translations)[Customizing automatic translations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/guides/vtex-io-multi-language-stores%23customizing-automatic-translations)[Translation decision flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/guides/vtex-io-multi-language-stores%23translation-decision-flow)\n\n[Catalog data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/guides/vtex-io-multi-language-stores%23catalog-data)\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/vtex-io-multi-language-stores.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-multi-language-stores/docs/guides/vtex-io-multi-language-stores%23before-you-begin)\n\n[Frontend app messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/guides/vtex-io-multi-language-stores%23frontend-app-messages)\n\n[Automatic translations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/guides/vtex-io-multi-language-stores%23automatic-translations)[Customizing automatic translations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/guides/vtex-io-multi-language-stores%23customizing-automatic-translations)[Translation decision flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/guides/vtex-io-multi-language-stores%23translation-decision-flow)\n\n[Catalog data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores/docs/guides/vtex-io-multi-language-stores%23catalog-data)\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_31132e2c
|
[
{
"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 shelf 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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-shelf/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-shelf/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-shelf/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-shelf/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-shelf/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-shelf/docs/guides/store-framework-using-components)\n\n[Building a Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-shelf/docs/guides/vtex-io-documentation-building-a-shelf)\n\nBuilding a Shelf\n\nThe Shelf component is a product list that helps you to build your own shop window and work on your store's visual merchandising.\n\n\n\nTo create a product list, you can configure the Shelf component to use the [Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarylist), the [Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary), and the [Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout) blocks.\n\n> Refer to the [**Product Summary**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary) and [**Slider-Layout**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout) documentation to explore the available props for configuring their behavior. Use this information to adjust the Shelf behavior accordingly.\n\nCheck out the instructions below for how it can be done.\n\n## Instructions\n\n1. Add the `product-summary` and the `slider-layout` apps to your theme's dependencies in the `manifest.json` file:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.product-summary\": \"2.x\", \n\n3\n\n \"vtex.slider-layout\": \"0.x\" \n\n4\n\n } \n\n`\n\n1. Add the `list-context.product-list` into your `store.home` theme template and add in its blocks list the `product-summary.shelf` block. Also, add as its children the `slider-layout` block. For example:\n\n`1\n\n{ \n\n2\n\n \"product-summary.shelf#demo1\": { \n\n3\n\n \"children\": [ \n\n4\n\n \"stack-layout#prodsum\", \n\n5\n\n \"product-summary-name\", \n\n6\n\n \"product-rating-inline\", \n\n7\n\n \"product-summary-space\", \n\n8\n\n \"product-summary-price\", \n\n9\n\n \"product-summary-buy-button\" \n\n10\n\n ] \n\n11\n\n }, \n\n12\n\n \"list-context.product-list#demo1\": { \n\n13\n\n \"blocks\": [\"product-summary.shelf#demo1\"], \n\n14\n\n \"children\": [\"slider-layout#demo-products\"] \n\n15\n\n } \n\n16\n\n} \n\n`\n\n1. Declare the `product-summary.shelf` block and add the desired blocks as children, as shown in the example below. If you have any questions about structuring the block, check its [documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary).\n\n`1\n\n{ \n\n2\n\n \"list-context.product-list#demo1\": { \n\n3\n\n \"blocks\": [\"product-summary.shelf#demo1\"], \n\n4\n\n \"children\": [\"slider-layout#demo-products\"] \n\n5\n\n \n6\n\n }, \n\n7\n\n \n8\n\n+ \"product-summary.shelf#demo1\": { \n\n9\n\n+ \"children\": [ \n\n10\n\n+ \"product-summary-name\", \n\n11\n\n+ \"product-summary-description\", \n\n12\n\n+ \"product-summary-image\", \n\n13\n\n+ \"product-summary-price\", \n\n14\n\n+ \"product-summary-sku-selector\", \n\n15\n\n+ \"product-summary-buy-button\" \n\n16\n\n+ ] \n\n17\n\n+ } \n\n18\n\n} \n\n`\n\n1. Declare the `slider-layout` block, adding as desired child blocks and props. If you have any questions about structuring the block, check its [documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout).\n\n`1\n\n{ \n\n2\n\n \"list-context.product-list#demo1\": { \n\n3\n\n \"blocks\": [\"product-summary.shelf#demo1\"], \n\n4\n\n \"children\": [\"slider-layout#demo-products\"] \n\n5\n\n \n6\n\n }, \n\n7\n\n \n8\n\n \"product-summary.shelf#demo1\": { \n\n9\n\n \"children\": [ \n\n10\n\n \"product-summary-name\", \n\n11\n\n \"product-summary-description\", \n\n12\n\n \"product-summary-image\", \n\n13\n\n \"product-summary-price\", \n\n14\n\n \"product-summary-sku-selector\", \n\n15\n\n \"product-summary-buy-button\" \n\n16\n\n ] \n\n17\n\n }, \n\n18\n\n \n19\n\n+ \"slider-layout#demo-products\": { \n\n20\n\n+ \"props\": { \n\n21\n\n+ \"itemsPerPage\": { \n\n22\n\n+ \"desktop\": 1, \n\n23\n\n+ \"tablet\": 1, \n\n24\n\n+ \"phone\": 1 \n\n25\n\n+ }, \n\n26\n\n+ \"infinite\": true, \n\n27\n\n+ \"showNavigationArrows\": \"desktopOnly\", \n\n28\n\n+ \"blockClass\": \"carousel\" \n\n29\n\n+ }, \n\n30\n\n+ \"children\": [\"rich-text#1\", \"rich-text#2\", \"rich-text#3\"] \n\n31\n\n+ }, \n\n32\n\n} \n\n`\n\nAfter the last step, you now have a functioning Shelf for your store.\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/Storefront-Guides/concepts-1/vtex-io-documentation-building-a-shelf.md)\n\n[Building a horizontal Product Summary« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-shelf//docs/guides/vtex-io-documentation-building-a-horizontal-product-summary)[Configuring custom images for the SKU SelectorNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-shelf//docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-shelf/docs/guides/vtex-io-documentation-building-a-shelf%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-shelf.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-shelf/docs/guides/vtex-io-documentation-building-a-shelf%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_981f549b
|
[
{
"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 webops configuring production and preview branches 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/webops-configuring-production-and-preview-branches/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/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/webops-configuring-production-and-preview-branches/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/webops-configuring-production-and-preview-branches/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/webops-configuring-production-and-preview-branches/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/webops-configuring-production-and-preview-branches/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/webops-configuring-production-and-preview-branches/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/webops-configuring-production-and-preview-branches/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/webops-configuring-production-and-preview-branches/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/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/webops-configuring-production-and-preview-branches/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/webops-dashboard)\n\n[Configuring production and preview branches in WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/webops-configuring-production-and-preview-branches)\n\n[Managing Secrets](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/webops-managing-secrets)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/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/webops-configuring-production-and-preview-branches/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/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/webops-configuring-production-and-preview-branches/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/webops-configuring-production-and-preview-branches/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/webops-configuring-production-and-preview-branches/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/webops-configuring-production-and-preview-branches/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/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/webops-configuring-production-and-preview-branches/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/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/webops-configuring-production-and-preview-branches/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/webops-configuring-production-and-preview-branches/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/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/webops-configuring-production-and-preview-branches/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/webops-dashboard)\n\n[Configuring production and preview branches in WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/webops-configuring-production-and-preview-branches)\n\n[Managing Secrets](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/webops-managing-secrets)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/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/webops-configuring-production-and-preview-branches/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/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/webops-configuring-production-and-preview-branches/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/webops-configuring-production-and-preview-branches/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/webops-configuring-production-and-preview-branches/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/webops-configuring-production-and-preview-branches/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/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/webops-configuring-production-and-preview-branches/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/webops-dashboard)\n\nConfiguring production and preview branches in WebOps\n\nIn this guide, you'll learn how to configure custom branches for production builds and preview deployments in [FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-dashboard), enabling you to use different branches for production and QA accounts from the same repository.\n\nFastStore WebOps allows you to customize which branch generates production builds and configure which branches generate preview deployments through the **Integrations** tab. This feature is particularly useful for merchants who maintain separate production and QA accounts, enabling you to manage both environments from a single repository without code duplication.\n\nWith branch customization, you can:\n\n* **[Configure a custom production branch](#configuring-the-production-branch):** Choose any branch from your repository to generate production builds for your account.\n* **[Filter preview deployments](#configuring-preview-branch-filters):** Control which branches generate preview builds using include and exclude patterns.\n\n> If you don't configure a custom production branch, WebOps will use your repository's default branch (typically `main`). This maintains backward compatibility with existing projects.\n\n## Use cases\n\n### Managing separate production and QA environments\n\nIf you maintain separate VTEX accounts for production and QA environments, branch customization allows you to use a single GitHub repository for both accounts while keeping their deployments independent. This eliminates code duplication and simplifies maintenance.\n\n**Example scenario:**\n\n* **Production account (`mystore`):** Configured to use the `main` branch for all production deployments.\n* **QA account (`mystoreqa`):** Configured to use the `homolog` branch for testing and validation.\n\nBoth accounts share the same repository, but each points to its respective branch for deployments. This setup enables your QA team to test changes in the `homolog` branch without affecting production, while production deployments automatically use the stable `main` branch.\n\n### Optimizing preview deployments\n\nWhen working with multiple feature branches, you may want to control which branches generate preview deployments to optimize build resources and reduce unnecessary deployments.\n\n**Example scenarios:**\n\n* **Include only active development branches:** Configure include patterns (for example, `feature/*`) to generate previews only for feature branches, excluding experimental or abandoned branches.\n* **Exclude release branches:** Use exclude patterns (for example, `release/*`) to prevent release branches from generating preview builds, as these are typically merged directly to production.\n* **Focus on specific workflows:** Combine include and exclude patterns to create a focused preview workflow that matches your team's development process.\n\n### Using non-default branches for production\n\nIf your team follows a branching strategy where production code lives in a branch other than `main` (for example, `production`, `release`, or `stable`), you can configure WebOps to use that branch for production builds.\n\n**Example scenario:**\n\n* Your repository's default branch is `develop`, where ongoing development occurs.\n* Production-ready code is merged into the `production` branch.\n* Configure WebOps to use the `production` branch for production builds, ensuring that only tested and approved code reaches your live store.\n\n## Instructions\n\nTo configure your branches, go to your [FastStore WebOps dashboard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-dashboard) and navigate to the **Integrations** tab.\n\n\n\n### Configuring the production branch\n\nTo customize which branch generates production builds:\n\n1. In the **Integrations** tab of your FastStore WebOps dashboard, go to the **Production branch** section.\n2. Select the branch you want to use for production builds from the dropdown list.\n3. Click `Save` to apply the changes.\n\n\n\n### Configuring preview branch filters\n\nPreview branch filters allow you to control which branches generate preview deployments. If no filters are configured, all branches (except the production branch) will generate preview deployments by default.\n\nYou can use include and exclude patterns to fine-tune which branches should create preview builds by following these steps:\n\n1. In the **Integrations** tab of your FastStore WebOps dashboard, go to the **Preview branch filters** section.\n2. Toggle the filter activation switch to enable branch filtering.\n3. Add filter rules to include or exclude patterns: \n * **Include patterns**: Choose **Branch is** in the dropdown, then enter a branch name or pattern in the adjacent field. Only branches matching these patterns will generate previews. \n * **Exclude patterns**: Choose **Branch is not** in the dropdown, then enter a branch name or pattern in the adjacent field. Branches matching these patterns will not generate previews. \n> You can use wildcards to define patterns for branch names.\n4. Click `Add` to add the filter rule.\n\n\n\n### Managing filter rules\n\nIn the **Rules** section, you can edit or delete a rule.\n\n#### Editing a rule\n\n1. Go to the **Rules** section.\n2. Next to the rule you need to update, click `⋮` then click `Edit`.\n3. A modal will open, where you can make your changes.\n4. Click `Update` to apply the changes.\n\n#### Deleting a rule\n\n1. Go to the **Rules** section.\n2. Next to the rule you need to delete, click `⋮` then click `Delete`.\n3. A modal will open, with the message `Are you sure you want to delete this rule?`.\n4. If you're sure, click `Delete` to remove the rule.\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/getting-started/webops/configuring-production-and-preview-branches.mdx)\n\n[FastStore WebOps« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/webops-dashboard)[Managing SecretsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/webops-managing-secrets)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/webops-configuring-production-and-preview-branches%23use-cases)\n\n[Managing separate production and QA environments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/webops-configuring-production-and-preview-branches%23managing-separate-production-and-qa-environments)[Optimizing preview deployments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/webops-configuring-production-and-preview-branches%23optimizing-preview-deployments)[Using non-default branches for production](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/webops-configuring-production-and-preview-branches%23using-non-default-branches-for-production)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/webops-configuring-production-and-preview-branches%23instructions)\n\n[Configuring the production branch](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/webops-configuring-production-and-preview-branches%23configuring-the-production-branch)[Configuring preview branch filters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/webops-configuring-production-and-preview-branches%23configuring-preview-branch-filters)[Managing filter rules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/webops-configuring-production-and-preview-branches%23managing-filter-rules)\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/webops/configuring-production-and-preview-branches.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/webops-configuring-production-and-preview-branches%23use-cases)\n\n[Managing separate production and QA environments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/webops-configuring-production-and-preview-branches%23managing-separate-production-and-qa-environments)[Optimizing preview deployments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/webops-configuring-production-and-preview-branches%23optimizing-preview-deployments)[Using non-default branches for production](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/webops-configuring-production-and-preview-branches%23using-non-default-branches-for-production)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/webops-configuring-production-and-preview-branches%23instructions)\n\n[Configuring the production branch](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/webops-configuring-production-and-preview-branches%23configuring-the-production-branch)[Configuring preview branch filters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/webops-configuring-production-and-preview-branches%23configuring-preview-branch-filters)[Managing filter rules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/webops-configuring-production-and-preview-branches/docs/guides/faststore/webops-configuring-production-and-preview-branches%23managing-filter-rules)\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_eb3ac4c9
|
[
{
"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 checkout ui custom v0 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-checkout-ui-custom-v0/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-checkout-ui-custom-v0/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-checkout-ui-custom-v0/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-checkout-ui-custom-v0/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-checkout-ui-custom-v0/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-checkout-ui-custom-v0/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-checkout-ui-custom-v0/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-checkout-ui-custom-v0/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-checkout-ui-custom-v0/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-checkout-ui-custom-v0/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-checkout-ui-custom-v0/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-checkout-ui-custom-v0/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-checkout-ui-custom-v0/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-checkout-ui-custom-v0/updates/release-notes)\n\nCheckout UI Custom\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 CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-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:information_source: \\_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://developers.vtex.com/docs/guides/vtex-io-documentation-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://developers.vtex.com/docs/guides/vtex-io-documentation-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://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace) that, in turn, will be [promoted to Master](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-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\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/functional-apps/vtex-checkout-ui-custom-v0.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-checkout-ui-custom-v0/docs/guides/vtex-checkout-ui-custom-v0%23configuration)\n\n[Modus Operandi](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-checkout-ui-custom-v0/docs/guides/vtex-checkout-ui-custom-v0%23modus-operandi)\n\n[For VTEX Developers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-checkout-ui-custom-v0/docs/guides/vtex-checkout-ui-custom-v0%23for-vtex-developers)\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/functional-apps/vtex-checkout-ui-custom-v0.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-checkout-ui-custom-v0/docs/guides/vtex-checkout-ui-custom-v0%23configuration)\n\n[Modus Operandi](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-checkout-ui-custom-v0/docs/guides/vtex-checkout-ui-custom-v0%23modus-operandi)\n\n[For VTEX Developers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-checkout-ui-custom-v0/docs/guides/vtex-checkout-ui-custom-v0%23for-vtex-developers)\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_cc05ab2a
|
[
{
"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 2 integrating the vtex login 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-2-integrating-the-vtex-login/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-2-integrating-the-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/guides/faststore/go-live-2-integrating-the-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/guides/faststore/go-live-2-integrating-the-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/guides/faststore/go-live-2-integrating-the-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/guides/faststore/go-live-2-integrating-the-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/guides/faststore/go-live-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/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-2-integrating-the-vtex-login/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login/docs/guides/faststore)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login/docs/guides/faststore/go-live-overview)\n\n2\\. Integrating the VTEX Login\n\nIn this guide, you'll learn how to integrate the **VTEX Login** with your **FastStore** project.\n\nThe VTEX Login is provided by the `vtexcommercestable` environment and uses a subdomain. Therefore, to successfully integrate the VTEX Login with your FastStore project, you must add a redirect back to the FastStore domain and set up the necessary auth cookies to authenticate client requests and maintain session information. This way, once shoppers finish logging in to your store, they can be redirected back to your website's main domain.\n\n---\n\n## Before you begin\n\n### All stores\n\n* Ensure you have already [configured the custom domain name of your FastStore website](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns).\n\n### Stores currently using Portal (Legacy) technology\n\n* We recommend using a subdomain for the initial setup to avoid login issues caused by redirecting from Portal to the main domain.\n* You need to update your `vtex.edition-business@0.x` to `vtex.edition-store@5.x` and migrate your secure domain to VTEX IO. To make these changes, please contact the [VTEX support team](https://read.calvincode.net/reader?url=https://help.vtex.com/support) and request an update to the [Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app) installed in your account, as well as a migration of your secure domain from Portal (Legacy) to VTEX IO.\n\n---\n\n## Instructions\n\n### Step 1 - Adding a redirect back to your FastStore domain\n\nBy completing this step, shoppers will be redirected back to your website's main domain after logging in or completing a checkout. The instructions to complete this step depend on whether your store uses the My Account and Checkout pages in the [CMS Portal (Legacy)](#for-cms-portal-legacy-stores) or [Store Framework](#for-store-framework-stores).\n\n#### For CMS Portal (Legacy) stores\n\n1. Access the VTEX Admin.\n2. Go to **Storefront > Layout**.\n3. In the left-side navigation menu, click on **CMS**.\n4. Click on **HTML Templates** and open the **Home** file.\n5. Add the following script to the Home's `<head>`. \n * _Replace the value between curly brackets with your store domain._ \n`1 \n<meta http-equiv=\"refresh\" content=\"0; URL='https://{maindomain}'\" /> \n`\n6. Clean the `<body>` section to remove unnecessary code. By the end of this step, your Home file should look like the following: \n\n7. Click on the **Save Template** button.\n\n#### For Store Framework stores\n\nStore Framework stores are built on [VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io), which has a decoupled architecture where pages like My Account and Checkout are managed as apps. Unlike the CMS Portal (Legacy), these pages are part of the VTEX IO ecosystem and require a different approach for handling redirects.\n\nTo redirect users back to your FastStore domain after events like logins or checkouts, follow these steps:\n\n1. Create a Pixel App by following the [Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps) track.\n2. In the [4\\. Writing the head and body scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-writingtheheaderandbodyscripts) step, add the following script: \n`1 \n<script> \n2 \n \n3 \nfunction redirectToProduction(){ \n4 \n \n5 \n const { pathname, search } = window.location \n6 \n const redirectDomain = decodeURIComponent(\"https://www.{addDomainName}.com\") // Replace with your domain \n7 \n \n8 \n if( \n9 \n pathname === '/account' || \n10 \n pathname === '/login' || \n11 \n pathname === '/checkout' || \n12 \n pathname === '/checkout/orderPlaced' || \n13 \n pathname === '/checkout/orderPlaced/' || \n14 \n pathname === '/api/io/account' || \n15 \n pathname === '/api/io/login' || \n16 \n !redirectDomain) { \n17 \n return false \n18 \n } \n19 \n \n20 \n const redirectLink = redirectDomain + pathname + search \n21 \n \n22 \n window.location.href = redirectLink \n23 \n} \n24 \n \n25 \n(function() { \n26 \n redirectToProduction() \n27 \n \n28 \n window.addEventListener('hashchange',() => { \n29 \n redirectToProduction() \n30 \n }) \n31 \n})() \n32 \n \n33 \n</script> \n` \n> Replace `https://www.{addDomainName}.com` with your store's main domain. For example, if the store's main domain is `https://www.mystore.com`, set the `const` as the following: `const redirectDomain = decodeURIComponent(\"https://www.mystore.com\")`.\n3. Complete the remaining steps in the [Pixel app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps) track to inject the script into your store's login page.\n\nOnce implemented, shoppers will be automatically redirected to your website’s main domain after logging in or completing a checkout.\n\n### Step 2 - Setting the auth cookie root domain\n\nTo authenticate client requests and maintain session information, you must ensure that the auth cookies are set up for the **Login** subdomain. To do that, [open a support ticket with VTEX](https://read.calvincode.net/reader?url=https://help-tickets.vtex.com/smartlink/sso/login/zendesk) to the Identity team requesting to set up the auth cookie root domain for your FastStore URL.\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/go-live/2-integrating-the-vtex-login.mdx)\n\n[1\\. Configuring external DNS« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login/docs/guides/faststore/go-live-1-configuring-external-dns)[3\\. Integrating the VTEX CheckoutNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout)\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/go-live-2-integrating-the-vtex-login/docs/guides/faststore/go-live-2-integrating-the-vtex-login%23before-you-begin)\n\n[All stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login/docs/guides/faststore/go-live-2-integrating-the-vtex-login%23all-stores)[Stores currently using Portal (Legacy) technology](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login/docs/guides/faststore/go-live-2-integrating-the-vtex-login%23stores-currently-using-portal-legacy-technology)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login/docs/guides/faststore/go-live-2-integrating-the-vtex-login%23instructions)\n\n[Step 1 - Adding a redirect back to your FastStore domain](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login/docs/guides/faststore/go-live-2-integrating-the-vtex-login%23step-1-adding-a-redirect-back-to-your-faststore-domain)[Step 2 - Setting the auth cookie root domain](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login/docs/guides/faststore/go-live-2-integrating-the-vtex-login%23step-2-setting-the-auth-cookie-root-domain)\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/2-integrating-the-vtex-login.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/go-live-2-integrating-the-vtex-login/docs/guides/faststore/go-live-2-integrating-the-vtex-login%23before-you-begin)\n\n[All stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login/docs/guides/faststore/go-live-2-integrating-the-vtex-login%23all-stores)[Stores currently using Portal (Legacy) technology](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login/docs/guides/faststore/go-live-2-integrating-the-vtex-login%23stores-currently-using-portal-legacy-technology)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login/docs/guides/faststore/go-live-2-integrating-the-vtex-login%23instructions)\n\n[Step 1 - Adding a redirect back to your FastStore domain](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login/docs/guides/faststore/go-live-2-integrating-the-vtex-login%23step-1-adding-a-redirect-back-to-your-faststore-domain)[Step 2 - Setting the auth cookie root domain](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login/docs/guides/faststore/go-live-2-integrating-the-vtex-login%23step-2-setting-the-auth-cookie-root-domain)\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_5f0c29c7
|
[
{
"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 challenge tp condition 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.challenge-tp-condition/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.challenge-tp-condition/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.challenge-tp-condition/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.challenge-tp-condition/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.challenge-tp-condition/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.challenge-tp-condition/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.challenge-tp-condition/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.challenge-tp-condition/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.challenge-tp-condition/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.challenge-tp-condition/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.challenge-tp-condition/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.challenge-tp-condition/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.challenge-tp-condition/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.challenge-tp-condition/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.challenge-tp-condition/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.challenge-tp-condition/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.challenge-tp-condition/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.challenge-tp-condition/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.challenge-tp-condition/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.challenge-tp-condition/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.challenge-tp-condition/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.challenge-tp-condition/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.challenge-tp-condition/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.challenge-tp-condition/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.challenge-tp-condition/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.challenge-tp-condition/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.challenge-tp-condition/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.challenge-tp-condition/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.challenge-tp-condition/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.challenge-tp-condition/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.challenge-tp-condition/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.challenge-tp-condition/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.challenge-tp-condition/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.challenge-tp-condition/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.challenge-tp-condition/docs/vtex-io-apps)\n\nChallenge Trade Policy Condition\n\nOfficial extension\n\nVersion: 0.6.1\n\nLatest version: 0.6.1\n\n[](#contributors-)\n\nUsed in B2B environments, the Challenge block is a non-rendered block responsible for checking if a user is allowed to access the store's content.\n\n:information\\_source: This check is made according to the Condition Rule specified in the Trade Policy configuration, one of the steps needed to [**configure a B2B environment in VTEX IO**](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/store/configuring-a-b2b-environment).\n\n## Configuration\n\n1. Import the app to your theme's dependencies in `manifest.json`, for example:\n\n`1\n\n \"dependencies\": { \n\n2\n\n // ... \n\n3\n\n \"vtex.challenge-tp-condition\": \"0.x\" \n\n4\n\n } \n\n`\n\n1. Add the `challenge.trade-policy-condition` block as a `parent` block to the templates of the pages you want to protect, such as:\n\n`1\n\n \"store.home\": { \n\n2\n\n \"blocks\": [ \n\n3\n\n \"shelf#home\", \n\n4\n\n \"flex-layout.row#deals\", \n\n5\n\n \"info-card#home\", \n\n6\n\n \"rich-text#question\", \n\n7\n\n \"rich-text#link\", \n\n8\n\n \"newsletter\" \n\n9\n\n ], \n\n10\n\n+ \"parent\": { \n\n11\n\n+ \"challenge\": \"challenge.trade-policy-condition\" \n\n12\n\n+ } \n\n13\n\n }, \n\n`\n\n1. Declare the `challenge.trade-policy-condition`, using its props to define to where the store's users should be redirected according to each scenario. For example:\n\n`1\n\n\"challenge.trade-policy-condition\": { \n\n2\n\n \"props\": { \n\n3\n\n \"redirectPath\": \"/login\" \n\n4\n\n } \n\n5\n\n}, \n\n`\n\n| Prop name | Type | Description | Default value |\n| ------------------------ | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| redirectPath | string | Path to which the not logged in user will be redirected | /login |\n| forbiddenRedirectPath | string | Path to which the logged in user will be redirected if not allowed access according to the Condition Rule | /login |\n| defaultContentVisibility | enum | Whether the store's content should be visible (visible) or hidden (hidden) while the Challenge block is verifying the user's access permission | visible |\n\n:warning: Using `hidden` as the `defaultContentVisibility` value result in the entire page's content being rendered on the client side (in a scenario in which the check concludes that the user has permission to access the store). The page will not be Server Side Rendered (SSR) due to the fact that this verification process is user-based, making it impossible to cache.\n\n## Customization\n\nNo CSS Handles are available for the app customization.\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.challenge-tp-condition/docs/apps/vtex.challenge-tp-condition%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.challenge-tp-condition/docs/apps/vtex.challenge-tp-condition%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_93f32a9e
|
[
{
"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 installing 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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-google-tag-manager/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-google-tag-manager/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-google-tag-manager/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-google-tag-manager/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-google-tag-manager/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-google-tag-manager/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-google-tag-manager/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-google-tag-manager/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-google-tag-manager/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-google-tag-manager/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-google-tag-manager/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-google-tag-manager/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-google-tag-manager/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-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/vtex-io-documentation-installing-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/vtex-io-documentation-installing-google-tag-manager/docs/guides/vtex-io-documentation-installing-google-tag-manager)\n\nInstalling Google Tag Manager\n\nDiscover the steps to install the Google Tag Manager app in your Store Framework store.\n\nThis guide provides instructions for managing Analytics on Store Framework stores by installing and configuring [Google Tag Manager (GTM)](https://read.calvincode.net/reader?url=https://tagmanager.google.com/). It also outlines restrictions to avoid performance issues and unpredictable behavior, such as blocklists for custom HTML tags and variables.\n\n## Before you begin\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\nIf you have already installed the Google Tag Manager app, go to the [Create a Google Analytics 4 property](#create-a-google-analytics-4-property) step to create the property and continue.\n\n### Get a Google account\n\nYou need a Google account to use Google Tag Manager (GTM). If you already use Google products like Gmail, you can use the same account.\n\nIf you don't have an account, create one by following Google's guide on [Creating your Google account](https://read.calvincode.net/reader?url=https://accounts.google.com/lifecycle/steps/signup/workspaceinterstitial?continue=https://tagmanager.google.com/%26ddm=1%26dsh=S1747300419:1734533693867352%26flowEntry=SignUp%26flowName=GlifWebSignIn%26service=analytics%26TL=AE--Llz4c9wxBXCL%5FHUOxs0VQwkCVyn1dVQZDuQL8ZvZUnVGcbKDfXTlaI-fN0ks).\n\n### Get a GTM container\n\nTo use a GTM ID in your store, you need a GTM container. If you don't have one, follow the [Create a new account and container](https://read.calvincode.net/reader?url=https://support.google.com/tagmanager/answer/6103696?hl=en%23install) tutorial.\n\nAfter creating a container, find its GTM ID in the `Container ID` column. Be sure to save this ID, as it will be required later in the installation process.\n\n### Create a Google Analytics 4 property\n\nCreate a Google Analytics 4 (GA4) property using the GA4 Setup Assistant. This property collects data alongside your existing Universal Analytics (UA) property. To create the GA4 property, follow [Google’s official guide](https://read.calvincode.net/reader?url=https://support.google.com/analytics/answer/9744165%23zippy=%2Cin-this-article).\n\n### Take note of GTM settings\n\nTake note of the Measurement ID, also known as [G-ID](https://read.calvincode.net/reader?url=https://support.google.com/analytics/answer/9539598%23find-G-ID), as it will be used later to configure the GA4 tag on GTM.\n\n## Instructions\n\n1. In the VTEX **Admin**, go to **Apps > Extensions Hub > App Store**.\n2. Search for the Google Tag Manager app and click `Get App`. \n\n3. You will be redirected to the [App Store page](https://read.calvincode.net/reader?url=https://apps.vtex.com/vtex-google-tag-manager/p). If you are not currently logged in, log in to your account. \n\n4. After logging in, you will be redirected to the [App Store landing page](https://read.calvincode.net/reader?url=https://apps.vtex.com/). In the search field, type `Google Tag Manager`, click the app, and then click `Get App`.\n5. On the checkout page, click `Place Order`.\n\n> GTM is a free app.\n\n1. You will see a success message about the purchase. Click `Go to Install Page` to be redirected to the GTM setup page in the VTEX admin.\n2. On the GTM setup page in VTEX admin, click `Install`. \n\n3. The GTM app settings page will open for you to complete the required fields. In the Google Tag Manager field, add your **GTM ID**. Check the box for **Send Google Analytics 4 Events**.\n\n> To find your store's **GTM ID**, you first need to create a container in your Google Tag Manager account. If you don't have one yet, follow the [Create an account and container](https://read.calvincode.net/reader?url=https://support.google.com/tagmanager/answer/6103696?hl=en%23install) tutorial. Once created, you can find the GTM ID in the `Container ID` column of the container.\n\n\n\n1. Click `Save`.\n\nOnce you have installed the app and checked the box **Send Google Analytics 4 Events**, see [Configuring Google Analytics 4 configuration tag in Google Tag Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager) to learn how to set up the variables, triggers, and tags for the app to work.\n\n## Restrictions\n\nTo prevent performance issues and unpredictable behavior, the VTEX IO Google Tag Manager solution uses the native GTM blacklist feature. Learn more in the [Google Developer Guide](https://read.calvincode.net/reader?url=https://developers.google.com/tag-platform/tag-manager/web/restrict). By default, the HTML ID is blocked, which automatically blocks all tags, variables, and triggers of the `customScripts` type.\n\nAs a result, custom HTML tags will not be triggered. **The HTML blacklist is the default setting in the VTEX Google Tag Manager app**. To disable this restriction, go to `https://{accountName}.myvtex.com/admin/apps/vtex.google-tag-manager@3.x/setup` and check the setting below.\n\n> Replace `{accountName}` with your store account name.\n\n\n\nThe most commonly used custom HTML tags are for integrations with third-party services, such as Customer Chat, Analytics, Remarketing, and Pixel tags. If your store requires custom HTML for any of these cases, you can integrate it by transforming the tags into a VTEX IO [Pixel app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app) or by removing this restriction.\n\nBelow is the complete list of tags and variables 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\nView the complete list of available GTM tags in [the Google Developer Guide](https://read.calvincode.net/reader?url=https://developers.google.com/tag-platform/tag-manager/web/datalayer).\n\nContributors\n\n2\n\n[](https://github.com/barbara-celi)\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/google-tag-manager/vtex-io-documentation-installing-google-tag-manager.md)\n\n[Configuring Analytics (Google Tag Manager)« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-google-tag-manager//docs/guides/store-framework-configuring-analytics-google-tag-manager)[Setting up Google Tag Manager events and triggersNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-google-tag-manager//docs/guides/vtex-io-documentation-setting-up-google-tag-manager)\n\nContributors\n\n2\n\n[](https://github.com/barbara-celi)\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-installing-google-tag-manager/docs/guides/vtex-io-documentation-installing-google-tag-manager%23before-you-begin)\n\n[Get a Google account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-google-tag-manager/docs/guides/vtex-io-documentation-installing-google-tag-manager%23get-a-google-account)[Get a GTM container](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-google-tag-manager/docs/guides/vtex-io-documentation-installing-google-tag-manager%23get-a-gtm-container)[Create a Google Analytics 4 property](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-google-tag-manager/docs/guides/vtex-io-documentation-installing-google-tag-manager%23create-a-google-analytics-4-property)[Take note of GTM settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-google-tag-manager/docs/guides/vtex-io-documentation-installing-google-tag-manager%23take-note-of-gtm-settings)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-google-tag-manager/docs/guides/vtex-io-documentation-installing-google-tag-manager%23instructions)\n\n[Restrictions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-google-tag-manager/docs/guides/vtex-io-documentation-installing-google-tag-manager%23restrictions)\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/google-tag-manager/vtex-io-documentation-installing-google-tag-manager.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-installing-google-tag-manager/docs/guides/vtex-io-documentation-installing-google-tag-manager%23before-you-begin)\n\n[Get a Google account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-google-tag-manager/docs/guides/vtex-io-documentation-installing-google-tag-manager%23get-a-google-account)[Get a GTM container](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-google-tag-manager/docs/guides/vtex-io-documentation-installing-google-tag-manager%23get-a-gtm-container)[Create a Google Analytics 4 property](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-google-tag-manager/docs/guides/vtex-io-documentation-installing-google-tag-manager%23create-a-google-analytics-4-property)[Take note of GTM settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-google-tag-manager/docs/guides/vtex-io-documentation-installing-google-tag-manager%23take-note-of-gtm-settings)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-google-tag-manager/docs/guides/vtex-io-documentation-installing-google-tag-manager%23instructions)\n\n[Restrictions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-google-tag-manager/docs/guides/vtex-io-documentation-installing-google-tag-manager%23restrictions)\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_36e7536c
|
[
{
"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 b2b suite 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.b2b-suite/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/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.b2b-suite/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.b2b-suite/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.b2b-suite/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.b2b-suite/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.b2b-suite/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/apps/vtex.b2b-suite)\n\n[Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/apps/vtex.storefront-permissions)\n\n[Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/apps/vtex.storefront-permissions-ui)\n\n[B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/apps/vtex.b2b-organizations)\n\n[B2B Checkout Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/apps/vtex.b2b-checkout-settings)\n\n[B2B Orders History](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/apps/vtex.b2b-orders-history)\n\n[B2B Quotes & Carts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/apps/vtex.b2b-quotes)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/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.b2b-suite/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.b2b-suite/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/apps/vtex.b2b-suite)\n\n[Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/apps/vtex.storefront-permissions)\n\n[Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/apps/vtex.storefront-permissions-ui)\n\n[B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/apps/vtex.b2b-organizations)\n\n[B2B Checkout Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/apps/vtex.b2b-checkout-settings)\n\n[B2B Orders History](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/apps/vtex.b2b-orders-history)\n\n[B2B Quotes & Carts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/apps/vtex.b2b-quotes)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/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.b2b-suite/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.b2b-suite/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.b2b-suite/docs/vtex-io-apps)\n\nB2B Suite\n\nOfficial extension\n\nVersion: 2.0.0\n\nLatest version: 2.0.0\n\n[](#contributors-)\n\n**B2B Suite** is a collection of VTEX IO apps that allow stores to manage organizations, storefront roles and permissions, and checkout settings for B2B commerce relationships.\n\nThese features are particularly useful for B2B stores: in commerce relations between businesses, it is essential to simplify the purchase flow, reduce costs, and provide a personalized buying experience.\n\nB2B customers frequently have distinct roles within their organization, such as professional buyers, managers, or supervisors. Each role is associated with a different set of storefront permissions, depending on the actions the user needs to perform.\n\nGrouping different users from the same company under an organization and defining custom payment methods, product selections, and prices for each customer are also everyday needs in B2B.\n\nIn addition, it is often necessary to provide customized options for B2B customers during checkout, such as a specific selection of payment methods per organization or cost center, pre-filled addresses, purchase order numbers, and order quotes.\n\nBy installing the **B2B Suite**, you have access to seven apps with the following features for B2B:\n\n| **App name** | **Description** |\n| ------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions) | Stores a predefined set of roles and permissions related to what B2B users can access and do in the storefront, which other integrated apps can check. This is useful for stores that want to set specific permissions for users with different organizational roles. |\n| [Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui) | Provides an interface for the [Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions) app, communicates with its stored roles and permissions, and provides the following features for this scenario. **Role management:** Allows VTEX Admin users to manage B2B roles and associated app permissions through an interface. **Theme block configuration:** Enables conditional theme blocks so only users with the required permissions can access specific content in your storefront. |\n| [B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations) | Enables you to group B2B users into organizations to which you can assign specific payment methods, price tables, and product collections. This allows all organization users to share the same commercial conditions. Each organization is further segmented into one or more cost centers, with its own shipping addresses, which will be available for cost center users at checkout. |\n| [B2B Quotes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes) | Enables B2B users to create quotes and saved carts, which are then shared with the other members of their organization. Users with the appropriate storefront permissions can modify quotes to apply discounts or change the amount of items, so the resulting quote can then be used to place an order. |\n| [B2B Checkout Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings) | Extends the checkout experience for users who are members of B2B organizations. With this app, you can allow specific payment methods for the user's organization, provide prefilled addresses based on the cost center of each user, add a purchase order number to the order, and allow customers to create an order quote before placing the order. |\n| [B2B Orders History](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-orders-history) | Provides a new **Orders** page under **My Account** so that B2B users can view all previous orders placed by users in their organization or cost center, depending on their role. |\n| [B2B Admin Customers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers) | Provides additional customer information management capabilities on the VTEX Admin, allowing store administrators to create, edit, and search for customers. |\n\nMake sure to read the documentation for each app to learn more about their features and settings.\n\n> After installing **B2B Suite**, make sure to hide the default **Order History** link within **My Account** by configuring `vtex.my-account`. Otherwise, **B2B Orders History** will not work as expected. You can do this at `https://{{accountName}}.myvtex.com/admin/apps/vtex.my-account@1.x/setup/`, by unselecting the **Visible** option in the **Orders** section.\n\nFor additional features, you can also install the [Quick Order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder) app, which creates a custom page in your store aimed at bulk purchases, offering tools such as uploading a spreadsheet to make bulk orders more agile.\n\n## Frequently Asked Questions\n\n### How do I fix the schema issue?\n\nFor more details on how to resolve schema-related issues, please refer to the article [I can't fix the schema error in B2B apps](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/i-cant-fix-the-schema-error-in-b2b-apps--WkjJZSnGXCiqmLhg4b0OR).\n\n[SKU List« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/apps/vtex.sku-list)[Storefront PermissionsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/apps/vtex.storefront-permissions)\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[Frequently Asked Questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/apps/vtex.b2b-suite%23frequently-asked-questions)\n\n[How do I fix the schema issue?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite/docs/apps/vtex.b2b-suite%23how-do-i-fix-the-schema-issue)\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_1366eaea
|
[
{
"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 dynamic content 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/dynamic-content-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/dynamic-content-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/dynamic-content-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/dynamic-content-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/dynamic-content-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/dynamic-content-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/dynamic-content-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/dynamic-content-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/dynamic-content-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-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/dynamic-content-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/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/dynamic-content-overview/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/dynamic-content-overview/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/dynamic-content-overview/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/dynamic-content-overview/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/dynamic-content-overview/docs/guides/faststore/dynamic-content-overview)\n\n[Step 1 - Setting up the store code for Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content)\n\n[Step 2 - Handling Dynamic Content in custom sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-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/dynamic-content-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/dynamic-content-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/dynamic-content-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/dynamic-content-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-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/dynamic-content-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/dynamic-content-overview/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-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/dynamic-content-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/dynamic-content-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-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/dynamic-content-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/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/dynamic-content-overview/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/dynamic-content-overview/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/dynamic-content-overview/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/dynamic-content-overview/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/dynamic-content-overview/docs/guides/faststore/dynamic-content-overview)\n\n[Step 1 - Setting up the store code for Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content)\n\n[Step 2 - Handling Dynamic Content in custom sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-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/dynamic-content-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/dynamic-content-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/dynamic-content-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/dynamic-content-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-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/dynamic-content-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/dynamic-content-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/dynamic-content-overview/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/guides/faststore)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/guides/faststore/headless-cms-overview)\n\nDynamic Content\n\nDynamic Content is a FastStore feature that allows you to customize your store home and landing pages using server-side data fetching. This feature improves performance and SEO by dynamically displaying fetched data in store sections on these pages.\n\nIn the following example, a page slug, `/my-landing-page`, is configured in the store code and included in the Headless CMS. The landing page features two Hero sections: a [native one](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero) displaying an image added from the Headless CMS, and a custom one with a fixed image sourced directly from an API defined in the store code.\n\n\n\n> For other types of pages, such as collections (PLPs) and product pages (PDPs), server-side data fetching is already available via API Extensions. Refer to the [API Extension documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview) for more details on fetching data for these pages.\n\n## Before you begin\n\n### Update the `@faststore/core` package\n\nEnsure your store uses `@faststore/core` v3.0.55 or greater. Follow the steps below to update the package:\n\n1. Update your store’s `@faststore/core` package to the latest version by running the following command:\n\n`1\n\nyarn add @faststore/core@latest \n\n`\n\n1. Run `yarn dev` to sync the changes to your project.\n\n### Understand Section Override\n\nTo work with dynamic content, you need knowledge of [Section Override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview).\n\n## Implementing Dynamic Content\n\nTo use the Dynamic Content feature in your home and landing pages, follow these steps:\n\n* [Step 1 - Setting up your store code for Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content): Request Fetch API or any HTTP library to fetch the data directly ([Axios](https://read.calvincode.net/reader?url=https://axios-http.com/docs/intro), fetch, etc).\n* [Step 2 - Handling Dynamic Content within custom sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections): Fetch the data using the existing API Extension feature.\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/dynamic-content/overview.mdx)\n\n[Widgets for Headless CMS« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/guides/faststore/headless-cms-widgets)[Step 1 - Setting up the store code for Dynamic ContentNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content)\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/dynamic-content-overview/docs/guides/faststore/dynamic-content-overview%23before-you-begin)\n\n[Update the @faststore/core package](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/guides/faststore/dynamic-content-overview%23update-the-faststorecore-package)[Understand Section Override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/guides/faststore/dynamic-content-overview%23understand-section-override)\n\n[Implementing Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/guides/faststore/dynamic-content-overview%23implementing-dynamic-content)\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/dynamic-content/overview.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/dynamic-content-overview/docs/guides/faststore/dynamic-content-overview%23before-you-begin)\n\n[Update the @faststore/core package](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/guides/faststore/dynamic-content-overview%23update-the-faststorecore-package)[Understand Section Override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/guides/faststore/dynamic-content-overview%23understand-section-override)\n\n[Implementing Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview/docs/guides/faststore/dynamic-content-overview%23implementing-dynamic-content)\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_8b89ef21
|
[
{
"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 storefront permissions ui 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.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/apps/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/apps/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/apps/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/apps/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/apps/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/apps/vtex.storefront-permissions-ui/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/apps/vtex.b2b-suite)\n\n[Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/apps/vtex.storefront-permissions)\n\n[Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/apps/vtex.storefront-permissions-ui)\n\n[B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/apps/vtex.b2b-organizations)\n\n[B2B Checkout Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/apps/vtex.b2b-checkout-settings)\n\n[B2B Orders History](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/apps/vtex.b2b-orders-history)\n\n[B2B Quotes & Carts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/apps/vtex.b2b-quotes)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/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.storefront-permissions-ui/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.storefront-permissions-ui/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/apps/vtex.b2b-suite)\n\n[Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/apps/vtex.storefront-permissions)\n\n[Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/apps/vtex.storefront-permissions-ui)\n\n[B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/apps/vtex.b2b-organizations)\n\n[B2B Checkout Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/apps/vtex.b2b-checkout-settings)\n\n[B2B Orders History](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/apps/vtex.b2b-orders-history)\n\n[B2B Quotes & Carts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/apps/vtex.b2b-quotes)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/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.storefront-permissions-ui/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.storefront-permissions-ui/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.storefront-permissions-ui/docs/vtex-io-apps)\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/apps/vtex.b2b-suite)\n\nStorefront Permissions UI\n\nOfficial extension\n\nVersion: 3.0.1\n\nLatest version: 3.0.1\n\n[](#contributors-)\n\n**Storefront Permissions UI** provides an interface for the [Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-storefront-permissions) app, which is part of VTEX’s [B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/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/vtex-developer-docs/docs/vtex-b2b-suite) for all functionalities to work as expected.\n\n## Before you start\n\nMake sure you have the [VTEX IO CLI (Command Line Interface)](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/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/vtex-developer-docs/docs/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 **Apps** \\> **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/vtex-developer-docs/docs/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 **Apps** \\> **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/vtex-developer-docs/docs/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/vtex-developer-docs/docs/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/vtex-developer-docs/docs/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. | \n| loading-content | Optional block that allows you to define a loading content while permissions are loading. | \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\", \"loading-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+ \"loading-content#carousel\": { \n\n24\n\n+ \"children\": [\"rich-text#loading\"] \n\n25\n\n+ }, \n\n26\n\n+ \"rich-text#disallowed\": { \n\n27\n\n+ \"props\": { \n\n28\n\n+ \"text\": \"**You don't have access to this content**\" \n\n29\n\n+ } \n\n30\n\n+ }, \n\n31\n\n+ \"rich-text#loading\": { \n\n32\n\n+ \"props\": { \n\n33\n\n+ \"text\": \"Waiting for permissions...\" \n\n34\n\n+ } \n\n35\n\n+ }, \n\n36\n\n \"carousel#home\": { \n\n37\n\n \"props\": { \n\n38\n\n \"autoPlay\": false, \n\n39\n\n \"banners\": [ \n\n40\n\n { \n\n41\n\n \"image\": \"https://storecomponents.vteximg.com.br/arquivos/banner-principal.png\", \n\n42\n\n \"mobileImage\": \"https://storecomponents.vteximg.com.br/arquivos/banner-principal-mobile.jpg\" \n\n43\n\n }, \n\n44\n\n { \n\n45\n\n \"image\": \"https://storecomponents.vteximg.com.br/arquivos/banner.jpg\", \n\n46\n\n \"mobileImage\": \"https://storecomponents.vteximg.com.br/arquivos/banner-principal-mobile.jpg\" \n\n47\n\n } \n\n48\n\n ], \n\n49\n\n \"height\": 720, \n\n50\n\n \"showArrows\": true, \n\n51\n\n \"showDots\": true \n\n52\n\n } \n\n53\n\n }, \n\n`\n\n[Storefront Permissions« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/apps/vtex.storefront-permissions)[B2B OrganizationsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/apps/vtex.b2b-organizations)\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.storefront-permissions-ui/docs/apps/vtex.storefront-permissions-ui%23before-you-start)\n\n[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/apps/vtex.storefront-permissions-ui%23installation)\n\n[Roles management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/apps/vtex.storefront-permissions-ui%23roles-management)\n\n[Available storefront roles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/apps/vtex.storefront-permissions-ui%23available-storefront-roles)\n\n[Theme blocks configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions-ui/docs/apps/vtex.storefront-permissions-ui%23theme-blocks-configuration)\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_3deb2ead
|
[
{
"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 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/vtex-io-documentation-components/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-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-components/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-components/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-components/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-components/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-components/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-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-components/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-components/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-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-components/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-components/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-components/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-components/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-components/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-components/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-components/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-components/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-components/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-components/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-components/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-components/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-components/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-components/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-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-components/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-components/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-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-components/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-components/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-components/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-components/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-components/docs/guides/store-framework)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-components/docs/guides/store-framework-using-components%23native-components)[Custom components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-components/docs/guides/store-framework-using-components%23native-components)[Custom components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-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/vtex-io-documentation-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_38f945e4
|
[
{
"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 trustpilot 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.trustpilot/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/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.trustpilot/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.trustpilot/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.trustpilot/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.trustpilot/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.trustpilot/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/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.trustpilot/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.trustpilot/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/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.trustpilot/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.trustpilot/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.trustpilot/docs/vtex-io-apps)\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/guides/pixel-apps)\n\nTrustpilot\n\nOfficial extension\n\nVersion: 2.2.2\n\nLatest version: 2.2.2\n\n[](#contributors-)\n\nThis is a Trustpilot first-party integration app. The [solution](https://read.calvincode.net/reader?url=https://www.trustpilot.com/) provides a review platform for your store.\n\n## Configuration\n\n1. [Install](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/development/installing-an-app/) the `vtex.trustpilot` app in the VTEX account in which you are working.\n2. In your VTEX account's admin, open the **App** section and select the Trustpilot App box.\n3. Fill in your integration key, provided by Trustpilot, in the fields.\n4. Save your changes.\n\n### Using the Trustpilot's Widget component\n\nThe `trustpilot` app also enables Truspilot's widget component to be added to your store theme by adding the `trustpilot-micro-review-count` block in a template of your choosing.\n\n1. Using a [Developer workspace](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/development/creating-a-development-workspace/), open your store's theme directory in your code editor and add the `shop-review-interfaces` app as a dependency in the `manifest.json` file:\n\n`1\n\n \"dependencies\": { \n\n2\n\n+ \"vtex.shop-review-interfaces\": \"0.x\" \n\n3\n\n } \n\n`\n\n1. Add the `shop-review-badge` block, exported by the `shop-review-interfaces`, in a template and block of your choosing, such as the Footer.\n2. Save your changes and [link](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/development/linking-an-app/) the store theme app.\n3. Once your changes linked, access the admin's Site Editor using the same Developer workspace (`{workspaceName}-{accountName}.myvtex.com/admin/cms/site-editor`) and look for the `Trustpilot - Generic Widget` block.\n4. When editing the block, add the widget's `template id` and `business unit id` value provided by the [Trustpilot's widget](https://read.calvincode.net/reader?url=https://widgets-trustboxinstructions.b2b.trustpilot.com/%23/trustbox/eyJjb2RlSGVhZCI6IjwhLS0gVHJ1c3RCb3ggc2NyaXB0IC0tPlxuPHNjcmlwdCB0eXBlPVwidGV4dC9qYXZhc2NyaXB0XCIgc3JjPVwiLy93aWRnZXQudHJ1c3RwaWxvdC5jb20vYm9vdHN0cmFwL3Y1L3RwLndpZGdldC5ib290c3RyYXAubWluLmpzXCIgYXN5bmM%252BPC9zY3JpcHQ%252BXG48IS0tIEVuZCBUcnVzdEJveCBzY3JpcHQgLS0%252BIiwiY29kZUJvZHkiOiI8IS0tIFRydXN0Qm94IHdpZGdldCAtIE1pY3JvIFJldmlldyBDb3VudCAtLT5cbjxkaXYgY2xhc3M9XCJ0cnVzdHBpbG90LXdpZGdldFwiIGRhdGEtbG9jYWxlPVwiaXQtSVRcIiBkYXRhLXRlbXBsYXRlLWlkPVwiNTQxOWI2YThiMGQwNGEwNzY0NDZhOWFkXCIgZGF0YS1idXNpbmVzc3VuaXQtaWQ9XCI1ZTc0ZTJkYjYwMGQxYTAwMDFiZTE1ODlcIiBkYXRhLXN0eWxlLWhlaWdodD1cIjI0cHhcIiBkYXRhLXN0eWxlLXdpZHRoPVwiMTAwJVwiIGRhdGEtdGhlbWU9XCJsaWdodFwiPlxuICA8YSBocmVmPVwiaHR0cHM6Ly9pdC50cnVzdHBpbG90LmNvbS9yZXZpZXcvbWlyaWFkZS5jb21cIiB0YXJnZXQ9XCJfYmxhbmtcIiByZWw9XCJub29wZW5lclwiPlRydXN0cGlsb3Q8L2E%252BXG48L2Rpdj5cbjwhLS0gRW5kIFRydXN0Qm94IHdpZGdldCAtLT4iLCJ0cnVzdEJveE5hbWUiOiJNaWNybyBSZXZpZXcgQ291bnQiLCJsb2NhbGUiOiJpdC1JVCJ9).\n5. Save your changes.\n6. Access your store's website using the Developer workspace to check out the new component. If no more changes are desired, repeat the steps above in a [Production workspace](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/development/creating-a-production-workspace/) and then [promote it to Master](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/development/promoting-a-workspace-to-master).\n\n:information\\_source: _The integration key must be provided by Trustpilot._\n\nThe `trustpilot` app also enables Truspilot's widgets to be added to your store theme by inserting the `shop-review-badge` interface in your layout and then using the `trustpilot-widget` block in a template of your choosing.\n\n| Interface | Block | Description |\n| ----------------- | ----------------- | --------------------------------------- |\n| shop-review-badge | trustpilot-widget | Adds a Trustpilot widget in your store. |\n\n## Block without badge\n\nTo use widget without `shop-review-badge` to landing pages, for example, you can use `trustpilot-widget`. Therefore, you need to add the following in the manifest.json file.\n\n`1\n\n \"peerDependencies\": { \n\n2\n\n+ \"vtex.trustpilot\": \"2.x\" \n\n3\n\n } \n\n`\n\n## `trustpilot-widget` as props\n\n`1\n\n{ \n\n2\n\n \"trustpilot-widget#home\":{ \n\n3\n\n \"title\":\"Widget TrustPilot\", \n\n4\n\n \"props\":{ \n\n5\n\n \"width\":\"100%\", \n\n6\n\n \"height\":\"240px\", \n\n7\n\n \"theme\":\"light\", \n\n8\n\n \"stars\":\"4,5\", \n\n9\n\n \"tag\":\"cart\", \n\n10\n\n \"businessUnitId\":\"597a23fwffdsfe05a793fe\", \n\n11\n\n \"templateId\":\"5419b6a8b0d04a076446a9ad\" \n\n12\n\n } \n\n13\n\n } \n\n14\n\n} \n\n`\n\n| Prop name | Type | Description | Default value |\n| -------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------- | ------------------------ |\n| width | string | Change width of template | undefined |\n| height | string | Change height of template | undefined |\n| theme | string | Change theme of template light or dark | undefined |\n| stars | string | Change stars stock of template | undefined |\n| tag | string | Change tag of template. More info [here](https://read.calvincode.net/reader?url=https://support.trustpilot.com/hc/en-us/articles/203840856-Tag-your-service-reviews) | undefined |\n| businessUnitId | string | Set your business code | undefined |\n| templateId | string | Set your template ID | 5419b6a8b0d04a076446a9ad |\n\n[Tawk.to« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.tawk-to)[Zendesk ChatNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.zendesk-chat)\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.trustpilot/docs/apps/vtex.trustpilot%23configuration)\n\n[Using the Trustpilot's Widget component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.trustpilot%23using-the-trustpilots-widget-component)\n\n[Block without badge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.trustpilot%23block-without-badge)\n\n[trustpilot-widget as props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.trustpilot/docs/apps/vtex.trustpilot%23trustpilot-widget-as-props)\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_44dcdd01
|
[
{
"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 sales associate code 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/sales-associate-code/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-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/guides/sales-associate-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/guides/sales-associate-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/guides/sales-associate-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/guides/sales-associate-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/guides/sales-associate-code/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code/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/sales-associate-code/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code/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/sales-associate-code/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/sales-associate-code/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/sales-associate-code/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/sales-associate-code/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/sales-associate-code/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/sales-associate-code/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/sales-associate-code/docs/guides/enable-cart-transfer-between-devices)\n\n[Force stock availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code/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/sales-associate-code/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/sales-associate-code/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/sales-associate-code/docs/guides/enable-partial-cancellation)\n\n[Hide cancellation buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code/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/sales-associate-code/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/sales-associate-code/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/sales-associate-code/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code/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/sales-associate-code/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/sales-associate-code/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code/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/sales-associate-code/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code/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/sales-associate-code/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/sales-associate-code/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/sales-associate-code/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/sales-associate-code/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/sales-associate-code/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/sales-associate-code/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/sales-associate-code/docs/guides/enable-cart-transfer-between-devices)\n\n[Force stock availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code/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/sales-associate-code/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/sales-associate-code/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/sales-associate-code/docs/guides/enable-partial-cancellation)\n\n[Hide cancellation buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code/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/sales-associate-code/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/sales-associate-code/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/sales-associate-code/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code/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/sales-associate-code/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/sales-associate-code/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/sales-associate-code/docs/guides/how-to-customize-vtex-sales-app)\n\n[Enable the sales associate code](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code/docs/guides/sales-associate-code)\n\nEnable the sales associate code\n\nLearn how to enable the sales associate code.\n\n> The sales associate code is enabled by default for stores that start using the VTEX Sales App. This article is intended for stores that may have disabled this field due to customizations. To retrieve the sales associate code, use the [Get order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version%23get-/api/orders/pvt/document/-orderId-) endpoint and check the `salesAssociateId` value inside the `merchantContextData` object.\n\nThe sales associate code field is an additional customization of the [**Observation** field](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/enable-the-remarks-field-in-the-order-screen) that turns this component into a field where vendors should insert their code during the purchase flow.\n\nOnce enabled, this field becomes a mandatory step in the purchase flow, meaning that the order can only be completed if the `sales associate code` field is filled with a personal code.\n\n\n\n## Prerequisites\n\nBefore customizing the **sales associate code** field, you must enable the **Observation** field on VTEX Sales App. Check [this article](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/enable-the-remarks-field-in-the-order-screen) to learn how to do that.\n\n## Edit the `checkout-instore-custom.js` file\n\nAfter enabling the **Observation** field, you should [configure the sales associate code](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-sales-app-customizations--1z9kBm12oBPyVNDo1ivVc2/5kNtS80hbBGg58jMeF8CRv) by editing the `checkout-instore-custom.js` file.\n\nYou can configure the JavaScript file according to your needs, using different value combinations for the three properties: `type`, `skipValidation`, and `mask`.\n\n`` 1\n\n{ \n\n2\n\n \"data\": { \n\n3\n\n \"0-0\": \"`type`\", \n\n4\n\n \"1-0\": \"`skipValidation`\", \n\n5\n\n \"2-0\": \"`mask`\", \n\n6\n\n \"h-0\": \"Property\", \n\n7\n\n \"0-1\": \"string\", \n\n8\n\n \"0-2\": \"Defines the ‘vendors’ field format. The possible values are `text` and `textarea`, for big text blocks. `input`, a text field for simple keys. `select`, showing a combobox to quickly select.\", \n\n9\n\n \"1-1\": \"boolean\", \n\n10\n\n \"2-2\": \"A regular variable expression that applies a validation logic to the type property value. In other words, the person responsible for editing the `window.INSTORE_CONFIG` object can create the variable expression they find most appropriate for the sales rep code.\", \n\n11\n\n \"1-2\": \"Activates the validation performed via Master Data.\", \n\n12\n\n \"2-1\": \"string\", \n\n13\n\n \"h-2\": \"Description\", \n\n14\n\n \"h-1\": \"Type\", \n\n15\n\n \"3-0\": \"`autofill`\", \n\n16\n\n \"3-1\": \"boolean\", \n\n17\n\n \"3-2\": \"Defines whether VTEX Sales App will automatically insert the sales associate code when the Social Selling feature is active.\\n\\nWhen this value is `true` (default), the vendor code is automatically filled by VTEX Sales App.\\n\\nWhen this value is `false`, the operator must inform the vendor code manually.\\n\\nThis flag does not change any behavior when Social Selling is not activated.\" \n\n18\n\n }, \n\n19\n\n \"cols\": 3, \n\n20\n\n \"rows\": 4 \n\n21\n\n} \n\n ``\n\n> Even though all properties are not mandatory, the JavaScript file must have at least one of them described in the code.\n\nOtherwise, the customization will fail. To fill the `mask` field, you must create a [regular expression](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular%5FExpressions). As the sales associate code is built on JavaScript, your regular expression should follow the same programming language as well.\n\nIn VTEX, the JavaScript regular expressions follow the ECMAScript flavor. Check the step-by-step guide to constructing a regular expression according to this pattern in the [Mozilla documentation](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global%5FObjects/RegExp).\n\n> Once the regular expression is complete, a pro tip is to analyze the mask field functioning on a test workspace before deploying the code on the master. We recommend testing it on [Regular Expressions 101](https://read.calvincode.net/reader?url=https://regex101.com/).\n\n### Example code\n\n`1\n\nwindow.INSTORE_CONFIG = { \n\n2\n\n noteAsVendorCode: { \n\n3\n\n type: 'input', \n\n4\n\n skipValidation: true, \n\n5\n\n mask: '^(HE|TU)[A-Za-z0-9]{5,8}$', \n\n6\n\n autofill: false, \n\n7\n\n }, \n\n8\n\n} \n\n`\n\n### Use cases\n\n* **Validation according to sales associate's document ID**: in this example, the regular expression applied in the mask expresses that the code has three numbers and two letters.\n\n`1\n\nwindow.INSTORE_CONFIG = { \n\n2\n\n noteAsVendorCode: { \n\n3\n\n type: 'text', \n\n4\n\n skipValidation: true, \n\n5\n\n mask: '^\\\\d{3}[a-zA-Z]{2}$', \n\n6\n\n autofill: false, \n\n7\n\n }, \n\n8\n\n} \n\n`\n\n* **Validation only on Master Data**: the following regular expression doesn't have any mask applied on the JS file, which means that the system will proceed with the Master Data's validation.\n\n`1\n\nwindow.INSTORE_CONFIG = { \n\n2\n\n noteAsVendorCode: { \n\n3\n\n type: 'text', \n\n4\n\n skipValidation: false, \n\n5\n\n autofill: false, \n\n6\n\n }, \n\n7\n\n} \n\n`\n\n* **Validation according to the mask only**: in this example, the regular expression applied in the mask expresses that the code has two numbers.\n\n`1\n\nwindow.INSTORE_CONFIG = { \n\n2\n\n noteAsVendorCode: { \n\n3\n\n type: 'text', \n\n4\n\n skipValidation: true, \n\n5\n\n mask: '^\\\\d{2}$', \n\n6\n\n autofill: false, \n\n7\n\n }, \n\n8\n\n} \n\n`\n\n> In case of doubt, contact Customer Excellence by creating a [support ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/abrir-chamados-para-o-suporte-vtex--16yOEqpO32UQYygSmMSSAM).\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/sales-associate-code.md)\n\n[Enable the Observation field in the order screen« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code//docs/guides/enable-the-remarks-field-in-the-order-screen)[Enable cart transfer and capture between devicesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code//docs/guides/enable-cart-transfer-between-devices)\n\nContributors\n\n2\n\n[](https://github.com/Isabella-Veloso)\n\n[](https://github.com/karenkrieger)\n\nON THIS PAGE\n\n[Prerequisites](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code/docs/guides/sales-associate-code%23prerequisites)\n\n[Edit the checkout-instore-custom.js file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code/docs/guides/sales-associate-code%23edit-the-checkout-instore-customjs-file)\n\n[Example code](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code/docs/guides/sales-associate-code%23example-code)[Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code/docs/guides/sales-associate-code%23use-cases)\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/sales-associate-code.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/sales-associate-code/docs/guides/sales-associate-code%23prerequisites)\n\n[Edit the checkout-instore-custom.js file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code/docs/guides/sales-associate-code%23edit-the-checkout-instore-customjs-file)\n\n[Example code](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code/docs/guides/sales-associate-code%23example-code)[Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sales-associate-code/docs/guides/sales-associate-code%23use-cases)\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_838ae614
|
[
{
"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 storefront getting started with lighthouse 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/storefront-getting-started-with-lighthouse/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/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/storefront-getting-started-with-lighthouse/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/storefront-getting-started-with-lighthouse/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/storefront-getting-started-with-lighthouse/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/storefront-getting-started-with-lighthouse/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/storefront-getting-started-with-lighthouse/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/storefront-getting-started-with-lighthouse/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/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/storefront-getting-started-with-lighthouse/docs/guides/storefront-best-practices)\n\n[Accessibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/storefront-accessibility)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/storefront-analytics)\n\n[Performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/storefront-performance)\n\n[Getting started with Lighthouse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/storefront-getting-started-with-lighthouse)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/storefront-seo)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/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/storefront-getting-started-with-lighthouse/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/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/storefront-getting-started-with-lighthouse/docs/guides/storefront-best-practices)\n\n[Accessibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/storefront-accessibility)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/storefront-analytics)\n\n[Performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/storefront-performance)\n\n[Getting started with Lighthouse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/storefront-getting-started-with-lighthouse)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/storefront-seo)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/storefront-development)\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/storefront-best-practices)\n\n[Performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/storefront-performance)\n\n[Getting started with Lighthouse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/storefront-getting-started-with-lighthouse)\n\nGetting started with Lighthouse\n\nExplore how to leverage Google Lighthouse to improve your store's overall performance.\n\n \n\nHow users experience your website directly impacts relevant ecommerce metrics, such as user session time and sales conversion rate. Adopting the right tools and strategies to understand how shoppers perceive and interact with your website is important to improving your store performance. One of the most cutting-edge tools available for assessing your website performance from the user's point of view is [Google Lighthouse](https://read.calvincode.net/reader?url=https://developer.chrome.com/docs/lighthouse/overview).\n\nIn this guide, learn how [Google Lighthouse](https://read.calvincode.net/reader?url=https://developer.chrome.com/docs/lighthouse/overview) can help you to optimize your website.\n\n## Lighthouse overview\n\n[Lighthouse](https://read.calvincode.net/reader?url=https://developer.chrome.com/docs/lighthouse/overview) is a free, open-source tool developed by Google that identifies common issues and provides insights into a website performance, usability, and overall quality.\n\nBy auditing a web app URL, Lighthouse generates detailed reports detailing how the page performs based on web standards and developers' best practices. These insights help enhance the website quality and user experience.\n\nLighthouse audits are grouped into five categories:\n\n* [**Performance**](https://read.calvincode.net/reader?url=https://web.dev/lighthouse-performance): Evaluates how users perceive and experience a web page by testing key web metrics.\n* [**Accessibility**](https://read.calvincode.net/reader?url=https://web.dev/lighthouse-accessibility/): Assesses the page usability for people with disabilities or impairments.\n* [**SEO**](https://read.calvincode.net/reader?url=https://web.dev/lighthouse-seo/): Checks if the page is optimized for search engine results ranking.\n* [**Best practices**](https://read.calvincode.net/reader?url=https://web.dev/lighthouse-best-practices/): Assesses the overall code health of a webpage. Lighthouse also runs checks for best practices in modern web development, focusing on security aspects.\n\n## Running Lighthouse audits\n\nYou can conduct a Lighthouse audit in different ways: using [PageSpeed Insights](https://read.calvincode.net/reader?url=https://pagespeed.web.dev/), [Chrome DevTools](https://read.calvincode.net/reader?url=https://developer.chrome.com/docs/lighthouse/overview/%23devtools), the [command line](https://read.calvincode.net/reader?url=https://developer.chrome.com/docs/lighthouse/overview/%23cli), or a [Chrome extension](https://read.calvincode.net/reader?url=https://developer.chrome.com/docs/lighthouse/overview/%23extension).\n\n> Although Lighthouse is a powerful tool for inspecting web page quality, it operates only at the URL level. To ensure comprehensive coverage of the web page quality, we strongly recommend testing at least the Home page, a Product Details Page (PDP), and a Collection page of your store.\n\n### FastStore WebOps - Lighthouse scores\n\nFor stores using [FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore), you can run Lighthouse audit using the methods presented in the previous section. You can also streamline your web audits by using the [Lighthouse scores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-dashboard%23lighthouse-scores) tool for the [FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project) app.\n\n\n\nChecking these reports helps you keep track of how each PR affects your store performance, SEO, and accessibility.\n\nLighthouse reports is a native WebOps tool. For more information about using this tool, see the [Lighthouse scores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-dashboard%23lighthouse-scores) documentation.\n\n## Performance audit\n\nWhen you submit a URL to Lighthouse to audit your web page performance, it creates a report with the following information:\n\n* [**Performance score and metrics**](#performance-score-and-metrics): A weighted average of _Metrics scores_ and results of independent metrics that aim to represent the user's perception of performance.\n* [**Opportunities**](#opportunities): Suggestions and documentation on how to improve page load speed, with estimated potential savings.\n* [**Diagnostics**](#diagnostics): Additional guidance that developers can explore to further enhance page performance.\n* [**Passed audits**](#passed-audits): Suggestions from _Opportunities_ and _Diagnostics_ that have already been implemented on the page.\n* [**Additional information**](#additional-information): Details about the sampled data, including the data collection period, devices used for emulation, Chrome version, etc.\n\nIn general, only **Metrics** — not the outcomes of **Opportunities** and **Diagnostics** — directly affect the overall **Performance score**. However, there is an indirect relationship because implementing the suggestions from Opportunities and Diagnostics will likely improve the Metric scores as well.\n\n### Performance score and metrics\n\nThe Lighthouse **Performance score** provides an estimated representation of user perception of performance. While a computer may define performance by the time it takes for the entire page to load, this specific metric doesn't always reflect what the user values. From the user's point of view, performance is a perception of how they experience the page loading and how responsive it feels during use.\n\nTo ensure Lighthouse metrics are relevant to users, they are structured around a few key questions:\n\n\n\n1. **Is it happening?** When the first visual activities occur and the user notices that the page is loading. If the server doesn't respond quickly, the user may feel there is a problem and leave the page.\n2. **Is it useful?** When enough valuable content is rendered. This moment can keep the user engaged.\n3. **Is it usable?** When the UI seems ready for interaction. This moment can be frustrating if users try to interact with visible content but the page is still processing.\n4. **Is it delightful?** The moment after loading that guarantees smooth and lag-free interactions.\n\nGiven these four moments during the page load journey, a series of individual metrics were created to reflect what could be relevant for users in each moment. These metrics include the time it takes for the first contentful paint to be displayed and for the page to become interactive. A weighted average of these metrics determines the final Lighthouse **Performance score**:\n\n| Audit | Weight |\n| ------------------------------------------------------------------- | ------ |\n| [Total Blocking Time (TBT)](#total-blocking-time-tbt--30) | 30% |\n| [Largest Contentful Paint (LCP)](#largest-contentful-paint-lcp--25) | 25% |\n| [Cumulative Layout Shift (CLS)](#cumulative-layout-shift-cls--25) | 25% |\n| [First Contentful Paint (FCP)](#first-contentful-paint-fcp--10) | 10% |\n| [Speed Index (SI)](#speed-index-si--10) | 10% |\n\nThe following sections briefly explain each of these metrics. Notice that the **Total Blocking Time**, **Largest Contentful Paint**, and **Cumulative Layout Shift** have higher weights and, consequently, a greater impact on the overall **performance score**. Therefore, paying close attention to these two metrics is essential.\n\n> Due to frequent adjustments to Google's ranking formula, the overall **performance score** may vary over time. To stay up to date with Lighthouse's latest updates, we recommend visiting the [Lighthouse performance scoring](https://read.calvincode.net/reader?url=https://developer.chrome.com/docs/lighthouse/performance/performance-scoring) article.\n\nWhen running Lighthouse, you will notice that the metric results follow a color code based on the following ranges:\n\n| Code | Meaning | Range |\n| ---- | ----------------- | ------ |\n| ▲ | Poor | 0–49 |\n| ■ | Needs improvement | 50–89 |\n| ● | Good | 90–100 |\n\n#### Total Blocking Time (TBT) | 30%\n\nThe [**Total Blocking Time (TBT)**](https://read.calvincode.net/reader?url=https://web.dev/lighthouse-total-blocking-time/) is the amount of time between the [**First Contentful Paint (FCP)**](https://read.calvincode.net/reader?url=https://developer.chrome.com/docs/lighthouse/performance/first-contentful-paint) and [**Time to Interactive (TTI)**](https://read.calvincode.net/reader?url=https://developer.chrome.com/docs/lighthouse/performance/interactive) during which user inputs, such as mouse clicks, screen taps, or keyboard presses, are blocked. When a page has a long TBT, the user may notice the delay and perceive the page as sluggish.\n\n\n\nUser interaction is blocked when a long task blocks the main thread and prevents the browser from responding to other requests. Blocking time starts to count after 50ms. For example, if a function takes 150ms to execute, the blocking time would be 100ms. Therefore, the **Total Blocking Time** of a page is the sum of the blocking time for each long task that occurs during page load.\n\nSee below how Lighthouse classifies TBT times:\n\n| TBT time (milliseconds) | Color-coding |\n| ----------------------- | ------------------- |\n| Over 600 | ▲ Poor |\n| 200 – 600 | ■ Needs improvement |\n| 0 – 200 | ● Good |\n\nTBT is mainly affected by the parsing and execution of JavaScript and third-party scripts. Besides removing or reducing JavaScript code, you can improve TBT by splitting long tasks into smaller ones, improving code efficiency, and implementing lazy loading.\n\n> For more information about improving TBT, see [Google's guidelines](https://read.calvincode.net/reader?url=https://web.dev/lighthouse-total-blocking-time/%23how-to-improve-your-tbt-score).\n\n#### Largest Contentful Paint (LCP) | 25%\n\n[**Largest Contentful Paint (LCP)**](https://read.calvincode.net/reader?url=https://web.dev/lcp/) measures the time it takes to render the largest visible element on the page within the viewport. Fast LCPs help reassure the user that the page is useful.\n\n| LCP time (seconds) | Color-coding |\n| ------------------ | ------------------- |\n| Over 4 | ▲ Poor |\n| 2.5–4 | ■ Needs improvement |\n| 0–2.5 | ● Good |\n\nThe metric only considers the loading time of elements significantly relevant to the user experience, such as:\n\n* `<img />` elements,\n* `<image>` elements inside an `<svg>` element.\n* `<video>` elements.\n* Elements with a background image loaded via the `url()` function.\n* Block-level elements, such as `<h1>`, `<h2>`, `<div>`, `<ul>`, `<table>`, etc.\n\nLCP is primarily affected by the following factors:\n\n* Long server response times.\n* Render-blocking resources, such as CSS stylesheets, font files, and JavaScript scripts.\n* Resource size and load time.\n* Client-side rendering.\n\n> For more information about how to improve LCP, see [Google's guidelines](https://read.calvincode.net/reader?url=https://web.dev/fcp/%23how-to-improve-fcp).\n\n#### Cumulative Layout Shift (CLS) | 25%\n\nThe [**Cumulative Layout Shift (CLS)**](https://read.calvincode.net/reader?url=https://web.dev/cls/) metric measures the impact of undesired content shifts that occur during the entire lifespan of a page.\n\nA layout shift occurs when a visible element changes its initial position from one rendered frame to the next. A website with a low CLS has a steady page display without any elements shifting around. A high CLS may annoy users and affect how they interact with the page, causing them to click an unwanted button or link.\n\n\n\n| CLS | Color-coding |\n| ---------- | ------------------- |\n| Over 0.25 | ▲ Poor |\n| 0.1 – 0.25 | ■ Needs improvement |\n| 0 – 0.1 | ● Good |\n\nThis metric is mostly affected by images, ads, embeds, iframes without predefined dimensions, and by content dynamically inserted by JavaScript on the client side (e.g., a bar that suddenly appears in the header).\n\n> For more information about improving CLS, see [Google's guidelines](https://read.calvincode.net/reader?url=https://web.dev/cls/%23how-to-improve-cls).\n\n#### First Contentful Paint (FCP) | 10%\n\n[**First Contentful Paint (FCP)**](https://read.calvincode.net/reader?url=https://web.dev/fcp/) measures the time it takes for the browser to render the first piece of content from the Document Object Model (DOM). Short FCP times mean fast visual activity from the browser. They reassure the user that something is happening during the page load and, therefore, increase the chance of keeping users engaged.\n\n\n\nSee below how Lighthouse classifies FCP times:\n\n| FCP time (seconds) | Color-coding |\n| ------------------ | ------------------- |\n| Over 3 | ▲ Poor |\n| 1.8–3 | ■ Needs improvement |\n| 0–1.8 | ● Good |\n\nThe FCP affects most of the other metrics and serves as a huge red flag if it is taking too long. This metric can be affected by:\n\n* Long server response times.\n* Render-blocking resources, such as CSS stylesheets, font files, and JavaScript scripts.\n* Script-based elements above the fold.\n* Large DOM trees.\n* Multiple 301 redirects.\n\n> For more information about improving FCP, see [Google's guidelines](https://read.calvincode.net/reader?url=https://web.dev/fcp/%23how-to-improve-fcp).\n\n#### Speed Index (SI) | 10%\n\nThe [**Speed Index (SI)**](https://read.calvincode.net/reader?url=https://web.dev/speed-index/) indicates how quickly a page's elements become visible in the viewport. The Speed Index is a synthetic value that calculates the visual differences between frames captured during the page load. Until all content is visible, each frame is scored considering its visual completeness. These individual scores are then summed to determine the page's Speed Index.\n\n\n\nSee below how Lighthouse classifies SI times:\n\n| SI time (seconds) | Color-coding |\n| ----------------- | ------------------- |\n| 0ver 5.8 | ▲ Poor |\n| 3.4–5.8 | ■ Needs improvement |\n| 0–3.4 | ● Good |\n\nThe Speed Index is a unified metric that considers many other metrics and audits, which can help you figure out whether your page speed optimizations are working. Generally, most improvements to your page's [First Contentful Paint](#first-contentful-paint-fcp--10) and [Largest Contentful Paint](#largest-contentful-paint-lcp--25) are also likely to improve the _Speed Index_.\n\n> For more information about improving SI, see [Google's guidelines](https://read.calvincode.net/reader?url=https://web.dev/speed-index/%23how-to-improve-your-speed-index-score).\n\n### Opportunities\n\nThe **Opportunities** section provides insights that could potentially help your page load faster. The priority level of each opportunity is indicated by the same color coding used for the metrics. High priorities are indicated by red triangles, medium priorities by orange squares, and low priorities by gray circles.\n\nUse the **Opportunities** section to determine which improvements will benefit your page the most. The more significant the opportunity, the more likely it is to affect your **performance score**.\n\nClick each opportunity to get detailed information and documentation about fixing the related issues. Also, notice that unless you have a specific reason for focusing on a particular metric, it's usually better to focus on improving your overall **performance score**.\n\n### Diagnostics\n\nThe **Diagnostics** section provides more information about the performance of your application. It indicates the largest contentful paint element on your page, lists the longest tasks on the main thread, and displays the cache lifetime, among other useful details.\n\nOnce again, the details presented in this section do not directly affect the **performance score** but are likely to improve the metric values if considered.\n\n### Passed audits\n\nThe **Passed audits** section lists all the audits that the page passed. Once you implement the suggestions from Opportunities and Diagnostics, you can retest your page to see if they now appear in the Passed Audits section.\n\n### Additional information\n\nThe **Additional information** section shares the following details about the sampled data:\n\n* Data collection period\n* Visit durations\n* Devices\n* Network connections\n* Sample size\n* Chrome version\n\n\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\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/storefront-best-practices/storefront-getting-started-with-lighthouse.md)\n\n[Performance« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse//docs/guides/storefront-performance)[SEONext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse//docs/guides/storefront-seo)\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Lighthouse overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/storefront-getting-started-with-lighthouse%23lighthouse-overview)\n\n[Running Lighthouse audits](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/storefront-getting-started-with-lighthouse%23running-lighthouse-audits)\n\n[FastStore WebOps - Lighthouse scores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/storefront-getting-started-with-lighthouse%23faststore-webops-lighthouse-scores)\n\n[Performance audit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/storefront-getting-started-with-lighthouse%23performance-audit)\n\n[Performance score and metrics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/storefront-getting-started-with-lighthouse%23performance-score-and-metrics)[Opportunities](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/storefront-getting-started-with-lighthouse%23opportunities)[Diagnostics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/storefront-getting-started-with-lighthouse%23diagnostics)[Passed audits](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/storefront-getting-started-with-lighthouse%23passed-audits)[Additional information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/storefront-getting-started-with-lighthouse%23additional-information)\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/storefront-best-practices/storefront-getting-started-with-lighthouse.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Lighthouse overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/storefront-getting-started-with-lighthouse%23lighthouse-overview)\n\n[Running Lighthouse audits](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/storefront-getting-started-with-lighthouse%23running-lighthouse-audits)\n\n[FastStore WebOps - Lighthouse scores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/storefront-getting-started-with-lighthouse%23faststore-webops-lighthouse-scores)\n\n[Performance audit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/storefront-getting-started-with-lighthouse%23performance-audit)\n\n[Performance score and metrics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/storefront-getting-started-with-lighthouse%23performance-score-and-metrics)[Opportunities](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/storefront-getting-started-with-lighthouse%23opportunities)[Diagnostics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/storefront-getting-started-with-lighthouse%23diagnostics)[Passed audits](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/storefront-getting-started-with-lighthouse%23passed-audits)[Additional information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-getting-started-with-lighthouse/docs/guides/storefront-getting-started-with-lighthouse%23additional-information)\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_99cdea77
|
[
{
"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 indicating alternate pages in cross border stores 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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Checking your store's binding ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores/docs/guides/checking-your-stores-binding-id)\n\n[Creating robots files for cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores)\n\n[Cross-border store content internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores/docs/guides/cross-border-custom-urls-1)\n\n[Managing landing pages in cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores/docs/guides/vtex-io-documentation-managing-landing-pages-in-cross-border-stores)\n\n[Indicating alternate versions of localized pages in cross border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Checking your store's binding ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores/docs/guides/checking-your-stores-binding-id)\n\n[Creating robots files for cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores)\n\n[Cross-border store content internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores/docs/guides/cross-border-custom-urls-1)\n\n[Managing landing pages in cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores/docs/guides/vtex-io-documentation-managing-landing-pages-in-cross-border-stores)\n\n[Indicating alternate versions of localized pages in cross border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/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-indicating-alternate-pages-in-cross-border-stores/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores/docs/guides/store-framework)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Indicating alternate versions of localized pages in cross border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores)\n\nIndicating alternate versions of localized pages in cross-border stores\n\nLearn how to indicate alternate versions of localized pages.\n\nIn this guide, you'll learn how to indicate alternate versions of localized landing pages in cross-border stores to improve SEO and ensure search engines display the correct content for each region.\n\nIf your store operates in multiple regions and you have different versions of a [landing page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page) for each, you should link them as alternate versions. This practice helps search engines understand the relationship between your localized pages, ensuring they serve the right content to the right audience and improving your store SEO.\n\nWhen you indicate alternate versions, you must do so in pairs. For example, if you point the US version of a page to a Brazilian one, the Brazilian page must also point back to the US version. This reciprocal linking enables search engines to accurately map the relationship between them, thereby preventing indexing errors.\n\n\n\nFollow the steps below for each localized version of your landing page.\n\n## Instructions\n\n### Step 1 - Getting the route information\n\n1. In your terminal, [install](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app) the `vtex.admin-graphql-ide@3.x` app.\n2. In the Admin, go to **Store Settings > Store > GraphQL IDE**.\n3. From the GraphQL IDE dropdown list, choose the `vtex.rewriter` app.\n4. Run the following query to get the internal data for the page path you want to update:\n\n`1\n\n{ \n\n2\n\n internal { \n\n3\n\n get(path: \"/{URL}\") { \n\n4\n\n from \n\n5\n\n declarer \n\n6\n\n type \n\n7\n\n id \n\n8\n\n binding \n\n9\n\n } \n\n10\n\n } \n\n11\n\n} \n\n`\n\n⚠️ Replace the values inside the curly brackets based on your scenario.\n\n1. Save the returned data.\n\n### Step 2 - Updating the route\n\n1. Clear the previous query and use the following mutation.\n\n`1\n\nmutation saveInternal($args: InternalInput!) { \n\n2\n\n internal { \n\n3\n\n save(route: $args) { \n\n4\n\n id \n\n5\n\n } \n\n6\n\n } \n\n7\n\n} \n\n`\n\n1. At the bottom of the page, click **Query Variables**.\n2. Complete the Query Variables section following the example below:\n\n`1\n\n{ \n\n2\n\n \"args\": { \n\n3\n\n \"from\": \"/US/about-us\", \n\n4\n\n \"declarer\": \"vtex.store@2.x\", \n\n5\n\n \"type\": \"userRoute\", \n\n6\n\n \"id\": \"vtex.store@2.x:store.custom::us-about-us\", \n\n7\n\n \"binding\": \"748aafcf-3572-456d-5dec-6ddb3f26e43f\", \n\n8\n\n \"alternates\": [ \n\n9\n\n { \n\n10\n\n \"binding\": \"7cf37a3b-efc0-4e47-8201-d8b58kd4d3fd\", \n\n11\n\n \"path\": \"/BR/sobre-nos\" \n\n12\n\n }, \n\n13\n\n { \n\n14\n\n \"binding\": \"8cf37a3b-edc0-4a47-8241-d8b58kfsd3fd\", \n\n15\n\n \"path\": \"/UK/about-us\" \n\n16\n\n } \n\n17\n\n ] \n\n18\n\n } \n\n19\n\n} \n\n`\n\n* For the `from`, `declarer`, `type`, and `binding` fields, use the information you obtained in the [previous section](#getting-the-route-information).\n* In the `id` field, always set its value from the main binding, even if you're updating the secondary binding's route. This keeps a single canonical reference and prevents duplicate or conflicting entries across bindings. For example, if the main binding has the About Us page at `/US/about-us` with the id `vtex.store@2.x:store.custom::us-about-us`, use that same id for the secondary binding's route like `/BR/sobre-nos` to ensure consistency.\n* In the `alternates` field, provide the `binding` and `path` for each alternate landing page. \n> If you don't know the `binding` values of your stores, follow [this instruction guide on checking your account's binding IDs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-your-stores-binding-id).\n1. Click `Run` to apply the changes.\n\nRepeat this entire process for each alternate version of the landing page, updating the path in the initial query each time.\n\nContributors\n\n2\n\n[](https://github.com/barbara-celi)\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/vtex-io-cross-border-stores/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores.md)\n\n[Managing landing pages in cross-border stores« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores//docs/guides/vtex-io-documentation-managing-landing-pages-in-cross-border-stores)[Handling internationalizationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores//docs/guides/vtex-io-multi-language-stores)\n\nContributors\n\n2\n\n[](https://github.com/barbara-celi)\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-indicating-alternate-pages-in-cross-border-stores/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores%23instructions)\n\n[Step 1 - Getting the route information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores%23step-1-getting-the-route-information)[Step 2 - Updating the route](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores%23step-2-updating-the-route)\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/vtex-io-cross-border-stores/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores.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-indicating-alternate-pages-in-cross-border-stores/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores%23instructions)\n\n[Step 1 - Getting the route information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores%23step-1-getting-the-route-information)[Step 2 - Updating the route](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores%23step-2-updating-the-route)\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_8c743778
|
[
{
"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 minimumtheme 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.minimumtheme/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minimumtheme/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.minimumtheme/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.minimumtheme/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.minimumtheme/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.minimumtheme/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.minimumtheme/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minimumtheme/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minimumtheme/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minimumtheme/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minimumtheme/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minimumtheme/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minimumtheme/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minimumtheme/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minimumtheme/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.minimumtheme/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.minimumtheme/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minimumtheme/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minimumtheme/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minimumtheme/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minimumtheme/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minimumtheme/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minimumtheme/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minimumtheme/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minimumtheme/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minimumtheme/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minimumtheme/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minimumtheme/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minimumtheme/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minimumtheme/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minimumtheme/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minimumtheme/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.minimumtheme/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.minimumtheme/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.minimumtheme/docs/vtex-io-apps)\n\nMinimum Boilerplate Theme\n\nOfficial extension\n\nVersion: 0.1.2\n\nLatest version: 0.1.2\n\nThe minimum Boilerplate Theme is basic store front model based on the VTEX IO Store Framework.\n\nIt should be used only when you want to start a new store theme without any pre-set configurations, as is the case with [Store Theme](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-theme).\n\nWhile Store Theme gives developers a ready-to-go default store front structure, the Minimum Boilerplate Theme will enable you to build you store freely from scratch.\n\n## Configuration\n\n### Step 1 - Basic setup\n\nAccess the VTEX IO [basic setup guide](https://read.calvincode.net/reader?url=https://vtex.io/docs/getting-started/build-stores-with-store-framework/1) and follow all the given steps.\n\nBy the end of the setup, you should have the VTEX command line interface (Toolbelt) installed along with a developer workspace you can work in.\n\n### Step 2 - Cloning the Minimum Boilerplate Theme repository\n\n[Clone](https://read.calvincode.net/reader?url=https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) this repository to your local files to be able to effectively start working on it.\n\nThen, access the repository's directory using your terminal.\n\n### Step 3 - Editing the `Manifest.json`\n\nOnce in the repository directory, it is time to edit the Minimum Boilerplate `manifest.json` file.\n\nOnce you are in the file, you must replace the `vendor` and `account` values. `vendor` is the account name you are working on and `account` is anything you want to name your theme. For example:\n\n`1\n\n{ \n\n2\n\n \"vendor\": \"storecomponents\", \n\n3\n\n \"name\": \"my-test-theme\", \n\n4\n\n} \n\n`\n\n### Step 4 - Installing required apps\n\nIn order to use Store Framework and work on your store theme, it is needed to have both `vtex.store-sitemap` and `vtex.store` installed.\n\nRun `vtex list` and check whether those apps are already installed.\n\nIf they aren't, run the following command to install them: `vtex install vtex.store-sitemap vtex.store -f`\n\n### Step 5 - Uninstalling any existing theme\n\nBy running `vtex list`, you can verify if any theme is installed.\n\nIt is common to already have a `vtex.store-theme` installed when you start the store's front development process.\n\nTherefore, if you find it in the app's list, copy its name and use it together with the command `vtex uninstall`. For example:\n\n`1\n\nvtex uninstall vtex.store-theme \n\n`\n\n### Step 6- Run and preview your store\n\nThen time has come to upload all the changes you made in your local files to the platform. For that, use the `vtex link` command.\n\nIf the process runs without any errors, the following message will be displayed: `App linked successfully`. Then, run the `vtex browse` command to open a browser window having your linked store in it.\n\nThis will enable you to see the applied changes in real time, through the account and workspace in which you are working.\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.minimumtheme/docs/apps/vtex.minimumtheme%23configuration)\n\n[Step 1 - Basic setup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minimumtheme/docs/apps/vtex.minimumtheme%23step-1-basic-setup)[Step 2 - Cloning the Minimum Boilerplate Theme repository](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minimumtheme/docs/apps/vtex.minimumtheme%23step-2-cloning-the-minimum-boilerplate-theme-repository)[Step 3 - Editing the Manifest.json](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minimumtheme/docs/apps/vtex.minimumtheme%23step-3-editing-the-manifestjson)[Step 4 - Installing required apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minimumtheme/docs/apps/vtex.minimumtheme%23step-4-installing-required-apps)[Step 5 - Uninstalling any existing theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minimumtheme/docs/apps/vtex.minimumtheme%23step-5-uninstalling-any-existing-theme)[Step 6- Run and preview your store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minimumtheme/docs/apps/vtex.minimumtheme%23step-6-run-and-preview-your-store)\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_26b28e9d
|
[
{
"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 hero 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-hero/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-hero/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-hero/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-hero/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-hero/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-hero/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-hero/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-hero/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-hero/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/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-hero/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/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-hero/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-overview)\n\n[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-banner-text)\n\n[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-cart-sidebar)\n\n[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-empty-state)\n\n[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-filter-slider)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-filter)\n\n[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero)\n\n[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-image-gallery)\n\n[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-navbar-slider)\n\n[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-navbar)\n\n[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-newsletter)\n\n[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-out-of-stock)\n\n[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-payment-methods)\n\n[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-price-range)\n\n[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-product-grid)\n\n[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-product-shelf)\n\n[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-region-modal)\n\n[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-search-input)\n\n[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-shipping-simulation)\n\n[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/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-hero/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/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-hero/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-hero/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-hero/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-hero/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/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-hero/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-hero/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/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-hero/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-hero/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/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-hero/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/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-hero/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-overview)\n\n[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-banner-text)\n\n[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-cart-sidebar)\n\n[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-empty-state)\n\n[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-filter-slider)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-filter)\n\n[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero)\n\n[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-image-gallery)\n\n[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-navbar-slider)\n\n[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-navbar)\n\n[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-newsletter)\n\n[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-out-of-stock)\n\n[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-payment-methods)\n\n[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-price-range)\n\n[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-product-grid)\n\n[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-product-shelf)\n\n[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-region-modal)\n\n[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-search-input)\n\n[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-shipping-simulation)\n\n[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/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-hero/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/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-hero/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-hero/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-hero/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-hero/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/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-hero/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-hero/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-hero/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/components-index)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-overview)\n\nHero\n\nDisplays a full-width banner at the top of a webpage.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/organisms/Hero)\n\nThe `Hero` component is a full-width banner presented on the above-the-fold section of a web page. It serves as the first glimpse of your brand's identity and messaging.The `Hero` component is a compound of the following:\n\n* `HeroImage`: wraps the Hero image.\n* `HeroHeader`: wraps the Hero textual content. It may contain a title, description, and a call-to-action button.\n\nUse the `Hero` component as the first element of your Home, brand, or collections pages.\n\nExample\n\nCode\n\n\n\n# Explore more about our amazing products\n\nAll the amazing products from the brands we partner with.\n\n[See more](/)\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { Hero, HeroImage, HeroHeader } 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/Hero/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### Variants\n\n#### Primary\n\nExample\n\nCode\n\n\n\n# Explore more about our amazing products\n\nAll the amazing products from the brands we partner with.\n\n[See more](/)\n\n#### Secondary\n\nExample\n\nCode\n\n\n\n# Explore more about our amazing products\n\nAll the amazing products from the brands we partner with.\n\n[See more](/)\n\n### Color variants\n\n#### Light\n\nExample\n\nCode\n\n\n\n# Explore more about our amazing products\n\nAll the amazing products from the brands we partner with.\n\n[See more](/)\n\n#### Accent\n\nExample\n\nCode\n\n\n\n# Explore more about our amazing products\n\nAll the amazing products from the brands we partner with.\n\n[See more](/)\n\n---\n\n## Design tokens\n\n| Local token | Default value/Global token linked |\n| --------------------------- | --------------------------------- |\n| \\--fs-hero-text-size | var(--fs-text-size-lead) |\n| \\--fs-hero-text-line-height | 1.33 |\n\n### Image\n\n| Local token | Default value/Global token linked |\n| ------------------------------ | --------------------------------- |\n| \\--fs-hero-image-border-radius | 0 |\n\n### Title\n\n| Local token | Default value/Global token linked |\n| ---------------------------- | ----------------------------------------- |\n| \\--fs-hero-title-padding | var(--fs-spacing-5) 0 var(--fs-spacing-6) |\n| \\--fs-hero-title-weight | var(--fs-text-weight-black) |\n| \\--fs-hero-title-line-height | 1.1 |\n\n### Subtitle\n\n| Local token | Default value/Global token linked |\n| ------------------------------------- | --------------------------------- |\n| \\--fs-hero-subtitle-margin-top-mobile | var(--fs-spacing-2) |\n| \\--fs-hero-subtitle-margin-top-tablet | var(--fs-spacing-4) |\n| \\--fs-hero-subtitle-size | var(--fs-hero-text-size) |\n| \\--fs-hero-subtitle-line-height | var(--fs-hero-text-line-height) |\n\n### Hierarchy\n\n#### Primary\n\n| Local token | Default value/Global token linked |\n| --------------------------------------- | --------------------------------- |\n| \\--fs-hero-primary-image-height-mobile | 15rem |\n| \\--fs-hero-primary-image-height-desktop | 29rem |\n| \\--fs-hero-primary-title-size | var(--fs-text-size-title-huge) |\n\n#### Secondary\n\n| Local token | Default value/Global token linked |\n| ----------------------------------------- | --------------------------------- |\n| \\--fs-hero-secondary-image-height-mobile | 11.25rem |\n| \\--fs-hero-secondary-image-height-desktop | 14.188rem |\n| \\--fs-hero-secondary-title-size | var(--fs-text-size-title-page) |\n\n---\n\n### Variants\n\n#### Main\n\n| Local token | Default value/Global token linked |\n| -------------------------- | --------------------------------- |\n| \\--fs-hero-main-bkg-color | var(--fs-color-primary-bkg) |\n| \\--fs-hero-main-text-color | var(--fs-color-primary-text) |\n\n#### Light\n\n| Local token | Default value/Global token linked |\n| --------------------------- | ----------------------------------- |\n| \\--fs-hero-light-bkg-color | var(--fs-color-secondary-bkg-light) |\n| \\--fs-hero-light-text-color | var(--fs-color-text-display) |\n\n#### Accent\n\n| Local token | Default value/Global token linked |\n| ---------------------------- | --------------------------------- |\n| \\--fs-hero-accent-bkg-color | var(--fs-color-highlighted-bkg) |\n| \\--fs-hero-accent-text-color | var(--fs-hero-light-text-color) |\n\n---\n\n## Data attributes\n\nYou can target and override `Hero` styles using the following data attributes:\n\n`data-fs-hero`\n\n`data-fs-hero-image`\n\n`data-fs-hero-heading`\n\n`data-fs-hero-wrapper`\n\n`data-fs-hero-title`\n\n`data-fs-hero-subtitle`\n\n`data-fs-hero-icon`\n\n`data-fs-hero-heading`\n\n`data-fs-hero-info`\n\n`data-fs-hero-variant=\"primary\" | \"secondary\"`\n\n`data-fs-hero-color-variant=\"main\" | \"light\" | \"accent\"`\n\n---\n\n## Props\n\nAll hero-related components support all attributes also supported by the `<div>` tag. Besides those attributes, the following props are also supported:\n\n### Hero\n\n| Name | Type | Description | Default | |\n| ---------------- | ------------------------ | -------------------------------------------------------------------------------------- | ---------------------------------------------------- | ---- |\n| **variant** | \"primary\" \\| \"secondary\" | Specifies the component variant. | primary | |\n| **colorVariant** | \"main\" \\| \"light\" | \"accent\" | Specifies the component's color variant combination. | main |\n| **testId** | string | ID to find this component in testing tools (e.g.: cypress, testing-library, and jest). | fs-hero | |\n\n### HeroImage\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-hero-image |\n\n### HeroHeader\n\n| Name | Type | Description | Default | | | | | | |\n| ------------------- | ---------------- | -------------------------------------------------------------------------------------- | --------------- | -- | ------------------------ | --------------------------- | ------------------- | ----------- | -------------------------------------------- |\n| **title\\*** | string | Content for the h1 tag. | | | | | | | |\n| **subtitle\\*** | string | Content for the p tag. | | | | | | | |\n| **icon** | string \\| number | false | true | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | Icon component for additional customization. |\n| **link** | string | Specifies the URL the action button goes to. | | | | | | | |\n| **linkText** | string | Specifies the action button's content. | | | | | | | |\n| **testId** | string | ID to find this component in testing tools (e.g.: cypress, testing library, and jest). | fs-hero-heading | | | | | | |\n| **linkTargetBlank** | false \\| true | Specify if the link opens in a new tab. | | | | | | | |\n\n---\n\n## Best Practices\n\n### ✅ Do's\n\n#### Content\n\n* Draw a clear connection between the Hero image and text.\n* Ensure the copy is legible on the top of the imagery.\n* Keep your message clear and connected with your visuals.\n\n#### Visual\n\n* Use strong contrasts to make call-to-action buttons stand out.\n* Follow your brand identity and guidelines. Remember that this is the first touchpoint shoppers will have with your brand.\n* Make your Hero component responsive.\n\n#### Image\n\n* Use optimized images for your Hero image to avoid harming your website performance. Notice that if the Hero banners take too long to load, they may lose efficacy.\n* Use an eye-catching image that adds value to your page. Hero images have a significant impact on your brand perception, website traffic, and sales conversion rate.\n\n### ❌ Don'ts\n\n* Don't exceed 2-3 lines for the Hero headline.\n* Don't use more than one Hero on a web page.\n* Don't use pixelated or blurry images.\n\n---\n\n## Accessibility\n\n* Use an `h1` or `h2` heading level for the headline.\n* Choose a hero image with a strong point of focus.\n* Ensure high color contrast for text over images\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/hero.mdx)\n\n[Filter« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-filter)[ImageGalleryNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-image-gallery)\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-hero/docs/guides/faststore/organisms-hero%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23examples)\n\n[Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23variants)[Color variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23color-variants)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23design-tokens)\n\n[Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23image)[Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23title)[Subtitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23subtitle)[Hierarchy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23hierarchy)[Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23variants)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23props)\n\n[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23hero)[HeroImage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23heroimage)[HeroHeader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23heroheader)\n\n[Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23best-practices)\n\n[✅ Do's](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23-dos)[❌ Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23-donts)\n\n[Accessibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%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/organisms/hero.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-hero/docs/guides/faststore/organisms-hero%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23examples)\n\n[Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23variants)[Color variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23color-variants)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23design-tokens)\n\n[Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23image)[Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23title)[Subtitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23subtitle)[Hierarchy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23hierarchy)[Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23variants)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23props)\n\n[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23hero)[HeroImage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23heroimage)[HeroHeader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23heroheader)\n\n[Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23best-practices)\n\n[✅ Do's](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23-dos)[❌ Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%23-donts)\n\n[Accessibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero/docs/guides/faststore/organisms-hero%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_6c74560d
|
[
{
"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 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/atoms-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/atoms-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/atoms-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/atoms-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/atoms-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/atoms-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/atoms-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/atoms-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/atoms-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-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/atoms-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-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/atoms-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-overview)\n\n[Badge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-badge)\n\n[Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-button)\n\n[Checkbox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-checkbox)\n\n[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-icon)\n\n[Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-input)\n\n[Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-label)\n\n[Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-link)\n\n[List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-list)\n\n[Loader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-loader)\n\n[Overlay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-overlay)\n\n[Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-price)\n\n[Radio](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-radio)\n\n[Select](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-select)\n\n[SROnly](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-sr-only)\n\n[Skeleton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-skeleton)\n\n[Slider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-slider)\n\n[Textarea](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-textarea)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-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/atoms-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/atoms-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/atoms-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/atoms-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-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/atoms-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/atoms-overview/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-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/atoms-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/atoms-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-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/atoms-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-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/atoms-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-overview)\n\n[Badge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-badge)\n\n[Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-button)\n\n[Checkbox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-checkbox)\n\n[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-icon)\n\n[Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-input)\n\n[Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-label)\n\n[Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-link)\n\n[List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-list)\n\n[Loader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-loader)\n\n[Overlay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-overlay)\n\n[Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-price)\n\n[Radio](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-radio)\n\n[Select](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-select)\n\n[SROnly](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-sr-only)\n\n[Skeleton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-skeleton)\n\n[Slider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-slider)\n\n[Textarea](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-textarea)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-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/atoms-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/atoms-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/atoms-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/atoms-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-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/atoms-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/atoms-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/atoms-overview/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/components-index)\n\nAtoms\n\n* [SuccessBadgeBadges are status descriptors used to emphasize an item's state.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-badge)\n* [PrimaryButtonButtons indicate actions that users can take, like adding an item to the cart.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-button)\n* [CheckboxCheckboxes allow users to toggle an option on or off.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-checkbox)\n* [IconIcons are simplified graphics used to represent concepts and help users navigate the UI.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-icon)\n* [InputFields used to get user inputs.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-input)\n* [LabelLabelDescribes the meaning of input fields.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-label)\n* Default \nLink \nPerforms the same behavior of a regular anchor tag (`a`), but can be used as any HTML tag and component.\n* [Great Unordered ListOk Unordered ListBad Unordered ListListLists group related content. They can be ordered or unordered.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-list)\n* [LoaderLoaders provide a visual cue that an action is being processed.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-loader)\n* [A content outside meOverlayOverlays provide contextual information on top of the current layer of the interface.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-overlay)\n* [62.5PriceUsed to display the price of a given product, discount and total values.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-price)\n* [RadioAllow users to select one option from a set.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-radio)\n* [GreatOkBadSelectSelect components allow users to pick an option from a predefined list.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-select)\n* [SkeletonImproves the store's experience and perceived performance through loading placeholders.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-skeleton)\n* [0500SliderAllows users to select a single value from a range.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-slider)\n* [visually hidden textSROnlyHides an element visually. Improve accessibility by providing text to screen readers when applied.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-sr-only)\n* [TextareaEnables users to input multi-line text. It's commonly used for longer user inputs, such as comments or descriptions.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-textarea)\n\nContributors\n\n3\n\n[](https://github.com/barbara-celi)\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/components/atoms/overview.mdx)\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/overview.mdx)\n\n[UI components« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/components-index)[BadgeNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-overview/docs/guides/faststore/atoms-badge)\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_69e8b83e
|
[
{
"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 sellers by region or address 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-sellers-by-region-or-address/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/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-sellers-by-region-or-address/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-sellers-by-region-or-address/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-sellers-by-region-or-address/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-sellers-by-region-or-address/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-sellers-by-region-or-address/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/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-sellers-by-region-or-address/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/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-sellers-by-region-or-address/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/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-sellers-by-region-or-address/docs/guides/region-section-api-quick-start-guides)\n\n[Get sellers by region or address](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/get-sellers-by-region-or-address)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/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-sellers-by-region-or-address/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/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-sellers-by-region-or-address/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-sellers-by-region-or-address/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/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-sellers-by-region-or-address/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/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-sellers-by-region-or-address/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/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-sellers-by-region-or-address/docs/guides/region-section-api-quick-start-guides)\n\n[Get sellers by region or address](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/get-sellers-by-region-or-address)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/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-sellers-by-region-or-address/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/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-sellers-by-region-or-address/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-sellers-by-region-or-address/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/checkout-api-overview)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/region-section-api-quick-start-guides)\n\n[Get sellers by region or address](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/get-sellers-by-region-or-address)\n\nGet sellers by region or address\n\nWhen customers access your store, they expect to view products that can be delivered to their location. To guarantee item availability in the window display, the VTEX platform selects the sellers linked to the [marketplace](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/marketplace).\n\nThis guide will describe how to obtain a list of [White label sellers](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/white-label-sellers-selection) in your store serving a given delivery region or address.\n\n> The sellers shown in the list are only a reference of those that would be able to attend an order placed to a delivery location. From this filter, only sellers with stock and delivery methods available to that specific address will be shown to the customer in the store and considered able to fulfill the order.\n\n## Accessing the list of sellers\n\nTo access the list of sellers serving a specific region or address, you need to use the [Get sellers by region or address](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pub/regions/-regionId-) endpoint. In this request, you must **choose one** of the following methods:\n\n1. Send the identification of the list of sellers (`regionId`) through the URL address.\n\n> `https://{accountName}.{environment}.com.br/api/checkout/pub/regions/v2.1DC18HE648C5111C0933734FE83EC783`\n\n1. Send the `country` (3-digit ISO code) and at least one of the two values (`postal Code` or `geoCoordinates`) as query parameters through the URL. If you wish, you can send both values (`postalCode` or `geoCoordinates`) in the same request.\n\n> `https://{accountName}.{environment}.com.br/api/checkout/pub/regions?country=BRA&postalCode=22050040`\n\nAfter sending the request, the endpoint will return the response body containing the `regionId`, `id` and `name` of stores able to deliver in the selected address region, as shown in the example below:\n\n`1\n\n[ \n\n2\n\n { \n\n3\n\n \"id\": \"v2.1DC18HE648C5111C0933734DD83ED783\", \n\n4\n\n \"sellers\": [ \n\n5\n\n { \n\n6\n\n \"id\": \"partnerchallenge9\", \n\n7\n\n \"name\": \"partnerchallenge9\", \n\n8\n\n \"logo\": \"\" \n\n9\n\n }, \n\n10\n\n { \n\n11\n\n \"id\": \"qastorees\", \n\n12\n\n \"name\": \"qastorees\", \n\n13\n\n \"logo\": \"\" \n\n14\n\n }, \n\n15\n\n { \n\n16\n\n \"id\": \"qastoremg\", \n\n17\n\n \"name\": \"qastoremg\", \n\n18\n\n \"logo\": \"\" \n\n19\n\n }, \n\n20\n\n { \n\n21\n\n \"id\": \"qastorerj\", \n\n22\n\n \"name\": \"qastorerj\", \n\n23\n\n \"logo\": \"\" \n\n24\n\n }, \n\n25\n\n { \n\n26\n\n \"id\": \"qastoresp\", \n\n27\n\n \"name\": \"qastoresp\", \n\n28\n\n \"logo\": \"\" \n\n29\n\n } \n\n30\n\n ] \n\n31\n\n } \n\n32\n\n] \n\n`\n\n## Error codes\n\nThe following errors may appear as a message in the response body.\n\n### 200 - OK\n\nDespite the code `200` (which indicates the success of the request), if there are no White label sellers allocated in the `regionId` informed, the response body will not contain any seller information.\n\n`1\n\n[ \n\n2\n\n { \n\n3\n\n \"id\": \"v2.1BB18CE648B5111D0933734ED83EC783\", \n\n4\n\n \"sellers\": [] \n\n5\n\n } \n\n6\n\n] \n\n`\n\n### 400 - Bad Request\n\n* `Message error example (code 001): \"O campo CEP (220500) nos dados de entrega é inválido\"` (Postal code (220500) in delivery data is invalid): the `postalCode` information is not valid.\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"001\", \n\n5\n\n \"message\": \"O campo CEP (220500) nos dados de entrega é inválido\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"f2b8107f-e5d5-4b7c-b719-344d1b05d1fa\" \n\n9\n\n} \n\n`\n\n* `Message error example (code CHK0119): \"Endereços devem ter código postal ou geocoordenadas\"` (Addresses must have postal code or geocoordinates): this message can be displayed in two situations: \n * 1. `postalCode` was not informed in the request, or; \n * 1. `geoCoordinates` information is not valid or was not informed in the request.\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"CHK0119\", \n\n5\n\n \"message\": \"Endereços devem ter código postal ou geocoordenadas\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"e144a38c-2e7c-40fa-bd71-12d0ceaa2517\" \n\n9\n\n} \n\n`\n\n* `Message error example (code CHK0127): \"País inválido\"` (invalid country): the `country` code was not informed in the request.\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"CHK0127\", \n\n5\n\n \"message\": \"País inválido\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"d0119920-aa3e-4295-a063-6d85ba34a400\" \n\n9\n\n} \n\n`\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/Checkout/region-section-api-quick-start-guides/get-sellers-by-region-or-address.md)\n\n[Region« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address//docs/guides/region-section-api-quick-start-guides)[Checkout error codesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address//docs/guides/checkout-error-codes)\n\nContributors\n\n1\n\n[](https://github.com/ricardoaerobr)\n\nON THIS PAGE\n\n[Accessing the list of sellers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/get-sellers-by-region-or-address%23accessing-the-list-of-sellers)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/get-sellers-by-region-or-address%23error-codes)\n\n[200 - OK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/get-sellers-by-region-or-address%23200-ok)[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/get-sellers-by-region-or-address%23400-bad-request)\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/region-section-api-quick-start-guides/get-sellers-by-region-or-address.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Accessing the list of sellers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/get-sellers-by-region-or-address%23accessing-the-list-of-sellers)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/get-sellers-by-region-or-address%23error-codes)\n\n[200 - OK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/get-sellers-by-region-or-address%23200-ok)[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-sellers-by-region-or-address/docs/guides/get-sellers-by-region-or-address%23400-bad-request)\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_ff206a4d
|
[
{
"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 broadcaster 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.broadcaster/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/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.broadcaster/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.broadcaster/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.broadcaster/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.broadcaster/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.broadcaster/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.checkout-ui-custom)\n\n[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.messages)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/guides/affiliates-program-app)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/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.broadcaster/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.broadcaster/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.checkout-ui-custom)\n\n[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.messages)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/guides/affiliates-program-app)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/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.broadcaster/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.broadcaster/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.broadcaster/docs/vtex-io-apps)\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/guides/functional-apps)\n\nBroadcaster\n\nOfficial extension\n\nVersion: 0.10.2\n\nLatest version: 0.10.2\n\nThe Broadcaster app is designed to adapt catalog broadcaster changes to an event in VTEX IO's Events system.\n\nTypically, it's used when developing another IO app that receives the events and calls handler functions to treat the events. For more details about this use, see the [Receiving Catalog Changes on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-catalog-changes-on-vtex-io) guide.\n\nFor example, the [Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-availability-notify) app uses the Broadcaster app to monitor inventory updates. Once the requested SKU is back in stock, the app will email shoppers who asked to be notified.\n\n \nSKU that \nchanged \n \n \nCatalog changes \n(Catalog broadcaster) \n \nBroadcaster app\n\nEvent system\n\nChanges broadcast \nto other apps \n(e.g.: Availability Notify) \n \nThe Broadcaster app receives a POST request from the catalog broadcaster with the details of the SKU that changed and pushes an event to the Event system to broadcast to apps that listen to these changes.\n\n> The Broadcaster app receives catalog changes from the same account where the app is installed and not from sellers.\n\n## SKU information\n\nWhen the Broadcaster app sends an event, it contains a payload with the following fields:\n\n| Field name | Description | Type |\n| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |\n| IdSku | SKU ID on VTEX. | string |\n| ProductId | Product ID on VTEX. This field is optional and is only sent in marketplace contexts when an event occurs in the affiliate catalog. | long |\n| An | Account name on VTEX, shown in the store’s VTEX Admin URL. | string |\n| IdAffiliate | ID code of the affiliate that generated the event. This field is optional and is only sent in marketplace contexts when an event occurs in the affiliate catalog. | string |\n| SellerChain | Sellers involved in the chain. This field is optional and is only sent in marketplace contexts with [Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) when an event occurs in the affiliate catalog. When there is more than one seller in the chain, they're all included in this field separated by a forward slash (/). Example: \"cea/rihappy\". | string |\n| DateModified | Date when the item was updated. | string |\n| IsActive | Identifies whether the product is active or not. If true, the product/SKU is active. | boolean |\n| StockModified | Indicates that the inventory level has changed. If false, the inventory level hasn't changed. | boolean |\n| PriceModified | Indicates that the price has changed. If false, the product/SKU price hasn't changed. | boolean |\n| HasStockKeepingUnitModified | Indicates that the product/SKU details have changed, such as name, description, weight, etc. If true, the product/SKU details have changed. | boolean |\n| HasStockKeepingUnitRemovedFromAffiliate | Indicates that the product is no longer associated with the trade policy. If true, the trade policy has changed. | boolean |\n\n## Notifications in subaccounts\n\nWhen attempting to listen for catalog change notifications in a [subaccount](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-subaccount-multi-store-multi-domain--tutorials%5F510), you'll likely find that your app isn't receiving notifications. This is because, by default, catalog change notifications are only sent to the Broadcaster app installed in the main account.\n\n### \"Notify Subaccounts\" setting\n\nThe Broadcaster app installed in the main (parent) account can be configured to push a notification event to all associated subaccounts.\n\nTo configure this setting, follow the steps below:\n\n1. Go to **My Apps** in the VTEX Admin.\n2. In the list of installed apps, search for **Broadcaster**.\n3. Click `Settings` in the app box.\n4. Check the `Notify Subaccounts` box.\n5. Click `Save`.\n\n## Testing the app\n\nBy default, when the Broadcaster Adapter app sends events, they're only sent in the master workspace of each account. If you work in a **[development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-workspace)**, there's a way to receive events there:\n\n### \"Notify Target Workspace\" setting\n\nThe app installed in the master workspace can be configured to push a notification event to a selected target workspace in addition to the master workspace.\n\nTo configure this setting, follow the steps below:\n\n1. Go to **My Apps** in the VTEX Admin.\n2. In the list of installed apps, search for **Broadcaster**.\n3. Click `Settings`.\n4. Enter the name of the workspace you want to notify in the **Notify Target Workspace** field.\n5. Click `Save`.\n\n[Badges« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.badges)[Catalog ImagesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.catalog-images)\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[SKU information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.broadcaster%23sku-information)\n\n[Notifications in subaccounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.broadcaster%23notifications-in-subaccounts)\n\n[\"Notify Subaccounts\" setting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.broadcaster%23notify-subaccounts-setting)\n\n[Testing the app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.broadcaster%23testing-the-app)\n\n[\"Notify Target Workspace\" setting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.broadcaster/docs/apps/vtex.broadcaster%23notify-target-workspace-setting)\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_12e40ced
|
[
{
"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 elfsight 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.elfsight/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/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.elfsight/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.elfsight/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.elfsight/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.elfsight/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.elfsight/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/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.elfsight/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.elfsight/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/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.elfsight/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.elfsight/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.elfsight/docs/vtex-io-apps)\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/guides/pixel-apps)\n\nElfsight\n\nOfficial extension\n\nVersion: 1.0.0\n\nLatest version: 1.0.0\n\n[](#contributors-)\n\nElfsight first party integration app. The [solution](https://read.calvincode.net/reader?url=https://elfsight.com/) provides widgets that help website owners to increase sales, engage visitors, collect leads and more.\n\n\n\n## Configuration\n\n1. Adding the app as a theme dependency in the `manifest.json` file;\n\n`1\n\n\"dependencies\": { \n\n2\n\n \"vtex.elfsight\": \"1.x\" \n\n3\n\n} \n\n`\n\n1. Add the block `elfsight`, responsible for rendering your Elfsight widget, to your theme `blocks.json` file. Notice: the block can be added to any page template you want.\n2. Declare in it the prop `appId` whose value must be the app ID of the widget provided by Elfsight. For example:\n\n`1\n\n \"footer-layout.desktop\": { \n\n2\n\n \"children\": [ \n\n3\n\n+ \"elfsight#foobar\" \n\n4\n\n ] \n\n5\n\n }, \n\n6\n\n \n7\n\n+ \"elfsight#foobar\": { \n\n8\n\n+ \"props\": { \n\n9\n\n+ \"appId\": \"4a13d81d-20f3-4661-b472-9de777efe3ed\" \n\n10\n\n+ } \n\n11\n\n+ } \n\n`\n\n### `elfsight` props\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | --------------------------------------------------------------------------------------------------------------------- | ------------- |\n| appId | string | The app ID of the widget provided by Elfsight. The format should be as follows: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX. | undefined |\n\nYou should get the app ID from the Elfsight admin:\n\n\n\n[CyberSource Fingerprint« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.cybersource-fingerprint)[Facebook pixelNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.facebook-pixel)\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.elfsight/docs/apps/vtex.elfsight%23configuration)\n\n[elfsight props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.elfsight/docs/apps/vtex.elfsight%23elfsight-props)\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_c199ab3a
|
[
{
"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 vtexjs for 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/vtexjs-for-catalog/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-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/vtexjs-for-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/vtexjs-for-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/vtexjs-for-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/vtexjs-for-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/vtexjs-for-catalog/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/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/vtexjs-for-catalog/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-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[My Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/guides/ui-customization-my-authentication)\n\n[vtex.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/guides/vtexjs)\n\n[vtex.js for Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/guides/vtexjs-for-checkout)\n\n[vtex.js for Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/guides/vtexjs-for-catalog)\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/vtexjs-for-catalog/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-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/vtexjs-for-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/vtexjs-for-catalog/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/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/vtexjs-for-catalog/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-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[My Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/guides/ui-customization-my-authentication)\n\n[vtex.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/guides/vtexjs)\n\n[vtex.js for Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/guides/vtexjs-for-checkout)\n\n[vtex.js for Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/guides/vtexjs-for-catalog)\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/vtexjs-for-catalog/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-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/vtexjs-for-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/vtexjs-for-catalog/docs/guides)\n\nUI Customization\n\n[vtex.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/guides/vtexjs)\n\n[vtex.js for Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/guides/vtexjs-for-catalog)\n\nvtex.js for Catalog\n\nThe Catalog module gets data related to the products of the store.\n\n## getProductWithVariations(productId)\n\nSee below an example of the resulting object.\n\n### Returns\n\n`Promise` for product details\n\n### Arguments\n\n| Name | Type |\n| --------- | ---------------------------------------------------- |\n| productId | String or Number The product ID. (It’s not the SKU!) |\n\n### Example\n\n`1\n\nvtexjs.catalog.getProductWithVariations(1000).done(function(product){ \n\n2\n\n console.log(product); \n\n3\n\n}); \n\n`\n\n## getCurrentProductWithVariations\n\nSimilar to `getProductWithVariations`, but automatically detects the productId.\n\nShould be called exclusively on a product page.\n\n### Returns\n\n`Promise` for product details\n\n### Example\n\nCall\n\n`1\n\nvtexjs.catalog.getCurrentProductWithVariations().done(function(product){ \n\n2\n\n console.log(product); \n\n3\n\n}); \n\n`\n\nResulting object\n\n`1\n\n{ \n\n2\n\n \"productId\": 4741, \n\n3\n\n \"name\": \"Ração Club Performance Junior Royal Canin\", \n\n4\n\n \"salesChannel\": \"1\", \n\n5\n\n \"available\": true, \n\n6\n\n \"displayMode\": \"especificacao\", \n\n7\n\n \"dimensions\": [\"Embalagem\"], \n\n8\n\n \"dimensionsInputType\": { \n\n9\n\n \"Embalagem\": \"Combo\" \n\n10\n\n }, \n\n11\n\n \"dimensionsMap\": { \n\n12\n\n \"Embalagem\": [\"3 kg\", \"15 kg\"] \n\n13\n\n }, \n\n14\n\n \"skus\": [{ \n\n15\n\n \"sku\": 2482, \n\n16\n\n \"skuname\": \"Ração Club Performance Junior Royal Canin - 15 kg\", \n\n17\n\n \"dimensions\": { \n\n18\n\n \"Embalagem\": \"15 kg\" \n\n19\n\n }, \n\n20\n\n \"available\": true, \n\n21\n\n \"listPriceFormated\": \"R$ 0,00\", \n\n22\n\n \"listPrice\": 0, \n\n23\n\n \"bestPriceFormated\": \"R$ 104,90\", \n\n24\n\n \"bestPrice\": 10490, \n\n25\n\n \"installments\": 3, \n\n26\n\n \"installmentsValue\": 3496, \n\n27\n\n \"installmentsInsterestRate\": 0, \n\n28\n\n \"image\": \"http://www.exemplo.com.br/arquivos/ids/185213-446-446/Racao-Club-Performance-Junior---Royal-Canin.jpg\", \n\n29\n\n \"sellerId\": \"1\", \n\n30\n\n \"seller\": \"exemplo\", \n\n31\n\n \"measures\": { \n\n32\n\n \"cubicweight\": 7.0313, \n\n33\n\n \"height\": 10.0000, \n\n34\n\n \"length\": 75.0000, \n\n35\n\n \"weight\": 15300.0000, \n\n36\n\n \"width\": 45.0000 \n\n37\n\n }, \n\n38\n\n \"rewardValue\": 840 \n\n39\n\n }, { \n\n40\n\n \"sku\": 2483, \n\n41\n\n \"skuname\": \"Ração Club Performance Junior Royal Canin - 3 kg\", \n\n42\n\n \"dimensions\": { \n\n43\n\n \"Embalagem\": \"3 kg\" \n\n44\n\n }, \n\n45\n\n \"available\": true, \n\n46\n\n \"listPriceFormated\": \"R$ 0,00\", \n\n47\n\n \"listPrice\": 0, \n\n48\n\n \"bestPriceFormated\": \"R$ 39,80\", \n\n49\n\n \"bestPrice\": 3980, \n\n50\n\n \"installments\": 1, \n\n51\n\n \"installmentsValue\": 3980, \n\n52\n\n \"installmentsInsterestRate\": 0, \n\n53\n\n \"image\": \"http://www.exemplo.com.br/arquivos/ids/185213-446-446/Racao-Club-Performance-Junior---Royal-Canin.jpg\", \n\n54\n\n \"sellerId\": \"1\", \n\n55\n\n \"seller\": \"exemplo\", \n\n56\n\n \"measures\": { \n\n57\n\n \"cubicweight\": 1.8750, \n\n58\n\n \"height\": 8.0000, \n\n59\n\n \"length\": 45.0000, \n\n60\n\n \"weight\": 3000.0000, \n\n61\n\n \"width\": 25.0000 \n\n62\n\n }, \n\n63\n\n \"rewardValue\": 319 \n\n64\n\n }] \n\n65\n\n} \n\n`\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/UI-Customization/vtexjs/vtexjs-for-catalog.md)\n\n[vtex.js for Checkout« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog//docs/guides/vtexjs-for-checkout)[Setting up DKIM for transactional emailsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog//docs/guides/setting-up-dkim-for-transactional-emails)\n\nContributors\n\n1\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[getProductWithVariations(productId)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/guides/vtexjs-for-catalog%23getproductwithvariationsproductid)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/guides/vtexjs-for-catalog%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/guides/vtexjs-for-catalog%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/guides/vtexjs-for-catalog%23example)\n\n[getCurrentProductWithVariations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/guides/vtexjs-for-catalog%23getcurrentproductwithvariations)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/guides/vtexjs-for-catalog%23returns)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/guides/vtexjs-for-catalog%23example)\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/UI-Customization/vtexjs/vtexjs-for-catalog.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[getProductWithVariations(productId)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/guides/vtexjs-for-catalog%23getproductwithvariationsproductid)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/guides/vtexjs-for-catalog%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/guides/vtexjs-for-catalog%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/guides/vtexjs-for-catalog%23example)\n\n[getCurrentProductWithVariations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/guides/vtexjs-for-catalog%23getcurrentproductwithvariations)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/guides/vtexjs-for-catalog%23returns)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-catalog/docs/guides/vtexjs-for-catalog%23example)\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_8bf5d98b
|
[
{
"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 responsive values 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.responsive-values/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/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.responsive-values/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.responsive-values/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.responsive-values/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.responsive-values/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.responsive-values/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.checkout-ui-custom)\n\n[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.messages)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/guides/affiliates-program-app)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/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.responsive-values/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.responsive-values/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.checkout-ui-custom)\n\n[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.messages)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/guides/affiliates-program-app)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/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.responsive-values/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.responsive-values/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.responsive-values/docs/vtex-io-apps)\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/guides/functional-apps)\n\nvtex.responsive-values\n\nOfficial extension\n\nVersion: 0.4.2\n\nLatest version: 0.4.2\n\n[](#contributors-)\n\nUtility for using props that accept different values for different devices or media queries.\n\nFor example, a given prop could accept both just a number...\n\n`1\n\nprops: { \n\n2\n\n quantity: 1, \n\n3\n\n} \n\n`\n\n...or different values depending on the device or a media query:\n\n`1\n\nprops: { \n\n2\n\n quantity: { \n\n3\n\n mobile: 1, \n\n4\n\n desktop: 2, \n\n5\n\n '(min-width: 1500px)': 4, \n\n6\n\n } \n\n7\n\n} \n\n`\n\n...and the component, in turn, would use it like this:\n\n`1\n\nimport { useResponsiveValue } from 'vtex.responsive-values' \n\n2\n\n \n3\n\nconst MyComponent = ({ quantity }) => { \n\n4\n\n const quantity = useResponsiveValue(quantity) \n\n5\n\n \n6\n\n return <span>{quantity}</span> \n\n7\n\n} \n\n8\n\n \n9\n\n<MyComponent quantity={1} /> {/* always returns 1 */} \n\n10\n\n \n11\n\n<MyComponent quantity={{ \n\n12\n\n '(min-width: 1500px)': 4, \n\n13\n\n desktop: 2, \n\n14\n\n mobile: 1, \n\n15\n\n}} /> {/* returns 1 on mobile devices, 2 on desktop */} \n\n`\n\nAlternately, if you want to apply it to multiple values at once, or even the entire `props` object, you can use the hook `useResponsiveValues` (notice the plural) hook.\n\n`1\n\nimport { useResponsiveValues } from 'vtex.responsive-values' \n\n2\n\n \n3\n\nconst MyComponent = props => { \n\n4\n\n const { margin, padding } = useResponsiveValues( \n\n5\n\n { \n\n6\n\n margin: props.margin, \n\n7\n\n padding: props.padding \n\n8\n\n } \n\n9\n\n ) \n\n10\n\n \n11\n\n return ( \n\n12\n\n <section style={{ margin, padding }}> \n\n13\n\n <span>{props.children}</span> \n\n14\n\n </section> \n\n15\n\n ) \n\n16\n\n} \n\n17\n\n \n18\n\n<MyComponent margin={4} padding={4} /> {/* always returns margin 4 / padding 4 */} \n\n19\n\n \n20\n\n<MyComponent \n\n21\n\n margin={{ \n\n22\n\n desktop: 4, \n\n23\n\n mobile: 2, \n\n24\n\n }} \n\n25\n\n padding={{ \n\n26\n\n desktop: 4, \n\n27\n\n mobile: 2, \n\n28\n\n }} \n\n29\n\n/> {/* returns 1 on mobile devices, 2 on desktop */} \n\n`\n\nThere are some things to keep in mind when using media queries:\n\n* Media queries take precedence over devices. If one matches, any device-specific value is ignored.\n* Media queries are written following the [standard media query syntax](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/CSS/Media%5FQueries/Using%5Fmedia%5Fqueries%23Syntax).\n* The definiton order matters. If more than one media query is matched, the first matched one is used.\n\n## API\n\nProps that use this hook accept either a value by itself, or an object with the following options: `phone` and `tablet` separately (or just `mobile` for both), `desktop` and generic media queries.\n\nIf there is any missing device, it will fallback to the next largest one. For example, if only the values of `phone` and `desktop` are passed, `tablet` devices will receive the value from `desktop`. Media queries have no fallback behavior.\n\n[Rewriter GraphQL API« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.rewriter/rewriter-graphql-api)[Search GraphQLNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.search-graphql)\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[API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/docs/apps/vtex.responsive-values%23api)\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_d3b75c28
|
[
{
"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 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/external-marketplace-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/external-marketplace-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/external-marketplace-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/external-marketplace-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/external-marketplace-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/external-marketplace-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/external-marketplace-integration-guide/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-guide/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-guide/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-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/external-marketplace-integration-guide/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide/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-guide/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide/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-guide/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-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/external-marketplace-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/external-marketplace-integration-guide/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-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/external-marketplace-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/external-marketplace-integration-guide/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide/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-guide/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-guide/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-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/external-marketplace-integration-guide/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide/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-guide/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide/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-guide/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-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/external-marketplace-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/external-marketplace-integration-guide/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-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/external-marketplace-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/external-marketplace-integration-guide/docs/guides)\n\nIntegration Guides\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide/docs/guides/external-marketplace-integration-guide)\n\nExternal Marketplace\n\nIn our native multi-seller architecture, VTEX stores decouple different aspects of an ecommerce operation in order to clearly divide responsibilities between marketplace and seller.\n\n\n\nThis allows VTEX stores to become marketplaces themselves or become sellers in other VTEX stores without requiring any additional development. Store settings connect the marketplace subsystem of a store to the seller subsystem of another.\n\n\n\nThis behavior can be leveraged in endless combinations. VTEX accounts can both set up a marketplace storefront to sell products from multiple sellers, including their own, and distribute products to multiple other marketplaces. This creates our [collaborative commerce](https://read.calvincode.net/reader?url=https://vtex.com/en/blog/strategy/collaborative-commerce-imperative-why-digital-first-collaboration-is-at-the-core-of-todays-business-success/) network.\n\n\n\nHowever, there may be a strategic partner for your business operating outside our collaborative commerce network. This guide presents the steps needed to develop a **custom connector to sell your products in an external marketplace**.\n\n> This guide is currently being written and published as content become available.\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\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-guide.md)\n\n[Managing a Customer Credit invoice« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide//docs/guides/managing-a-customer-credit-invoice)[Marketplace / Seller architectureNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide//docs/guides/external-marketplace-integration-architecture)\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\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-guide.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_75c19599
|
[
{
"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 client profile by email 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-client-profile-by-email/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-client-profile-by-email/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-client-profile-by-email/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-client-profile-by-email/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-client-profile-by-email/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-client-profile-by-email/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-client-profile-by-email/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/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-client-profile-by-email/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/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-client-profile-by-email/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Getting a customer profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/getting-a-customer-profile-by-email)\n\n[Adding customer profile information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/add-customer-profile-information-to-the-cart)\n\n[Add shipping address and select delivery option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/add-shipping-address-and-delivery-option-to-the-cart)\n\n[Adding customer preferences to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/add-customer-preferences-to-the-cart)\n\n[Adding marketing information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/add-marketing-information-to-the-cart)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/add-cart-items)\n\n[Adding payment information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/adding-payment-information-to-the-cart)\n\n[Adding merchant context information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/add-merchant-context-information-to-the-cart)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/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-a-client-profile-by-email/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-a-client-profile-by-email/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/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-a-client-profile-by-email/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/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-client-profile-by-email/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-client-profile-by-email/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/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-client-profile-by-email/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/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-client-profile-by-email/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Getting a customer profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/getting-a-customer-profile-by-email)\n\n[Adding customer profile information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/add-customer-profile-information-to-the-cart)\n\n[Add shipping address and select delivery option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/add-shipping-address-and-delivery-option-to-the-cart)\n\n[Adding customer preferences to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/add-customer-preferences-to-the-cart)\n\n[Adding marketing information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/add-marketing-information-to-the-cart)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/add-cart-items)\n\n[Adding payment information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/adding-payment-information-to-the-cart)\n\n[Adding merchant context information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/add-merchant-context-information-to-the-cart)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/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-a-client-profile-by-email/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-a-client-profile-by-email/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/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-a-client-profile-by-email/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/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-client-profile-by-email/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-client-profile-by-email/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/checkout-api-overview)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Getting a customer profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/getting-a-customer-profile-by-email)\n\nGetting a customer profile by email\n\nThe shopping cart gathers information on the products the customer chooses while browsing a store, such as prices, shipping costs, payment methods, delivery methods, etc. This data may include item prices, shipping value, payment, and delivery methods, among others.\n\nThe information added to the customer profile can be used in the shopping cart to reduce the time the customer spends at Checkout and improve their shopping experience. For more information, read [Purchasing with SmartCheckout](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/smartcheckout-customer-information-automatic-fill-in--2Nuu3xAFzdhIzJIldAdtan%23purchasing-with-smartcheckout).\n\nThis guide will describe how to get client profile information using the email address registered in your store.\n\n## Getting customer profile information\n\nTo access the customer profile information, you must use the [Get client profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getclientprofilebyemail) endpoint. In this request, you must send the customer's email through the URL address, as in the example below:\n\n`https://{accountname}.{environment.com.br}/api/checkout/pub/profiles?email=test1@test2.com`\n\nAfter sending the request, the endpoint will return the response body containing the client profile information, as in the example below:\n\n`1\n\n... \n\n2\n\n{ \n\n3\n\n \"userProfileId\": \"fb542e51-5488-4c34-8d17-ed8fcf597a94\", \n\n4\n\n \"profileProvider\": \"VTEX\", \n\n5\n\n \"availableAccounts\": [], \n\n6\n\n \"availableAddresses\": [ \n\n7\n\n { \n\n8\n\n \"addressType\": \"residential\", \n\n9\n\n \"receiverName\": \"Clark Kent\", \n\n10\n\n \"addressId\": \"666c2e830bd9474ab6f6cc53fb6dd2d2\", \n\n11\n\n \"isDisposable\": false, \n\n12\n\n \"postalCode\": \"12345-000\", \n\n13\n\n \"city\": \"Metropolis\", \n\n14\n\n \"state\": \"NY\", \n\n15\n\n \"country\": \"USA\", \n\n16\n\n \"street\": \"My street\", \n\n17\n\n \"number\": \"123\", \n\n18\n\n \"neighborhood\": \"My neighborhood\", \n\n19\n\n \"complement\": null, \n\n20\n\n \"reference\": null, \n\n21\n\n \"geoCoordinates\": [ \n\n22\n\n -47.924747467041016, \n\n23\n\n -15.832582473754883 \n\n24\n\n ] \n\n25\n\n } \n\n26\n\n ], \n\n27\n\n \"userProfile\": { \n\n28\n\n \"email\": \"clark.kent@example.com\", \n\n29\n\n \"firstName\": \"Clark\", \n\n30\n\n \"lastName\": \"Kent\", \n\n31\n\n \"document\": \"12345678900\", \n\n32\n\n \"documentType\": \"cpf\", \n\n33\n\n \"phone\": \"+556199999999\", \n\n34\n\n \"corporateName\": null, \n\n35\n\n \"tradeName\": null, \n\n36\n\n \"corporateDocument\": null, \n\n37\n\n \"stateInscription\": null, \n\n38\n\n \"corporatePhone\": null, \n\n39\n\n \"isCorporate\": false, \n\n40\n\n \"profileCompleteOnLoading\": null, \n\n41\n\n \"profileErrorOnLoading\": null, \n\n42\n\n \"customerClass\": null \n\n43\n\n }, \n\n44\n\n \"isComplete\": true \n\n45\n\n} \n\n46\n\n... \n\n`\n\n> ️ Fields not completed in the customer profile will be displayed as `null`.\n\n## Error codes\n\nThe following errors may appear as a message in the response body.\n\n### 200 - OK\n\nDespite the `200` code, which indicates the success of the request, if the email used is not registered in your store or the customer profile is invalid or incomplete, the response body will not contain any customer profile information. In these conditions, the [SmartCheckout](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/smartcheckout-customer-information-automatic-fill-in--2Nuu3xAFzdhIzJIldAdtan) feature cannot be used in the shopping cart.\n\n`1\n\n{ \n\n2\n\n \"userProfileId\": null, \n\n3\n\n \"profileProvider\": null, \n\n4\n\n \"availableAccounts\": [], \n\n5\n\n \"availableAddresses\": [], \n\n6\n\n \"userProfile\": null, \n\n7\n\n \"isComplete\": false \n\n8\n\n} \n\n`\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\": \"5d9f54e6-7db4-46d6-bca9-deeb278b8b98\" \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 if the URL 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\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/GeorgeLimaDev)\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/cart-attachments-section-quick-start-guides/getting-a-customer-profile-by-email.md)\n\n[Cart Attachments« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email//docs/guides/cart-attachments-section-api-quick-start-guides)[Adding customer profile information to the cartNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email//docs/guides/add-customer-profile-information-to-the-cart)\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/GeorgeLimaDev)\n\nON THIS PAGE\n\n[Getting customer profile information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/getting-a-customer-profile-by-email%23getting-customer-profile-information)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/getting-a-customer-profile-by-email%23error-codes)\n\n[200 - OK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/getting-a-customer-profile-by-email%23200-ok)[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/getting-a-customer-profile-by-email%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/getting-a-customer-profile-by-email%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/cart-attachments-section-quick-start-guides/getting-a-customer-profile-by-email.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Getting customer profile information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/getting-a-customer-profile-by-email%23getting-customer-profile-information)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/getting-a-customer-profile-by-email%23error-codes)\n\n[200 - OK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/getting-a-customer-profile-by-email%23200-ok)[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/getting-a-customer-profile-by-email%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email/docs/guides/getting-a-customer-profile-by-email%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_f9654d6e
|
[
{
"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 authentication 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-authentication/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-authentication/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-authentication/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-authentication/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-authentication/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-authentication/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-authentication/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication/docs/guides/api-usage)\n\n[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication/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/getting-started-authentication/docs/guides/making-your-first-request)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication/docs/guides/authentication)\n\n[API authentication using API keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication/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/getting-started-authentication/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/getting-started-authentication/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/getting-started-authentication/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/getting-started-authentication/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/getting-started-authentication/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/getting-started-authentication/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/getting-started-authentication/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/getting-started-authentication/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/getting-started-authentication/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication/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/getting-started-authentication/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication/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/getting-started-authentication/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/getting-started-authentication/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication/docs/guides/api-usage)\n\n[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication/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/getting-started-authentication/docs/guides/making-your-first-request)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication/docs/guides/authentication)\n\n[API authentication using API keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication/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/getting-started-authentication/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/getting-started-authentication/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/getting-started-authentication/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/getting-started-authentication/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/getting-started-authentication/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/getting-started-authentication/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/getting-started-authentication/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/getting-started-authentication/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/getting-started-authentication/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication/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/getting-started-authentication/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication/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/getting-started-authentication/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/getting-started-authentication/docs/guides)\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication/docs/guides/api-usage)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication/docs/guides/authentication)\n\nAuthentication\n\nAuthentication is a crucial aspect of API integrations, backend, and frontend app development. It ensures authorized access by requiring valid credentials like API keys or tokens. This shields sensitive data, prevents breaches, and builds user trust. Get started with VTEX authentication for developers with the following guides:\n\n* [API authentication using application keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys)\n* [API authentication using user tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens)\n* [App authentication using auth tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens)\n\nThere are different contexts in which authentication is required in the regular functioning of a VTEX store. Below are some example use cases and the recommended authentication methods.\n\n| **Use case** | **Indicated authentication methods** |\n| ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Backend VTEX IO app | [User token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens) via VTEX IO context, or, if needed, [app authentication token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens) via VTEX IO context |\n| Frontend VTEX IO app | [User token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens) via VTEX IO context |\n| Self-hosted backend request to VTEX APIs | [Application keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) |\n| Self-hosted frontend request to VTEX APIs | [User token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens) |\n\n## Single sign on integrations\n\nVTEX allows stores to integrate with external identity providers to provide single sign on (SSO) experiences to shoppers and Administrative users. You can learn more about this in the article [Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/login-integration-guide) and below you can find more information on these and other SSO use cases:\n\n* [Store SSO with OAuth 2.0](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-webstore-oauth2)\n* [Admin SSO with SAML 2.0](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2)\n* [Use your VTEX account as an OAuth provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x)\n\n## Learn more\n\n* **Authorization**: [Users](https://read.calvincode.net/reader?url=https://help.vtex.com/en/subcategory/users--63DHe3VQEEE6Uuua8gIs2M), [Roles](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) and [License Manager Resources](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3)\n* **Auditability**: [Audit](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/searching-for-events-on-audit--5RXf9WJ5YLFBcS8q8KcxTA)\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\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/Getting-Started/authentication/authentication.md)\n\n[Making your first request« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication//docs/guides/making-your-first-request)[API authentication using API keysNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication//docs/guides/api-authentication-using-api-keys)\n\nSee also\n\n[API authentication using API keysGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication/docs/guides/api-authentication-using-api-keys)[API authentication using user tokensGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication/docs/guides/api-authentication-using-user-tokens)[App authentication using auth tokensGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication/docs/guides/app-authentication-using-auth-tokens)\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Single sign on integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication/docs/guides/authentication%23single-sign-on-integrations)\n\n[Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication/docs/guides/authentication%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/Getting-Started/authentication/authentication.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Single sign on integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication/docs/guides/authentication%23single-sign-on-integrations)\n\n[Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication/docs/guides/authentication%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_d967a0d7
|
[
{
"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 5 using the master data 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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-client/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-client/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-client/docs/guides/services-7-using-graphiql)\n\n[Services - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-client/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-client/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-5-using-the-master-data-client/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-5-using-the-master-data-client/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-5-using-the-master-data-client/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-5-using-the-master-data-client/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-5-using-the-master-data-client/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-client/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-client/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-client/docs/guides/services-7-using-graphiql)\n\n[Services - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-client/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-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-5-using-the-master-data-client/docs/app-development)\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-5-using-the-master-data-client/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-5-using-the-master-data-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-5-using-the-master-data-client/docs/guides/developing-services-on-vtex-io)\n\n[5\\. Using the Master Data client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-5-using-the-master-data-client/docs/guides/services-5-using-the-master-data-client)\n\n5\\. Using the Master Data client\n\nNow that we are actively using the data retrieved from Analytics, the next crucial step is to persist and update this data. To achieve this, we'll leverage [Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data), a database-as-a-service product from VTEX.\n\nMaster Data is the foundation for creating database architectures within a VTEX store. Initially designed for storing and organizing customer data, it has evolved into a versatile tool widely utilized by VTEX stores for business rule customizations and creating apps. The `@vtex/api` package provides a native Master Data client, accessible through `ctx.clients.masterdata`.\n\nIn this step, Master Data will be used to fetch data regarding the top N most viewed products, where N is a parameter that will be used to get the desired number of products.\n\nMaster Data uses the concept of data entities and [JSON Schema](https://read.calvincode.net/reader?url=https://spacetelescope.github.io/understanding-json-schema/) to validate and index documents. One _data entity_ can have many _schemas_, depending on how you need to use the data stored.\n\n## Creating a Master Data entity\n\nFirst, you will use the [Master Data API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23put-/api/dataentities/-dataEntityName-/schemas/-schemaName-) to create an entity and new schema in Master Data to save your product list. Use [Postman](https://read.calvincode.net/reader?url=https://www.postman.com/) or any other API client you prefer to send the cURL request presented in the right panel, providing the following information:\n\n* `accountName`: Name of your VTEX account.\n* `data_entity_name`: Name of the data entity to be created in Master Data. Use `course_backend_product_list` to be consistent with our app.\n* `schema_name`: Name of the schema to be created in Master Data. Use `v1` to be consistent with our app (identical to the one used in `service-course-template/node/event/updateLiveUsers.ts`).\n* `userToken`: Value of your user authentication cookie. To get your VTEX local token, run `vtex local token` in your terminal.\n\n## Saving data to Master Data\n\nNow, to save the data, we need to check if the `productSlug` is already saved in Master Data. Use the `searchDocuments` method of the Master Data client in the `node/event/liveUsersUpdate.ts` file, as highlighted in the provided code.\n\n> Note: The `COURSE_ENTITY` global constant is `course_backend_product_list`, the name of our Master Data schema.\n\n## Handling errors and exceptions\n\nTo ensure proper error handling, implement a `try-catch` structure, as presented in the code to the right.\n\n## Updating existing documents\n\nIf a product is already saved, we need to update it by incrementing its count. The Master Data client provides the `createOrUpdateEntireDocument` method for this purpose. Implement the incrementation in the Master Data entity in the `liveUsersUpdate.ts` file, right after the `console.log({savedProduct})` line.\n\n## Linking the app\n\nFinally, run `vtex link` and wait for an event to be fired. Once it does, check your terminal for the logs in the code.\n\nBreak the `vtex link` by typing `ctrl + C` and use the provided cURL command to inspect the updates on Master Data. Replace `{{accountName}}` with your VTEX account name.\n\n> To run a cURL on Windows, ensure to replace single quotes (`'`) with double quotes (`\"`). For Windows versions earlier than Windows 10 (version 1803), [download and install cURL](https://read.calvincode.net/reader?url=https://curl.se/windows/).\n\ncURL\n\n`1\n\ncurl --location --request PUT 'https://{{accountName}}.vtexcommercestable.com.br/api/dataentities/{{data_entity_name}}/schemas/{{schema_name}}' \\ \n\n2\n\n--header 'Content-Type: application/json' \\ \n\n3\n\n--header 'VtexIdclientAutCookie: {{userToken}}' \\ \n\n4\n\n--data '{ \n\n5\n\n \"properties\": { \n\n6\n\n \"slug\": { \n\n7\n\n \"type\": \"string\" \n\n8\n\n }, \n\n9\n\n \"count\": { \n\n10\n\n \"type\": \"number\" \n\n11\n\n } \n\n12\n\n }, \n\n13\n\n \"v-indexed\": [ \n\n14\n\n \"slug\", \n\n15\n\n \"count\" \n\n16\n\n ], \n\n17\n\n \"v-security\": { \n\n18\n\n \"allowGetAll\": true, \n\n19\n\n \"publicRead\": [ \n\n20\n\n \"slug\", \n\n21\n\n \"count\" \n\n22\n\n ], \n\n23\n\n \"publicWrite\": [ \n\n24\n\n \"slug\", \n\n25\n\n \"count\" \n\n26\n\n ], \n\n27\n\n \"publicFilter\": [ \n\n28\n\n \"slug\", \n\n29\n\n \"count\" \n\n30\n\n ] \n\n31\n\n } \n\n32\n\n}' \n\n`\n\nResponse\n\n`1\n\n{ \n\n2\n\n \"Message\": \"JSON Schema persisted successfully. Revalidation and indexing process running in background.\" \n\n3\n\n} \n\n`\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\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-5-using-the-master-data-client.mdx)\n\n[4\\. Using events as triggers« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-5-using-the-master-data-client//docs/guides/services-4-using-events-as-triggers)[6\\. Using GraphQL to retrieve data from Master DataNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-5-using-the-master-data-client//docs/guides/services-6-graphql-retrieving-data-from-master-data)\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Creating a Master Data entity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-5-using-the-master-data-client/docs/guides/services-5-using-the-master-data-client%23creating-a-master-data-entity)\n\n[Saving data to Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-5-using-the-master-data-client/docs/guides/services-5-using-the-master-data-client%23saving-data-to-master-data)\n\n[Handling errors and exceptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-5-using-the-master-data-client/docs/guides/services-5-using-the-master-data-client%23handling-errors-and-exceptions)\n\n[Updating existing documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-5-using-the-master-data-client/docs/guides/services-5-using-the-master-data-client%23updating-existing-documents)\n\n[Linking the app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-5-using-the-master-data-client/docs/guides/services-5-using-the-master-data-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-5-using-the-master-data-client.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Creating a Master Data entity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-5-using-the-master-data-client/docs/guides/services-5-using-the-master-data-client%23creating-a-master-data-entity)\n\n[Saving data to Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-5-using-the-master-data-client/docs/guides/services-5-using-the-master-data-client%23saving-data-to-master-data)\n\n[Handling errors and exceptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-5-using-the-master-data-client/docs/guides/services-5-using-the-master-data-client%23handling-errors-and-exceptions)\n\n[Updating existing documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-5-using-the-master-data-client/docs/guides/services-5-using-the-master-data-client%23updating-existing-documents)\n\n[Linking the app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-5-using-the-master-data-client/docs/guides/services-5-using-the-master-data-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_5ca73c2e
|
[
{
"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 ProductBrand 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/ProductBrand/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/ProductBrand/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/ProductBrand/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/ProductBrand/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/ProductBrand/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/ProductBrand/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/ProductBrand/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/ProductBrand/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/ProductBrand/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/ProductBrand/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/ProductBrand/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/ProductBrand/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/ProductBrand/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/ProductBrand/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/ProductBrand/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/ProductBrand/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/ProductBrand/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/ProductBrand/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductBrand/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/ProductBrand/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/ProductBrand/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/ProductBrand/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/ProductBrand/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/ProductBrand/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/ProductBrand/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/ProductBrand/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/ProductBrand/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/ProductBrand/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/ProductBrand/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/ProductBrand/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/ProductBrand/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/ProductBrand/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/ProductBrand/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/ProductBrand/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/ProductBrand/docs/vtex-io-apps)\n\nProduct Brand\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-brand` block displays either the **name** or the **logo** of a product's brand.\n\n\n\n## Before you start\n\nEnsure that you have registered [brands](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-a-brand--QU07yhHoaWcEYseEucOQW) in your store. To do so, follow the [How to register brands](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/registering-brands--tutorials%5F1414) documentation.\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\": \"2.x\" \n\n3\n\n } \n\n`\n\n1. Add the `product-brand` 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-brand\" \n\n9\n\n ] \n\n10\n\n }, \n\n`\n\n1. Then, declare the `product-brand` block using the props stated in the [Props](#props) table. For example:\n\n`1\n\n\"product-brand\": { \n\n2\n\n \"props\": { \n\n3\n\n \"displayMode\": \"text\" \n\n4\n\n } \n\n5\n\n }, \n\n`\n\n### Configuration\n\n| Prop name | Type | Description | Default value |\n| ------------------ | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| brandId | number | The brand ID. If no value is declared, the product context should provide the data. | undefined |\n| brandName | string | The brand name. If no value is declared, the product context should provide the data. | undefined |\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| displayMode | string | Defines if the product brand will be displayed by name or logo. Possible values are logo and text. | logo |\n| excludeBrands | array | The brand names or brand IDs listed in the array will never be displayed by the Brand component. It is usually useful to hide default or test brand names/logos on the store front. | undefined |\n| fallbackToText | boolean | Defines the behavior of the Product Brand block when set to display a brand logo but no image is registered in the VTEX admin's Catalog. If true, it allows the logo to be replaced with the brand name. If false, neither the brand name nor the brand logo are displayed. **This prop is only available for the logo display mode.** | true |\n| height | number | The logo height. **This prop is only available for the logo display mode.** | 100 |\n| loadingPlaceholder | string | Defines if the loading placeholder should have the size of the logo or the text. Possible values are: logo and text. | undefined |\n| logoWithLink | boolean |  Use withLink instead | false |\n| withLink | enum | Defines the scenarios in which the product brand should have a link that leads to its website. Possible values are: none (never includes the link), logo (includes the link whenever the brand logo is displayed), text (includes the link whenever the brand name is displayed), and logoAndText (includes the link whenever the brand logo or the brand name is displayed). | none |\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| productBrandContainer |\n| productBrandName |\n| productBrandLogo |\n| productBrandLogoWrapper |\n| productBrandLogoLink |\n| productBrandNameLink |\n| productBrandLogoSpacer |\n| productBrandNameSpacer |\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/ProductBrand/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[Before you start](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductBrand/docs/apps/vtex.store-components@3.178.5/ProductBrand%23before-you-start)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductBrand/docs/apps/vtex.store-components@3.178.5/ProductBrand%23configuration)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductBrand/docs/apps/vtex.store-components@3.178.5/ProductBrand%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductBrand/docs/apps/vtex.store-components@3.178.5/ProductBrand%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_9de1c701
|
[
{
"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 shelf 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-shelf/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/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-shelf/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-shelf/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-shelf/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-shelf/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-shelf/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/docs/vtex-io-apps)\n\nShelf\n\nOfficial extension\n\nVersion: 1.49.0\n\nLatest version: 1.49.0\n\n> With the goal of displaying a flexible product list, the `shelf` and `shelf.relatedProducts` blocks are deprecated and now configured using the [Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarylist), the [Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary), and the [Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout) blocks. To learn how to configure it, please refer to [Building a Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-shelf).\n\nThe Shelf app displays a list of products on your store pages, helping you build your shop window and work on your visual merchandising.\n\n\n\n## Configuration\n\n1. Add the `shelf` app to your theme dependencies in the `manifest.json` file:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.shelf\": \"1.x\", \n\n3\n\n } \n\n`\n\nNow, you can use all the blocks exported by the `shelf` app. See the full list below:\n\n| Block name | Description |\n| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| shelf |  Renders a list of products in the store home page. |\n| shelf.relatedProducts |  Renders a list of related products in the product details page. |\n\n1. Declare the `shelf.relatedProduct` in the product template (`store.product`) using its props. For example:\n\n`1\n\n{ \n\n2\n\n \"store.product\": { \n\n3\n\n \"children\": [ \n\n4\n\n \"breadcrumb\", \n\n5\n\n \"flex-layout.row#main\", \n\n6\n\n \"shelf.relatedProducts\" \n\n7\n\n ] \n\n8\n\n } \n\n9\n\n} \n\n`\n\n> Warning\n> \n> Note that for hiding unavailable/out-of-stock items, there are 2 different props: `hideUnavailableItems` and `hideOutOfStockItems`. They do the same thing, but each is used by a different component: `Shelf` and `RelatedProducts`, respectively.\n\n### Shelf\n\n| Prop name | Type | Description | Default value |\n| ------------------------ | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| category | String | The category ID | |\n| collection | String | The collection ID | |\n| orderBy | Enum | OrderByTopSaleDESC, OrderByPriceDESC, OrderByPriceASC, OrderByNameASC, OrderByNameDESC, OrderByReleaseDateDESC, OrderByBestDiscountDESC | |\n| hideUnavailableItems | Boolean | Whether out of stock items should be hidden (true) or not (false) | false |\n| paginationDotsVisibility | Enum | visible, hidden, mobileOnly, desktopOnly | |\n| productList | ProductListSchema | Product list schema. See ProductListSchema | \\- |\n| trackingId | String | Name to show in the Google Analytics. If nothing is passed it will use the name of the block instead | |\n| maxItems | Number | Max items | |\n\n### RelatedProducts\n\n| Prop name | Type | Description | Default value |\n| ------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| recommendation | enum | Type of recommendations that will be displayed on the shelf. Possible values: similars, suggestions, and accessories (these depend on the product information given in the Admin Catalog); and view, buy, and viewandBought (these are automatically generated according to the activity of the store). | similars |\n| groupBy | enum | Defines if you are ot nog going to group your recommendations by: PRODUCT (only display individual products and not SKUs, limited by 12 products) or NONE (if you want to display all registered SKUs, limited by 50 products). | PRODUCT |\n| hideOutOfStockItems | boolean | Whether out of stock items should be hidden: (true) or (false). | false |\n| productList | ProductListSchema | Product list schema. See ProductListSchema. | \\- |\n\n`ProductListSchema`:\n\n| Prop name | Type | Description | Default value |\n| --------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| maxItems | number | Maximum number of items to be displayed on the related product shelf. | 10 |\n| scroll | enum | Slide transition scroll type. Possible values: BY\\_PAGE, and ONE\\_BY\\_ONE. | BY\\_PAGE |\n| arrows | boolean | Whether the arrows should be displayed on the shelf (true) or not (false). | true |\n| showTitle | boolean | Whether a title should be displayed on the product-related shelf (true) or not (false). | true |\n| titleText | string | Related product shelf title. | null |\n| gap | enum | Space between items being displayed. Possible values are: ph0, ph3,ph5, and ph7. | ph3 |\n| minItemsPerPage | number | Minimum number of items per shelf slides. This prop defines how many items will be displayed on the related product shelf, even in the smallest screen size. Its value can be a float, which means that you can choose a multiple of 0.5 to indicate that you want to show a _peek_ of the next slide on the shelf. | 1 |\n| itemsPerPage | number | Maximum number of items per shelf slides. This prop defines how many items will be displayed on the related product shelf, even in the largest screen size. Its value can be a float, which means that you can choose a multiple of 0.5 to indicate that you want to show a _peek_ of the next slide on the shelf. | 5 |\n| summary | object | Schema declaring the desired related product shelf items. This prop object must contain the [product-summary.shelf block props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary%23configuration). | undefined |\n| ' infinite | boolean | Determines whether the list should be infinite (true) or not (false). When this prop is set as false, the slider will have an explicit end for users. | true |\n\n## Customization\n\nTo apply CSS customizations to this and other blocks, follow the instructions in [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization).\n\n| CSS Handles |\n| --------------- |\n| relatedProducts |\n\n> The CSS Handles list above refers to the `shelf.relatedProducts` block. Since the `shelf` block is deprecated, your shelf customization must be done using the CSS Handles available for the [Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarylist), the [Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary), and the [Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout) blocks.\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/guides/vtex-shelf/docs/apps/vtex.shelf%23configuration)\n\n[Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/docs/apps/vtex.shelf%23shelf)[RelatedProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/docs/apps/vtex.shelf%23relatedproducts)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/docs/apps/vtex.shelf%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_7d9dcc90
|
[
{
"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 pix instant payments in brazil 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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/docs/guides/payments-integration-purchase-flows)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/payments-integration-payment-app)\n\n[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/docs/guides/payments-integration-purchase-flows)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/payments-integration-payment-app)\n\n[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/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-pix-instant-payments-in-brazil/docs/guides)\n\nIntegration Guides\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/payments-integration-guide)\n\n[Pix: Instant Payments in Brazil](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/payments-integration-pix-instant-payments-in-brazil)\n\nPix: Instant Payments in Brazil\n\n[Pix](https://read.calvincode.net/reader?url=https://www.bcb.gov.br/estabilidadefinanceira/pix) is the instant payments ecosystem implementation led by the Central Bank of Brazil (BCB) to enable online money transfers with reduced costs, increased safety and 24/7 availability. Transfers occur directly from the payer’s account to the payee’s account, without the need for intermediaries, resulting in lower transaction costs.\n\nPix is available to both physical and legal persons, and both need to have an identifier key registered with some financial entity (banks, fintechs or payment institutions) to proceed with the transaction.\n\nAccording to the [eligibility criteria](https://read.calvincode.net/reader?url=https://www.bcb.gov.br/estabilidadefinanceira/participantespix) set forth by the BCB, certain financial entities will be required to offer this payment method, while others may optionally offer it or not be eligible to participate.\n\nIn this article, we will explain how to extend your Payment Provider Protocol implementation to allow stores to offer Pix as an additional payment method to their clients.\n\n\n\n> ✔️ If you want to know more about instant payments in Brazil, we have prepared a [blog post](https://read.calvincode.net/reader?url=https://vtex.com/pt-br/blog/produto/pix-no-e-commerce/) with all the implications of this new payment method. You can also check out the [FAQ](https://read.calvincode.net/reader?url=https://www.bcb.gov.br/estabilidadefinanceira/perguntaserespostaspix) provided by the BCB for more details.\n\n> This tutorial assumes you are already a [VTEX Partner](https://read.calvincode.net/reader?url=http://vtex.com/br-pt/partner) and understand how the [Payment Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol) works.\n\n## Integration conditions\n\nIf you are ready to develop the middleware that implements our Payment Provider Protocol, you should be aware of these requirements:\n\n* **All endpoints must be served over HTTPS on port 443 with TLS 1.2 support**: Connections over non-secured HTTP will not be accepted under any circumstances.\n* **The integrator must create a subdomain or a domain name for the provider endpoints**: IP addresses will not be accepted as names under any circumstances.\n* **The middleware must consistently respond within established response times**: We enforce a maximum response time of 5 seconds for homologation tests, as well as a maximum response time of 20 seconds to any other API request.\n\nWhile our protocol describes nine endpoints for implementation, not all of them are applicable when integrating Pix instant payments. Regarding the two provider flows:\n\n* [Payment Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23get-/manifest): six endpoints that must be mandatory implemented.\n* [Configuration Flow endpoints](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/authorization/token): three endpoints whose implementation is optional and currently not available for Pix.\n\nThe table below gives further detail on the applicability of each endpoint to Pix instant payments.\n\n| Provider Flow | Endpoint | Applicable to Pix? |\n| ------------- | ------------------------------ | ------------------ |\n| Payment | List Payment Provider Manifest | ✅ Yes |\n| Payment | Create Payment | ✅ Yes |\n| Payment | Cancel Payment | ✅ Yes |\n| Payment | Capture Payment | ✅ Yes |\n| Payment | Refund Payment | ✅ Yes |\n| Payment | Inbound Request (BETA) | ✅ Yes |\n| Payment | Create Authorization Token | ⛔ No |\n| Payment | Provider Authentication | ⛔ No |\n| Payment | Get Credentials | ⛔ No |\n\n> Pix is not available for marketplace clients that use the Checkout Split.\n\n> The following JSONs are just examples. Each partner must adapt the models to their own realities, with the data needed to realize the integration.\n\n## Integration steps\n\n### Establish the payment methods available\n\nThe first information your provider has to inform us is which are the payment methods that it handles. To do so, you can make an API request using the `<span class=\"api pg-type type-get\">`GET [List Payment Provider Manifest](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23get-/manifest) route.\n\nThe expected response is:\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 \"customFields\": [ \n\n33\n\n { \n\n34\n\n \"name\": \"Merchant's custom field\", \n\n35\n\n \"type\": \"text\" \n\n36\n\n }, \n\n37\n\n { \n\n38\n\n \"name\": \"Merchant's custom select field\", \n\n39\n\n \"type\": \"select\", \n\n40\n\n \"options\": [ \n\n41\n\n { \n\n42\n\n \"text\": \"Field option 1\", \n\n43\n\n \"value\": \"1\", \n\n44\n\n }, \n\n45\n\n { \n\n46\n\n \"text\": \"Field option 2\", \n\n47\n\n \"value\": \"2\", \n\n48\n\n }, \n\n49\n\n { \n\n50\n\n \"text\": \"Field option 3\", \n\n51\n\n \"value\": \"3\", \n\n52\n\n } \n\n53\n\n ] \n\n54\n\n } \n\n55\n\n ] \n\n56\n\n} \n\n`\n\n> Pix still does not handle payment split, but this feature may be released in the future. For more information on payment methods that currently accept split, check the [List Payment Provider Manifest endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23get-/manifest).\n\n### Create Pix Payment Method\n\nNow you have to create a new payment method. To do this, use the route `<span class=\"api pg-type type-post\">`POST [Create Payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments).\n\n> A lot of information is required from the cart data in the Smart Checkout, so be careful and validate all payload information.\n\nSee an example of the Create Payment request:\n\n`1\n\n{ \n\n2\n\n \"reference\": \"32478982\", \n\n3\n\n \"orderId\": \"v967373115140abc\", \n\n4\n\n \"transactionId\": \"D3AA1FC8372E430E8236649DB5EBD08E\", \n\n5\n\n \"paymentId\": \"F5C1A4E20D3B4E07B7E871F5B5BC9F91\", \n\n6\n\n \"paymentMethod\": \"Pix\", \n\n7\n\n \"paymentMethodCustomCode\": null, \n\n8\n\n \"merchantName\": \"mystore\", \n\n9\n\n \"value\": 4307.23, \n\n10\n\n \"currency\": \"BRL\", \n\n11\n\n \"installments\": 31, \n\n12\n\n \"deviceFingerprint\": \"12ade389087fe\", \n\n13\n\n \"card\": { \n\n14\n\n \"holder\": null, \n\n15\n\n \"number\": null, \n\n16\n\n \"csc\": null, \n\n17\n\n \"expiration\": { \n\n18\n\n \"month\": null, \n\n19\n\n \"year\": null \n\n20\n\n } \n\n21\n\n }, \n\n22\n\n \"miniCart\": { \n\n23\n\n \"shippingValue\": 11.44, \n\n24\n\n \"taxValue\": 10.01, \n\n25\n\n \"buyer\": { \n\n26\n\n \"id\": \"c1245228-1c68-11e6-94ac-0afa86a846a5\", \n\n27\n\n \"firstName\": \"John\", \n\n28\n\n \"lastName\": \"Doe\", \n\n29\n\n \"document\": \"01234567890\", \n\n30\n\n \"documentType\": \"CPF\", \n\n31\n\n \"email\": \"john.doe@example.com\", \n\n32\n\n \"phone\": \"+5521987654321\" \n\n33\n\n }, \n\n34\n\n \"shippingAddress\": { \n\n35\n\n \"country\": \"BRA\", \n\n36\n\n \"street\": \"Praia de Botafogo St.\", \n\n37\n\n \"number\": \"300\", \n\n38\n\n \"complement\": \"3rd Floor\", \n\n39\n\n \"neighborhood\": \"Botafogo\", \n\n40\n\n \"postalCode\": \"22250040\", \n\n41\n\n \"city\": \"Rio de Janeiro\", \n\n42\n\n \"state\": \"RJ\" \n\n43\n\n }, \n\n44\n\n \"billingAddress\": { \n\n45\n\n \"country\": \"BRA\", \n\n46\n\n \"street\": \"Brigadeiro Faria Lima Avenue\", \n\n47\n\n \"number\": \"4440\", \n\n48\n\n \"complement\": \"10th Floor\", \n\n49\n\n \"neighborhood\": \"Itaim Bibi\", \n\n50\n\n \"postalCode\": \"04538132\", \n\n51\n\n \"city\": \"São Paulo\", \n\n52\n\n \"state\": \"SP\" \n\n53\n\n }, \n\n54\n\n \"items\": [ \n\n55\n\n { \n\n56\n\n \"id\": \"132981\", \n\n57\n\n \"name\": \"My First Product\", \n\n58\n\n \"price\": 2134.90, \n\n59\n\n \"quantity\": 2, \n\n60\n\n \"discount\": 5.00 \n\n61\n\n }, \n\n62\n\n { \n\n63\n\n \"id\": \"123242\", \n\n64\n\n \"name\": \"My Second Product\", \n\n65\n\n \"price\": 21.98, \n\n66\n\n \"quantity\": 1, \n\n67\n\n \"discount\": 1.00 \n\n68\n\n } \n\n69\n\n ] \n\n70\n\n }, \n\n71\n\n \"url\": \"https://admin.mystore.example.com/orders/v32478982\", \n\n72\n\n \"callbackUrl\": \"https://api.example.com/some-path/to-notify/status-changes?an=mystore\", \n\n73\n\n \"returnUrl\": \"https://mystore.example.com/checkout/order/v32478982\" \n\n74\n\n} \n\n`\n\nAs a result, we expect the following response:\n\n`1\n\n{ \n\n2\n\n \"paymentId\": \"F5C1A4E20D3B4E07B7E871F5B5BC9F91\", \n\n3\n\n \"status\": \"undefined\", \n\n4\n\n \"tid\": \"TID1578324421\", \n\n5\n\n \"authorizationId\": null, \n\n6\n\n \"nsu\": null, \n\n7\n\n \"code\": \"APP123\", \n\n8\n\n \"paymentAppData\": { \n\n9\n\n \"payload\": \"{\\\"code\\\":\\\"https://bacen.pix/pix/code\\\",\\\"qrCodeBase64Image\\\":\\\"iVBORw0KGgoAAAANSUhEUgAAAAIAAAACCAYAAABytg0kAAABQGlDQ1BJQ0MgUHJvZmlsZQAAKJFjYGDiSSwoyGFhYGDIzSspCnJ3UoiIjFJgf8LAxSDMwMkgwiCZmFxc4BgQ4ANUwgCjUcG3awyMIPqyLsgspwWXFu+Xeyundb6w0WL33C5M9SiAKyW1OBlI/wHihOSCohIGBsYYIFu5vKQAxG4AskWKgI4CsqeA2OkQ9goQOwnC3gNWExLkDGRfALIFkjMSU4DsB0C2ThKSeDoSG2ovCLAZGZkbhBNwKKmgJLWiBEQ75xdUFmWmZ5QoOAJDJ1XBMy9ZT0fByMDIgIEBFNYQ1Z9vgMOQUYwDIZapzMBgmQEUfIQQSxNmYNiZzsDAU4UQU5/PwMBrxMBw5GJBYlEi3AGM31iK04yNIGzu7QwMrNP+//8M9Ca7JgPD3+v////e/v//32UMDMy3GBgOfAMA4+RdqZ9YRkcAAABWZVhJZk1NACoAAAAIAAGHaQAEAAAAAQAAABoAAAAAAAOShgAHAAAAEgAAAESgAgAEAAAAAQAAAAKgAwAEAAAAAQAAAAIAAAAAQVNDSUkAAABTY3JlZW5zaG900Fpo3gAAAdJpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDUuNC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6ZXhpZj0iaHR0cDovL25zLmFkb2JlLmNvbS9leGlmLzEuMC8iPgogICAgICAgICA8ZXhpZjpQaXhlbFhEaW1lbnNpb24+MjwvZXhpZjpQaXhlbFhEaW1lbnNpb24+CiAgICAgICAgIDxleGlmOlVzZXJDb21tZW50PlNjcmVlbnNob3Q8L2V4aWY6VXNlckNvbW1lbnQ+CiAgICAgICAgIDxleGlmOlBpeGVsWURpbWVuc2lvbj4yPC9leGlmOlBpeGVsWURpbWVuc2lvbj4KICAgICAgPC9yZGY6RGVzY3JpcHRpb24+CiAgIDwvcmRmOlJERj4KPC94OnhtcG1ldGE+Cl89Cn4AAAASSURBVAgdY/wPBAxAwAQiQAAAPfgEAIAu9DkAAAAASUVORK5CYII=\\\"}\" \n\n10\n\n }, \n\n11\n\n \"message\": \"The customer needs to finish the payment flow\", \n\n12\n\n \"delayToAutoSettle\": 1209600, \n\n13\n\n \"delayToAutoSettleAfterAntifraud\": 120, \n\n14\n\n \"delayToCancel\": 1800 \n\n15\n\n} \n\n`\n\n> The PIX QR Code expiration time must be set between 15 and 60 minutes (900 and 3600 seconds). Also, the partner must respect the callback time (20 seconds).\n\nFor more information, access the [Create Payment endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments).\n\n### Cancel a Payment\n\nTo cancel a payment, you must already have created one. To do so, you will make an API request using the route `<span class=\"api pg-type type-post\">`POST [Cancel Payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments/-paymentId-/cancellations).\n\nSee an example of the Cancel Payment request:\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\nFor more information, access the [Cancel Payment endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments/-paymentId-/cancellations).\n\n### Settle Payment (capture)\n\nIf your transaction was completed successfully, the provider can settle the payment.\n\nThus, in order to settle the payment, VTEX will send the information below through the `<span class=\"api pg-type type-post\">`POST [Settle Payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments/-paymentId-/settlements).\n\nSee an example of the Settle Payment request:\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 should be similar to the following response body:\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\nFor more information, access the [Settle Payment endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments/-paymentId-/settlements).\n\n### Refund Payment\n\nThe provider should be ready to receive the following request through the `<span class=\"api pg-type type-post\">`POST [Refund Payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments/-paymentId-/refunds).\n\nSee an example of the Refund Payment 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 expected response 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\nFor more information, access the [Refund Payment endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments/-paymentId-/refunds).\n\n### Communicate with the Gateway\n\nThe last endpoint, the `<span class=\"api pg-type type-post\">`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-), implements a URL that facilitates a direct connection between our Gateway service and the Payment Provider.\n\nSee an example of the Inbound Request (BETA) request:\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\nAs a result, the client should send the following response:\n\n`1\n\n{ \n\n2\n\n \"requestId\": \"{{requestId}}\", \n\n3\n\n \"transactionId\": \"{{transactionId}}\", \n\n4\n\n \"paymentId\": \"{{paymentId}}\", \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\n> The Inbound Request (BETA) is mandatory only for integrations via Payment Provider Protocol with an external Payment App. If the Pix payment method was implemented via VTEX Payment App, the Inbound Request is not necessary. For more information, access the [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-).\n\nFor more information about the Pix, access its [FAQ](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/pix-faq--3lx7zCU2lQroTEBCYKYbo3).\n\nAfter completing all integration steps, you should complete our [homologation process](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation) to allow VTEX stores to use your provider as a payment method.\n\nContributors\n\n4\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/karenkrieger)\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-pix-instant-payments-in-brazil.md)\n\n[Custom Auto Capture Feature« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil//docs/guides/custom-auto-capture-feature)[PSE Payment MethodNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil//docs/guides/pse-payment-method)\n\nContributors\n\n4\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/karenkrieger)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Integration conditions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/payments-integration-pix-instant-payments-in-brazil%23integration-conditions)\n\n[Integration steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/payments-integration-pix-instant-payments-in-brazil%23integration-steps)\n\n[Establish the payment methods available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/payments-integration-pix-instant-payments-in-brazil%23establish-the-payment-methods-available)[Create Pix Payment Method](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/payments-integration-pix-instant-payments-in-brazil%23create-pix-payment-method)[Cancel a Payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/payments-integration-pix-instant-payments-in-brazil%23cancel-a-payment)[Settle Payment (capture)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/payments-integration-pix-instant-payments-in-brazil%23settle-payment-capture)[Refund Payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/payments-integration-pix-instant-payments-in-brazil%23refund-payment)[Communicate with the Gateway](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/payments-integration-pix-instant-payments-in-brazil%23communicate-with-the-gateway)\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-pix-instant-payments-in-brazil.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Integration conditions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/payments-integration-pix-instant-payments-in-brazil%23integration-conditions)\n\n[Integration steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/payments-integration-pix-instant-payments-in-brazil%23integration-steps)\n\n[Establish the payment methods available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/payments-integration-pix-instant-payments-in-brazil%23establish-the-payment-methods-available)[Create Pix Payment Method](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/payments-integration-pix-instant-payments-in-brazil%23create-pix-payment-method)[Cancel a Payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/payments-integration-pix-instant-payments-in-brazil%23cancel-a-payment)[Settle Payment (capture)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/payments-integration-pix-instant-payments-in-brazil%23settle-payment-capture)[Refund Payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/payments-integration-pix-instant-payments-in-brazil%23refund-payment)[Communicate with the Gateway](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pix-instant-payments-in-brazil/docs/guides/payments-integration-pix-instant-payments-in-brazil%23communicate-with-the-gateway)\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_da6582d9
|
[
{
"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 creating a product availability form 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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-product-availability-form/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-product-availability-form/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-product-availability-form/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-product-availability-form/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-product-availability-form/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-product-availability-form/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-product-availability-form/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/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-creating-a-product-availability-form/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-product-availability-form/docs/guides/store-framework)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-product-availability-form/docs/guides/store-framework-using-components)\n\n[Creating a product availability form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-product-availability-form/docs/guides/vtex-io-documentation-creating-a-product-availability-form)\n\nCreating a product availability form\n\nLearn how to create a product availability form with this step-by-step guide.\n\nWhile browsing through a store's catalog, the user may feel disappointed if they are interested in a product not available for purchase at the moment.\n\nTo avoid frustration, you can make a product availability form available whenever your store's products are displayed as unavailable. Therefore, users can fill out a form linked to the product, expressing their interest in requesting the purchase as soon as the product is available again.\n\nTo set up the product availability form, follow the step-by-step below.\n\n> This configuration does not include sending automatic e-mails to users. The product availability form only stores the user data filled out in the form to the store's Master Data entity.\n\n## Instructions\n\n### Step 1 - Creating a Master Data entity\n\nThe first step is to create a new entity in the VTEX [Master Data module](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/what-is-master-data--4otjBnR27u4WUIciQsmkAw?locale=en), responsible for creating database architectures for a store.\n\nThe new module’s entity will cover the set of user data filled in and sent in the availability form. Therefore, your first step is to [create a new Master Data entity](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/creating-data-entity--tutorials%5F1265).\n\nIt must be named `AS` and contain the fields stated above to properly work with the form:\n\n| Field name | Field type |\n| ---------------- | ----------- |\n| skuId | Integer |\n| name | Text |\n| email | Email |\n| notificationSend | Boolean |\n| createdAt | Varchar 100 |\n| sendAt | Varchar 100 |\n\n### Step 2 - Creating the JSON Schema in Master Data\n\nOnce you created the entity to work with the form correctly, it is time to define how it will communicate with the availability form, which will happen through a [JSON schema](https://read.calvincode.net/reader?url=https://json-schema.org/understanding-json-schema/).\n\nThe JSON schema will be responsible for telling your form fields which data they must receive, i.e., which kind of input they should expect from users according to the Master Data entity's fields.\n\nIn addition to that, the schema will also be responsible for saving all user data fetched from the form in the Master Data's Entity `AS` created in the previous step.\n\n1. Using a tool of your preference, run the Master Data's [Get Schemas](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23get-/api/dataentities/-dataEntityName-/schemas) API, replacing the `data_entity_name` value with `AS`;\n2. In the response, look for fields added previously to the entity and copy the structures in which these are being displayed. This will help you to create another JSON Schema for the form, including those fields now as properties;\n3. Run the Master Data's [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-) API, pasting the schema structure copied in the second step in the request's body. Remember that this schema structure is using the entity fields, and you should replace them for the schema's properties as stated in the example below:\n\n`1\n\n{ \n\n2\n\n \"title\": \"Person\", \n\n3\n\n \"type\": \"object\", \n\n4\n\n \"properties\": { \n\n5\n\n \"skuID\": { \n\n6\n\n \"type\": \"string\", \n\n7\n\n \"title\": \"SKU ID\", \n\n8\n\n \"description\": \"The SKU ID desired by user, which will be watched for changes in the product quantity.\" \n\n9\n\n }, \n\n10\n\n \"name\": { \n\n11\n\n \"type\": \"string\", \n\n12\n\n \"title\": \"User's name\", \n\n13\n\n \"description\": \"The user's name.\" \n\n14\n\n }, \n\n15\n\n \"email\": { \n\n16\n\n \"type\": \"string\", \n\n17\n\n \"title\": \"User's email\", \n\n18\n\n \"description\": \"The user's email.\" \n\n19\n\n }, \n\n20\n\n \"notificationSend\": { \n\n21\n\n \"type\": \"string\", \n\n22\n\n \"title\": \"Availability notification\", \n\n23\n\n \"description\": \"Whether the availability notification has been already sent or not.\" \n\n24\n\n }, \n\n25\n\n \"createdAt\": { \n\n26\n\n \"type\": \"string\", \n\n27\n\n \"title\": \"Form creating.\", \n\n28\n\n \"description\": \"Date when the form was created. e.g.: ISO (2011-10-05T14:48:00.000Z).\" \n\n29\n\n }, \n\n30\n\n \"sendAt\": { \n\n31\n\n \"type\": \"string\", \n\n32\n\n \"title\": \"User notification\", \n\n33\n\n \"description\": \"Date when the user was notified regarding the product availability. e.g.: ISO (2011-10-05T14:48:00.000Z).\" \n\n34\n\n } \n\n35\n\n }, \n\n36\n\n \"v-security\": { \n\n37\n\n \"publicWrite\": [ \"publicForWrite\" ], \n\n38\n\n \"publicJsonSchema\": true \n\n39\n\n } \n\n40\n\n} \n\n`\n\nThis will create the JSON Schema, which the Availability Subscriber block will use, a native component from Store Framework, to store the users’ data in the Master Data entity `AS`.\n\n### Step 3 - Configure the Availability Subscriber block\n\nLastly, it is time to configure the Availability Subscriber block to make your store render the native Store Framework component for an availability form.\n\nAccess the [Availability Subscriber app documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-availabilitysubscriber) and follow the step-by-step to complete its configuration.\n\nOnce the availability form is configured in your store, users interested in unavailable products will be able to share their e-mails using the component.\n\nThe best part about it is that your store will receive this data and automatically save it in Master Data for subsequent communication actions.\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-creating-a-product-availability-form.md)\n\n[Creating a native form for your store users« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-product-availability-form//docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users)[Overriding native app blocksNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-product-availability-form//docs/guides/vtex-io-documentation-overriding-native-app-blocks)\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-creating-a-product-availability-form/docs/guides/vtex-io-documentation-creating-a-product-availability-form%23instructions)\n\n[Step 1 - Creating a Master Data entity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-product-availability-form/docs/guides/vtex-io-documentation-creating-a-product-availability-form%23step-1-creating-a-master-data-entity)[Step 2 - Creating the JSON Schema in Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-product-availability-form/docs/guides/vtex-io-documentation-creating-a-product-availability-form%23step-2-creating-the-json-schema-in-master-data)[Step 3 - Configure the Availability Subscriber block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-product-availability-form/docs/guides/vtex-io-documentation-creating-a-product-availability-form%23step-3-configure-the-availability-subscriber-block)\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-creating-a-product-availability-form.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-creating-a-product-availability-form/docs/guides/vtex-io-documentation-creating-a-product-availability-form%23instructions)\n\n[Step 1 - Creating a Master Data entity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-product-availability-form/docs/guides/vtex-io-documentation-creating-a-product-availability-form%23step-1-creating-a-master-data-entity)[Step 2 - Creating the JSON Schema in Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-product-availability-form/docs/guides/vtex-io-documentation-creating-a-product-availability-form%23step-2-creating-the-json-schema-in-master-data)[Step 3 - Configure the Availability Subscriber block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-product-availability-form/docs/guides/vtex-io-documentation-creating-a-product-availability-form%23step-3-configure-the-availability-subscriber-block)\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_60add0fe
|
[
{
"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 developing and overriding components list of native sections 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/developing-and-overriding-components-list-of-native-sections/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/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/developing-and-overriding-components-list-of-native-sections/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/developing-and-overriding-components-list-of-native-sections/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/developing-and-overriding-components-list-of-native-sections/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/developing-and-overriding-components-list-of-native-sections/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/developing-and-overriding-components-list-of-native-sections/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/developing-and-overriding-components-list-of-native-sections/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/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/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/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/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/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/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/developing-and-overriding-components-list-of-native-sections/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/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/overrides-overview)\n\n[Section override - Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/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/developing-and-overriding-components-list-of-native-sections/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/developing-and-overriding-components-list-of-native-sections/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/developing-and-overriding-components-list-of-native-sections/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/developing-and-overriding-components-list-of-native-sections/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/developing-and-overriding-components-list-of-native-sections/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/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/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/developing-and-overriding-components-list-of-native-sections/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/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/developing-and-overriding-components-list-of-native-sections/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/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/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/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/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/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/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/developing-and-overriding-components-list-of-native-sections/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/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/overrides-overview)\n\n[Section override - Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/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/developing-and-overriding-components-list-of-native-sections/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/developing-and-overriding-components-list-of-native-sections/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/developing-and-overriding-components-list-of-native-sections/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/developing-and-overriding-components-list-of-native-sections/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/developing-and-overriding-components-list-of-native-sections/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/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/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/developing-and-overriding-components-list-of-native-sections/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-overview)\n\nList of Native Sections and Overridable Components\n\nSections in FastStore are components that organize and encapsulate other components, enabling you to create cohesive and functional content for your store.\n\nFor example, the [Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero) is a native section designed to capture your brand's identity and messaging. To effectively function in the store, the Hero comprises three components: `Hero`, `HeroImage`, and `HeroHeader`.\n\n## Considerations while customizing default components\n\nOverriding certain FastStore components can affect the store’s behavior. For example, customizing `__experimentalProductCard` and `SearchInput` can impact your store's analytics tracking. These components collect data for the [Intelligent Search Analytics](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/analytics--6qRMAHDL9hvv3oE0bh8mA1), so it's crucial to maintain their tracking functionality when making modifications.\n\nSee below how customizing certain components can affect your store.\n\n### `__experimentalProductCard`\n\n**Impacted sections:** [ProductGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-list-of-native-sections%23productgallery) and [ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-list-of-native-sections%23productshelf).\n\nTo ensure that click events on this component continue to be recorded after overriding the component, use the [useProductLink\\_unstable hook](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-experimental-exports-hooks-and-components%23hooks). For more information on how to use the `useProductLink_unstable` hook and how to add it to the component, see the [Experimental exports - Hooks and Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-experimental-exports-hooks-and-components).\n\n> For reference, view the default [ProductCard](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/blob/91d2669f5d390da4a3889f9c12948290c213866d/packages/core/src/components/product/ProductCard/ProductCard.tsx%23L88) implementation on GitHub.\n\n### `SearchInput`\n\n**Impacted section:** [Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-list-of-native-sections%23navbar)\n\nCustomizing the `SearchInput` may affect the tracking of search events. To maintain this functionality, you'll need to ensure that search events are logged even after modifications to the component.\n\n1. Add the following code to the custom component you are overriding (based on the default [SearchInput](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/blob/94f1d5be2e0fa11a98a5b6a08f0d68a8eb2bd95b/packages/core/src/components/search/SearchInput/SearchInput.tsx%23L62) component):\n\n`1\n\nconst sendAnalytics = async (term: string) => { \n\n2\n\n import('@faststore/sdk').then(({ sendAnalyticsEvent }) => { \n\n3\n\n sendAnalyticsEvent<SearchEvent>({ \n\n4\n\n name: 'search', \n\n5\n\n params: { search_term: term }, \n\n6\n\n }) \n\n7\n\n }) \n\n8\n\n} \n\n`\n\n1. Within the custom component, make sure the `sendAnalytics` function is called whenever a user enters a search term. The following code is an example calling the `sendAnalytics` function based on the [FastStore default implementation](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/blob/94f1d5be2e0fa11a98a5b6a08f0d68a8eb2bd95b/packages/core/src/components/search/SearchInput/SearchInput.tsx%23L102). Adjust the code to suit your specific context as needed.\n\n`1\n\nconst onSearchSelection: SearchProviderContextValue['onSearchSelection'] = ( \n\n2\n\n term, \n\n3\n\n path \n\n4\n\n) => { \n\n5\n\n addToSearchHistory({ term, path }) \n\n6\n\n sendAnalytics(term) \n\n7\n\n setSearchDropdownVisible(false) \n\n8\n\n} \n\n`\n\n## FastStore Native Sections\n\nCheck out below a list of FastStore native sections, their components that can be overridden, and if there are props that can be changed through the Headless CMS.\n\n> Components prefixed with `__experimental` indicate that they can be overridden. However, their props are not accessible. **We do not recommend** overriding these components unless it is necessary.\n\n### Alert\n\n| Type | Availability |\n| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Overridable components | [Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert)[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons) |\n| Headless CMS: props customization | Icon dismissible |\n\n**Alert - Available schema**\n\nCheck the available Headless CMS schema that you can customize for this component:\n\n`1\n\n{ \n\n2\n\n \"name\": \"NewSectionName\", \n\n3\n\n \"schema\": { \n\n4\n\n \"title\": \"Add the Section name\", \n\n5\n\n \"description\": \"Short description for the section's purpose\", \n\n6\n\n \"type\": \"object\", \n\n7\n\n \"required\": [\"icon\", \"content\", \"dismissible\"], \n\n8\n\n \"properties\": { \n\n9\n\n \"icon\": { \n\n10\n\n \"type\": \"string\", \n\n11\n\n \"title\": \"Icon\", \n\n12\n\n \"enumNames\": [ \n\n13\n\n \"Bell\", \n\n14\n\n \"BellRinging\", \n\n15\n\n \"Checked\", \n\n16\n\n \"Info\", \n\n17\n\n \"Truck\", \n\n18\n\n \"User\" \n\n19\n\n ], \n\n20\n\n \"enum\": [\"Bell\", \"BellRinging\", \"Checked\", \"Info\", \"Truck\", \"User\"] \n\n21\n\n }, \n\n22\n\n \"content\": { \"type\": \"string\", \"title\": \"Content\" }, \n\n23\n\n \"link\": { \n\n24\n\n \"title\": \"Link\", \n\n25\n\n \"type\": \"object\", \n\n26\n\n \"properties\": { \n\n27\n\n \"text\": { \"type\": \"string\", \"title\": \"Link Text\" }, \n\n28\n\n \"to\": { \"type\": \"string\", \"title\": \"Action link\" } \n\n29\n\n } \n\n30\n\n }, \n\n31\n\n \"dismissible\": { \n\n32\n\n \"type\": \"boolean\", \n\n33\n\n \"default\": false, \n\n34\n\n \"title\": \"Is dismissible?\" \n\n35\n\n } \n\n36\n\n } \n\n37\n\n } \n\n38\n\n } \n\n`\n\n---\n\n### BannerText\n\n| Type | Availability |\n| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| Overridable components | [BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-banner-text) [BannerTextContent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-banner-text%23banner-text-content) |\n| Headless CMS: props customization | ColorVariant Variant |\n\n**BannerText - Available schema**\n\nCheck the available Headless CMS schema that you can customize for this component:\n\n`1\n\n { \n\n2\n\n \"name\": \"NewSectionName\", \n\n3\n\n \"requiredScopes\": [], \n\n4\n\n \"schema\": { \n\n5\n\n \"title\": \"Add the Section name\", \n\n6\n\n \"description\": \"Short description for the the section's purpose\", \n\n7\n\n \"type\": \"object\", \n\n8\n\n \"required\": [\"title\", \"caption\", \"link\"], \n\n9\n\n \"properties\": { \n\n10\n\n \"title\": { \n\n11\n\n \"title\": \"Title\", \n\n12\n\n \"type\": \"string\" \n\n13\n\n }, \n\n14\n\n \"caption\": { \n\n15\n\n \"title\": \"Caption\", \n\n16\n\n \"type\": \"string\" \n\n17\n\n }, \n\n18\n\n \"link\": { \n\n19\n\n \"title\": \"Call to Action\", \n\n20\n\n \"type\": \"object\", \n\n21\n\n \"required\": [\"text\", \"url\"], \n\n22\n\n \"properties\": { \n\n23\n\n \"text\": { \n\n24\n\n \"title\": \"Text\", \n\n25\n\n \"type\": \"string\" \n\n26\n\n }, \n\n27\n\n \"url\": { \n\n28\n\n \"title\": \"URL\", \n\n29\n\n \"type\": \"string\" \n\n30\n\n }, \n\n31\n\n \"linkTargetBlank\": { \n\n32\n\n \"type\": \"boolean\", \n\n33\n\n \"title\": \"Open link in new window?\", \n\n34\n\n \"default\": false \n\n35\n\n } \n\n36\n\n } \n\n37\n\n }, \n\n38\n\n \"colorVariant\": { \n\n39\n\n \"type\": \"string\", \n\n40\n\n \"title\": \"Color variant\", \n\n41\n\n \"enumNames\": [\"Main\", \"Light\", \"Accent\"], \n\n42\n\n \"enum\": [\"main\", \"light\", \"accent\"] \n\n43\n\n }, \n\n44\n\n \"variant\": { \n\n45\n\n \"type\": \"string\", \n\n46\n\n \"title\": \"Variant\", \n\n47\n\n \"enumNames\": [\"Primary\", \"Secondary\"], \n\n48\n\n \"enum\": [\"primary\", \"secondary\"] \n\n49\n\n } \n\n50\n\n } \n\n51\n\n } \n\n52\n\n } \n\n`\n\n---\n\n### Breadcrumb\n\n| Type | Availability |\n| --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Overridable components | [Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb)[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon) |\n| Headless CMS: props customization | Icon (HomeIcon) |\n\n**Breadcrumb - Available schema**\n\nCheck the available Headless CMS schema that you can customize for this component:\n\n`1\n\n{ \n\n2\n\n \"name\": \"NewSectionName\", \n\n3\n\n \"requiredScopes\": [\"pdp\", \"plp\"], \n\n4\n\n \"schema\": { \n\n5\n\n \"title\": \"Add the Section name\", \n\n6\n\n \"description\": \"Short description for the the section's purpose\", \n\n7\n\n \"type\": \"object\", \n\n8\n\n \"required\": [\"icon\", \"alt\"], \n\n9\n\n \"properties\": { \n\n10\n\n \"icon\": { \n\n11\n\n \"title\": \"Icon\", \n\n12\n\n \"type\": \"string\", \n\n13\n\n \"enumNames\": [\"House\"], \n\n14\n\n \"enum\": [\"House\"] \n\n15\n\n }, \n\n16\n\n \"alt\": { \n\n17\n\n \"title\": \"Alternative Label\", \n\n18\n\n \"type\": \"string\" \n\n19\n\n } \n\n20\n\n } \n\n21\n\n } \n\n22\n\n } \n\n`\n\n---\n\n---\n\n### CrossSellingShelf\n\n| Type | Availability |\n| --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |\n| Overridable components | [ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf)\\_\\_experimentalCarousel\\_\\_experimentalProductCard |\n| Headless CMS: props customization | title kind |\n\n**CrossSellingShelf - Available schema**\n\nCheck the available Headless CMS schema that you can customize for this component:\n\n`1\n\n{ \n\n2\n\n \"name\": \"NewSectionName\", \n\n3\n\n \"requiredScopes\": [\"pdp\", \"custom\"], \n\n4\n\n \"schema\": { \n\n5\n\n \"title\": \"Add the Section name\", \n\n6\n\n \"description\": \"Short description for the the section's purpose\", \n\n7\n\n \"type\": \"object\", \n\n8\n\n \"required\": [\"title\", \"numberOfItems\", \"kind\"], \n\n9\n\n \"properties\": { \n\n10\n\n \"title\": { \n\n11\n\n \"title\": \"Title\", \n\n12\n\n \"type\": \"string\" \n\n13\n\n }, \n\n14\n\n \"numberOfItems\": { \n\n15\n\n \"title\": \"Total number of items\", \n\n16\n\n \"type\": \"integer\", \n\n17\n\n \"default\": 5, \n\n18\n\n \"description\": \"Total number of items. The quantity may be smaller if the query returns fewer products.\" \n\n19\n\n }, \n\n20\n\n \"itemsPerPage\": { \n\n21\n\n \"type\": \"integer\", \n\n22\n\n \"title\": \"Number of items per page\", \n\n23\n\n \"default\": 5, \n\n24\n\n \"description\": \"Number of items to display per page in carousel\" \n\n25\n\n }, \n\n26\n\n \"kind\": { \n\n27\n\n \"title\": \"Kind\", \n\n28\n\n \"description\": \"Change cross selling types\", \n\n29\n\n \"default\": \"buy\", \n\n30\n\n \"enum\": [\"buy\", \"view\"], \n\n31\n\n \"enumNames\": [\"Who bought also bought\", \"Who saw also saw\"] \n\n32\n\n }, \n\n33\n\n \"taxesConfiguration\": { \n\n34\n\n \"title\": \"Taxes Configuration\", \n\n35\n\n \"type\": \"object\", \n\n36\n\n \"properties\": { \n\n37\n\n \"usePriceWithTaxes\": { \n\n38\n\n \"title\": \"Should use taxes to calculate the price?\", \n\n39\n\n \"type\": \"boolean\", \n\n40\n\n \"default\": false \n\n41\n\n }, \n\n42\n\n \"taxesLabel\": { \n\n43\n\n \"title\": \"Tax label to be displayed\", \n\n44\n\n \"type\": \"string\", \n\n45\n\n \"default\": \"Tax included\" \n\n46\n\n } \n\n47\n\n } \n\n48\n\n } \n\n49\n\n } \n\n50\n\n } \n\n51\n\n}, \n\n`\n\n---\n\n### EmptyState\n\n| Type | Availability |\n| --------------------------------- | ------------------------------------------------------------------------------------- |\n| Overridable components | [EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state) |\n| Headless CMS: props customization | title titleIcon variant bkgColor |\n\n**Empty State - Available schema**\n\nCheck the available Headless CMS schema that you can customize for this component:\n\n`1\n\n{ \n\n2\n\n \"name\": \"NewSectionName\", \n\n3\n\n \"schema\": { \n\n4\n\n \"title\": \"Add the Section name\", \n\n5\n\n \"type\": \"object\", \n\n6\n\n \"description\": \"Short description for the the section's purpose\", \n\n7\n\n \"properties\": { \n\n8\n\n \"title\": { \n\n9\n\n \"title\": \"Title\", \n\n10\n\n \"type\": \"string\" \n\n11\n\n }, \n\n12\n\n \"titleIcon\": { \n\n13\n\n \"title\": \"Title Icon\", \n\n14\n\n \"type\": \"object\", \n\n15\n\n \"properties\": { \n\n16\n\n \"icon\": { \n\n17\n\n \"title\": \"Icon\", \n\n18\n\n \"type\": \"string\", \n\n19\n\n \"enumNames\": [\"CircleWavy Warning\"], \n\n20\n\n \"enum\": [\"CircleWavyWarning\"] \n\n21\n\n }, \n\n22\n\n \"alt\": { \n\n23\n\n \"title\": \"Alternative Label\", \n\n24\n\n \"type\": \"string\" \n\n25\n\n } \n\n26\n\n } \n\n27\n\n }, \n\n28\n\n \"subtitle\": { \n\n29\n\n \"title\": \"Subtitle\", \n\n30\n\n \"type\": \"string\" \n\n31\n\n }, \n\n32\n\n \"showLoader\": { \n\n33\n\n \"type\": \"boolean\", \n\n34\n\n \"title\": \"Show loader?\", \n\n35\n\n \"default\": false \n\n36\n\n }, \n\n37\n\n \"errorState\": { \n\n38\n\n \"title\": \"Error state used for shown errorId and fromUrl properties in 500 and 404 pages\", \n\n39\n\n \"type\": \"object\", \n\n40\n\n \"properties\": { \n\n41\n\n \"errorId\": { \n\n42\n\n \"title\": \"errorId used in 500 and 404 pages\", \n\n43\n\n \"type\": \"object\", \n\n44\n\n \"properties\": { \n\n45\n\n \"show\": { \n\n46\n\n \"type\": \"boolean\", \n\n47\n\n \"title\": \"Show errorId in the end of message?\" \n\n48\n\n }, \n\n49\n\n \"description\": { \n\n50\n\n \"type\": \"string\", \n\n51\n\n \"title\": \"Description shown before the errorId\" \n\n52\n\n } \n\n53\n\n } \n\n54\n\n }, \n\n55\n\n \"fromUrl\": { \n\n56\n\n \"title\": \"fromUrl used in 500 and 404 pages\", \n\n57\n\n \"type\": \"object\", \n\n58\n\n \"properties\": { \n\n59\n\n \"show\": { \n\n60\n\n \"type\": \"boolean\", \n\n61\n\n \"title\": \"Show fromUrl in the end of message?\" \n\n62\n\n }, \n\n63\n\n \"description\": { \n\n64\n\n \"type\": \"string\", \n\n65\n\n \"title\": \"Description shown before the fromUrl\" \n\n66\n\n } \n\n67\n\n } \n\n68\n\n } \n\n69\n\n } \n\n70\n\n } \n\n71\n\n } \n\n72\n\n } \n\n73\n\n} \n\n`\n\n---\n\n### Hero\n\n| Type | Availability |\n| --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Overridable Components | [Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero) [HeroImage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero%23heroimage) [HeroHeader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero%23heroheader) |\n| Headless CMS: props customization | ButtonProps (Label, Icon) ColorVariant Variant |\n\n**Hero - Available schema**\n\nCheck the available Headless CMS schema that you can customize for this component:\n\n`1\n\n { \n\n2\n\n \"name\": \"NewSectionName\", \n\n3\n\n \"requiredScopes\": [], \n\n4\n\n \"schema\": { \n\n5\n\n \"title\": \"Add the Section name\", \n\n6\n\n \"description\": \"Short description for the the section's purpose\", \n\n7\n\n \"type\": \"object\", \n\n8\n\n \"required\": [\"title\"], \n\n9\n\n \"properties\": { \n\n10\n\n \"title\": { \"title\": \"Title\", \"type\": \"string\" }, \n\n11\n\n \"subtitle\": { \"title\": \"Subtitle\", \"type\": \"string\" }, \n\n12\n\n \"link\": { \n\n13\n\n \"title\": \"Call to Action\", \n\n14\n\n \"type\": \"object\", \n\n15\n\n \"properties\": { \n\n16\n\n \"text\": { \"type\": \"string\", \"title\": \"Text\" }, \n\n17\n\n \"url\": { \"type\": \"string\", \"title\": \"URL\" }, \n\n18\n\n \"linkTargetBlank\": { \n\n19\n\n \"type\": \"boolean\", \n\n20\n\n \"title\": \"Open link in new window?\", \n\n21\n\n \"default\": false \n\n22\n\n } \n\n23\n\n } \n\n24\n\n }, \n\n25\n\n \"image\": { \n\n26\n\n \"type\": \"object\", \n\n27\n\n \"title\": \"Image\", \n\n28\n\n \"properties\": { \n\n29\n\n \"src\": { \n\n30\n\n \"type\": \"string\", \n\n31\n\n \"title\": \"Image\", \n\n32\n\n \"widget\": { \"ui:widget\": \"media-gallery\" } \n\n33\n\n }, \n\n34\n\n \"alt\": { \"type\": \"string\", \"title\": \"Alternative Label\" } \n\n35\n\n } \n\n36\n\n }, \n\n37\n\n \"colorVariant\": { \n\n38\n\n \"type\": \"string\", \n\n39\n\n \"title\": \"Color variant\", \n\n40\n\n \"enumNames\": [\"Main\", \"Light\", \"Accent\"], \n\n41\n\n \"enum\": [\"main\", \"light\", \"accent\"] \n\n42\n\n }, \n\n43\n\n \"variant\": { \n\n44\n\n \"type\": \"string\", \n\n45\n\n \"title\": \"Variant\", \n\n46\n\n \"enumNames\": [\"Primary\", \"Secondary\"], \n\n47\n\n \"enum\": [\"primary\", \"secondary\"] \n\n48\n\n } \n\n49\n\n } \n\n50\n\n } \n\n51\n\n } \n\n`\n\n---\n\n### Navbar\n\n| Type | Availability |\n| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Overridable components | [Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar) [NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links) [NavbarLinksList](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links%23navbar-links-list) [NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider) [NavbarSliderHeader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider%23navbar-slider-header) [NavbarSliderContent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider%23navbar-slider-content) [NavbarSliderFooter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider%23navbar-slider-content) [NavbarHeader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar%23navbar-header) [NavbarRow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar%23navbar-row) [NavbarButtons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar%23navbar-buttons) [IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button)\\_experimentalButtonSignIn: Overriding this prop will prevent the default redirect to the /account page.\\_\\_experimentalSKUMatrixSidebar: Overriding this prop customizes the Quick Order SKU selection sidebar in the Navbar, improving the bulk add-to-cart process for B2B use cases. |\n| Headless CMS: props customization | NavbarRow: LogoNavbarButtons: SignIn Button Icon, Cart IconNavigation: Regionalization Icon, Menu Icon, Home Icon |\n\n**Navbar - Available schema**\n\nCheck the available Headless CMS schema that you can customize for this component:\n\n`1\n\n{ \n\n2\n\n \"name\": \"NewSectionName\", \n\n3\n\n \"requiredScopes\": [], \n\n4\n\n \"schema\": { \n\n5\n\n \"title\": \"Add the Section name\", \n\n6\n\n \"description\": \"Short description for the the section's purpose\", \n\n7\n\n \"required\": [\"logo\"], \n\n8\n\n \"properties\": { \n\n9\n\n \"logo\": { \n\n10\n\n \"title\": \"Logo\", \n\n11\n\n \"type\": \"object\", \n\n12\n\n \"required\": [\"src\"], \n\n13\n\n \"properties\": { \n\n14\n\n \"src\": { \n\n15\n\n \"title\": \"Image\", \n\n16\n\n \"type\": \"string\", \n\n17\n\n \"widget\": { \"ui:widget\": \"media-gallery\" } \n\n18\n\n }, \n\n19\n\n \"alt\": { \"title\": \"Alternative Label\", \"type\": \"string\" }, \n\n20\n\n \"link\": { \n\n21\n\n \"title\": \"Logo Link\", \n\n22\n\n \"type\": \"object\", \n\n23\n\n \"required\": [\"url\", \"title\"], \n\n24\n\n \"properties\": { \n\n25\n\n \"url\": { \"title\": \"Link URL\", \"type\": \"string\" }, \n\n26\n\n \"title\": { \"title\": \"Link Title\", \"type\": \"string\" } \n\n27\n\n } \n\n28\n\n } \n\n29\n\n } \n\n30\n\n }, \n\n31\n\n \"searchInput\": { \n\n32\n\n \"title\": \"Search Input\", \n\n33\n\n \"description\": \"Search Input configurations\", \n\n34\n\n \"type\": \"object\", \n\n35\n\n \"required\": [\"sort\"], \n\n36\n\n \"properties\": { \n\n37\n\n \"sort\": { \n\n38\n\n \"title\": \"Results default sort value\", \n\n39\n\n \"type\": \"string\", \n\n40\n\n \"default\": \"score_desc\", \n\n41\n\n \"enumNames\": [ \n\n42\n\n \"Price, descending\", \n\n43\n\n \"Price, ascending\", \n\n44\n\n \"Top sales\", \n\n45\n\n \"Name, A-Z\", \n\n46\n\n \"Name, Z-A\", \n\n47\n\n \"Release date\", \n\n48\n\n \"Discount\", \n\n49\n\n \"Relevance\" \n\n50\n\n ], \n\n51\n\n \"enum\": [ \n\n52\n\n \"price_desc\", \n\n53\n\n \"price_asc\", \n\n54\n\n \"orders_desc\", \n\n55\n\n \"name_asc\", \n\n56\n\n \"name_desc\", \n\n57\n\n \"release_desc\", \n\n58\n\n \"discount_desc\", \n\n59\n\n \"score_desc\" \n\n60\n\n ] \n\n61\n\n } \n\n62\n\n } \n\n63\n\n }, \n\n64\n\n \"signInButton\": { \n\n65\n\n \"title\": \"Sign In Button\", \n\n66\n\n \"type\": \"object\", \n\n67\n\n \"properties\": { \n\n68\n\n \"icon\": { \n\n69\n\n \"title\": \"Icon\", \n\n70\n\n \"type\": \"object\", \n\n71\n\n \"properties\": { \n\n72\n\n \"icon\": { \n\n73\n\n \"title\": \"Icon\", \n\n74\n\n \"type\": \"string\", \n\n75\n\n \"enumNames\": [\"User\"], \n\n76\n\n \"enum\": [\"User\"], \n\n77\n\n \"default\": \"User\" \n\n78\n\n }, \n\n79\n\n \"alt\": { \n\n80\n\n \"title\": \"Alternative Label\", \n\n81\n\n \"type\": \"string\", \n\n82\n\n \"default\": \"User\" \n\n83\n\n } \n\n84\n\n } \n\n85\n\n }, \n\n86\n\n \"label\": { \n\n87\n\n \"title\": \"Call to Action\", \n\n88\n\n \"type\": \"string\", \n\n89\n\n \"default\": \"Sign In\" \n\n90\n\n }, \n\n91\n\n \"myAccountLabel\": { \n\n92\n\n \"title\": \"My Account Label\", \n\n93\n\n \"type\": \"string\", \n\n94\n\n \"default\": \"My Account\" \n\n95\n\n } \n\n96\n\n } \n\n97\n\n }, \n\n98\n\n \"cartIcon\": { \n\n99\n\n \"title\": \"Cart Icon\", \n\n100\n\n \"type\": \"object\", \n\n101\n\n \"properties\": { \n\n102\n\n \"icon\": { \n\n103\n\n \"title\": \"Icon\", \n\n104\n\n \"type\": \"string\", \n\n105\n\n \"enumNames\": [\"Shopping Cart\"], \n\n106\n\n \"enum\": [\"ShoppingCart\"], \n\n107\n\n \"default\": \"ShoppingCart\" \n\n108\n\n }, \n\n109\n\n \"alt\": { \n\n110\n\n \"title\": \"Alternative Label\", \n\n111\n\n \"type\": \"string\", \n\n112\n\n \"default\": \"Shopping Cart\" \n\n113\n\n } \n\n114\n\n } \n\n115\n\n }, \n\n116\n\n \"navigation\": { \n\n117\n\n \"title\": \"Navigation\", \n\n118\n\n \"type\": \"object\", \n\n119\n\n \"properties\": { \n\n120\n\n \"regionalization\": { \n\n121\n\n \"type\": \"object\", \n\n122\n\n \"title\": \"Regionalization\", \n\n123\n\n \"properties\": { \n\n124\n\n \"enabled\": { \n\n125\n\n \"type\": \"boolean\", \n\n126\n\n \"title\": \"Use Regionalization?\", \n\n127\n\n \"default\": true \n\n128\n\n }, \n\n129\n\n \"icon\": { \n\n130\n\n \"title\": \"Icon\", \n\n131\n\n \"type\": \"object\", \n\n132\n\n \"properties\": { \n\n133\n\n \"icon\": { \n\n134\n\n \"title\": \"Icon\", \n\n135\n\n \"type\": \"string\", \n\n136\n\n \"enumNames\": [\"Map Pin\"], \n\n137\n\n \"enum\": [\"MapPin\"], \n\n138\n\n \"default\": \"MapPin\" \n\n139\n\n }, \n\n140\n\n \"alt\": { \n\n141\n\n \"title\": \"Alternative Label\", \n\n142\n\n \"type\": \"string\", \n\n143\n\n \"default\": \"MapPin\" \n\n144\n\n } \n\n145\n\n } \n\n146\n\n }, \n\n147\n\n \"label\": { \n\n148\n\n \"title\": \"Call to Action\", \n\n149\n\n \"type\": \"string\", \n\n150\n\n \"default\": \"Set Location\" \n\n151\n\n } \n\n152\n\n } \n\n153\n\n }, \n\n154\n\n \"pageLinks\": { \n\n155\n\n \"title\": \"Links\", \n\n156\n\n \"type\": \"array\", \n\n157\n\n \"maxItems\": 8, \n\n158\n\n \"items\": { \n\n159\n\n \"title\": \"Link\", \n\n160\n\n \"type\": \"object\", \n\n161\n\n \"required\": [\"text\", \"url\"], \n\n162\n\n \"properties\": { \n\n163\n\n \"text\": { \"title\": \"Link Text\", \"type\": \"string\" }, \n\n164\n\n \"url\": { \"title\": \"Link URL\", \"type\": \"string\" } \n\n165\n\n } \n\n166\n\n } \n\n167\n\n }, \n\n168\n\n \"menu\": { \n\n169\n\n \"type\": \"object\", \n\n170\n\n \"title\": \"Menu\", \n\n171\n\n \"properties\": { \n\n172\n\n \"icon\": { \n\n173\n\n \"title\": \"Icon\", \n\n174\n\n \"type\": \"object\", \n\n175\n\n \"properties\": { \n\n176\n\n \"icon\": { \n\n177\n\n \"title\": \"Icon\", \n\n178\n\n \"type\": \"string\", \n\n179\n\n \"enumNames\": [\"List\"], \n\n180\n\n \"enum\": [\"List\"], \n\n181\n\n \"default\": \"List\" \n\n182\n\n }, \n\n183\n\n \"alt\": { \n\n184\n\n \"title\": \"Alternative Label\", \n\n185\n\n \"type\": \"string\", \n\n186\n\n \"default\": \"List\" \n\n187\n\n } \n\n188\n\n } \n\n189\n\n } \n\n190\n\n } \n\n191\n\n }, \n\n192\n\n \"home\": { \n\n193\n\n \"title\": \"Home\", \n\n194\n\n \"type\": \"object\", \n\n195\n\n \"properties\": { \n\n196\n\n \"label\": { \n\n197\n\n \"title\": \"Go to Home Label\", \n\n198\n\n \"type\": \"string\", \n\n199\n\n \"default\": \"Go to Home\" \n\n200\n\n } \n\n201\n\n } \n\n202\n\n } \n\n203\n\n } \n\n204\n\n } \n\n205\n\n } \n\n206\n\n } \n\n207\n\n } \n\n`\n\n---\n\n### Newsletter\n\n| Type | Availability |\n| --------------------------------- | -------------------------------------------------------------------------------- |\n| Documentation | Coming soon! |\n| Overridable components | ToastIconSuccess ToastIconError HeaderIcon InputFieldName InputFieldEmail Button |\n| Headless CMS: props customization | Icon Variant (Lite / Full) |\n\n**Newsletter - Available schema**\n\nCheck the available Headless CMS schema that you can customize for this component:\n\n`1\n\n{ \n\n2\n\n \"name\": \"NewSectionName\", \n\n3\n\n \"requiredScopes\": [], \n\n4\n\n \"schema\": { \n\n5\n\n \"title\": \"Add the Section name\", \n\n6\n\n \"description\": \"Short description for the the section's purpose\", \n\n7\n\n \"type\": \"object\", \n\n8\n\n \"required\": [\"title\"], \n\n9\n\n \"properties\": { \n\n10\n\n \"icon\": { \n\n11\n\n \"title\": \"Icon\", \n\n12\n\n \"type\": \"object\", \n\n13\n\n \"properties\": { \n\n14\n\n \"icon\": { \n\n15\n\n \"title\": \"Icon\", \n\n16\n\n \"type\": \"string\", \n\n17\n\n \"enumNames\": [\"Envelope\"], \n\n18\n\n \"enum\": [\"Envelope\"], \n\n19\n\n \"default\": \"Envelope\" \n\n20\n\n }, \n\n21\n\n \"alt\": { \n\n22\n\n \"type\": \"string\", \n\n23\n\n \"title\": \"Alternative Label\", \n\n24\n\n \"default\": \"Envelope\" \n\n25\n\n } \n\n26\n\n } \n\n27\n\n }, \n\n28\n\n \"title\": { \n\n29\n\n \"title\": \"Title\", \n\n30\n\n \"type\": \"string\", \n\n31\n\n \"default\": \"Get News and Special Offers!\" \n\n32\n\n }, \n\n33\n\n \"description\": { \n\n34\n\n \"title\": \"Description\", \n\n35\n\n \"type\": \"string\", \n\n36\n\n \"default\": \"Receive our news and promotions in advance\" \n\n37\n\n }, \n\n38\n\n \"privacyPolicy\": { \n\n39\n\n \"title\": \"Privacy Policy Disclaimer\", \n\n40\n\n \"type\": \"string\", \n\n41\n\n \"widget\": { \"ui:widget\": \"draftjs-rich-text\" } \n\n42\n\n }, \n\n43\n\n \"emailInputLabel\": { \n\n44\n\n \"title\": \"Email input label\", \n\n45\n\n \"type\": \"string\", \n\n46\n\n \"default\": \"Your Email\" \n\n47\n\n }, \n\n48\n\n \"displayNameInput\": { \n\n49\n\n \"title\": \"Request name?\", \n\n50\n\n \"type\": \"boolean\", \n\n51\n\n \"default\": true \n\n52\n\n }, \n\n53\n\n \"nameInputLabel\": { \n\n54\n\n \"title\": \"Name input label\", \n\n55\n\n \"type\": \"string\", \n\n56\n\n \"default\": \"Your Name\" \n\n57\n\n }, \n\n58\n\n \"subscribeButtonLabel\": { \n\n59\n\n \"title\": \"Subscribe button label\", \n\n60\n\n \"type\": \"string\", \n\n61\n\n \"default\": \"Subscribe\" \n\n62\n\n }, \n\n63\n\n \"subscribeButtonLoadingLabel\": { \n\n64\n\n \"title\": \"Subscribe button loading label\", \n\n65\n\n \"type\": \"string\", \n\n66\n\n \"default\": \"Loading...\" \n\n67\n\n }, \n\n68\n\n \"card\": { \n\n69\n\n \"title\": \"Newsletter should be in card format?\", \n\n70\n\n \"type\": \"boolean\", \n\n71\n\n \"default\": false \n\n72\n\n }, \n\n73\n\n \"colorVariant\": { \n\n74\n\n \"title\": \"Color variant\", \n\n75\n\n \"type\": \"string\", \n\n76\n\n \"enumNames\": [\"Main\", \"Light\", \"Accent\"], \n\n77\n\n \"enum\": [\"main\", \"light\", \"accent\"], \n\n78\n\n \"default\": \"main\" \n\n79\n\n }, \n\n80\n\n \"toastSubscribe\": { \n\n81\n\n \"title\": \"Toast Subscribe\", \n\n82\n\n \"type\": \"object\", \n\n83\n\n \"properties\": { \n\n84\n\n \"title\": { \n\n85\n\n \"title\": \"Title\", \n\n86\n\n \"description\": \"Message Title\", \n\n87\n\n \"type\": \"string\", \n\n88\n\n \"default\": \"Hooray!\" \n\n89\n\n }, \n\n90\n\n \"message\": { \n\n91\n\n \"title\": \"Message\", \n\n92\n\n \"description\": \"Message\", \n\n93\n\n \"type\": \"string\", \n\n94\n\n \"default\": \"Thank for your subscription.\" \n\n95\n\n }, \n\n96\n\n \"icon\": { \n\n97\n\n \"title\": \"Icon\", \n\n98\n\n \"type\": \"string\", \n\n99\n\n \"enumNames\": [\"CircleWavyCheck\"], \n\n100\n\n \"enum\": [\"CircleWavyCheck\"], \n\n101\n\n \"default\": \"CircleWavyCheck\" \n\n102\n\n } \n\n103\n\n } \n\n104\n\n }, \n\n105\n\n \"toastSubscribeError\": { \n\n106\n\n \"title\": \"Toast Subscribe Error\", \n\n107\n\n \"type\": \"object\", \n\n108\n\n \"properties\": { \n\n109\n\n \"title\": { \n\n110\n\n \"title\": \"Title\", \n\n111\n\n \"description\": \"Message Title\", \n\n112\n\n \"type\": \"string\", \n\n113\n\n \"default\": \"Oops.\" \n\n114\n\n }, \n\n115\n\n \"message\": { \n\n116\n\n \"title\": \"Message\", \n\n117\n\n \"description\": \"Message\", \n\n118\n\n \"type\": \"string\", \n\n119\n\n \"default\": \"Something went wrong. Please Try again.\" \n\n120\n\n }, \n\n121\n\n \"icon\": { \n\n122\n\n \"title\": \"Icon\", \n\n123\n\n \"type\": \"string\", \n\n124\n\n \"enumNames\": [\"CircleWavyWarning\"], \n\n125\n\n \"enum\": [\"CircleWavyWarning\"], \n\n126\n\n \"default\": \"CircleWavyWarning\" \n\n127\n\n } \n\n128\n\n } \n\n129\n\n } \n\n130\n\n } \n\n131\n\n } \n\n132\n\n } \n\n`\n\n---\n\n### ProductDetails\n\n| Type | Availability |\n| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Overridable components | [ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-title)[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-discount-badge)[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button)[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon)[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-quantity-selector)[SkuSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-sku-selector)[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation)[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery)[ImageGalleryViewer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-image-gallery) \\_\\_experimentalImageGalleryImage \\_\\_experimentalImageGallery \\_\\_experimentalShippingSimulation \\_\\_experimentalProductDetailsSettings |\n| Headless CMS: props customization | ProductTitle: showDiscountBadge, discountBadgeSize, showReferenceNumberBuyButton: Icon |\n\n**Product Details - Available schema**\n\nCheck the available Headless CMS schema that you can customize for this component:\n\n`1\n\n{ \n\n2\n\n \"name\": \"NewSectionName\", \n\n3\n\n \"requiredScopes\": [\"pdp\"], \n\n4\n\n \"schema\": { \n\n5\n\n \"title\": \"Add the Section name\", \n\n6\n\n \"description\": \"Short description for the the section's purpose\", \n\n7\n\n \"type\": \"object\", \n\n8\n\n \"properties\": { \n\n9\n\n \"productTitle\": { \n\n10\n\n \"title\": \"Product Title\", \n\n11\n\n \"type\": \"object\", \n\n12\n\n \"properties\": { \n\n13\n\n \"discountBadge\": { \n\n14\n\n \"title\": \"Discount Badge\", \n\n15\n\n \"type\": \"object\", \n\n16\n\n \"properties\": { \n\n17\n\n \"showDiscountBadge\": { \n\n18\n\n \"title\": \"Show Discount Badge?\", \n\n19\n\n \"type\": \"boolean\", \n\n20\n\n \"default\": false \n\n21\n\n }, \n\n22\n\n \"size\": { \n\n23\n\n \"title\": \"Size\", \n\n24\n\n \"type\": \"string\", \n\n25\n\n \"enumNames\": [\"Big\", \"Small\"], \n\n26\n\n \"enum\": [\"big\", \"small\"] \n\n27\n\n } \n\n28\n\n } \n\n29\n\n }, \n\n30\n\n \"refNumber\": { \n\n31\n\n \"title\": \"Show Reference Number?\", \n\n32\n\n \"type\": \"boolean\", \n\n33\n\n \"default\": false \n\n34\n\n } \n\n35\n\n } \n\n36\n\n }, \n\n37\n\n \"buyButton\": { \n\n38\n\n \"title\": \"Buy Button\", \n\n39\n\n \"type\": \"object\", \n\n40\n\n \"properties\": { \n\n41\n\n \"title\": { \n\n42\n\n \"title\": \"Title\", \n\n43\n\n \"type\": \"string\", \n\n44\n\n \"default\": \"Add to Cart\" \n\n45\n\n }, \n\n46\n\n \"icon\": { \n\n47\n\n \"title\": \"Icon\", \n\n48\n\n \"type\": \"object\", \n\n49\n\n \"properties\": { \n\n50\n\n \"icon\": { \n\n51\n\n \"title\": \"Icon\", \n\n52\n\n \"type\": \"string\", \n\n53\n\n \"enumNames\": [\"Shopping Cart\"], \n\n54\n\n \"enum\": [\"ShoppingCart\"] \n\n55\n\n }, \n\n56\n\n \"alt\": { \n\n57\n\n \"type\": \"string\", \n\n58\n\n \"title\": \"Alternative Label\", \n\n59\n\n \"default\": \"Shopping Cart\" \n\n60\n\n } \n\n61\n\n } \n\n62\n\n } \n\n63\n\n } \n\n64\n\n }, \n\n65\n\n \"notAvailableButton\": { \n\n66\n\n \"title\": \"Not Available Button\", \n\n67\n\n \"description\": \"Shown when a SKU is not available\", \n\n68\n\n \"type\": \"object\", \n\n69\n\n \"properties\": { \n\n70\n\n \"title\": { \n\n71\n\n \"title\": \"Title\", \n\n72\n\n \"type\": \"string\", \n\n73\n\n \"default\": \"Not Available\" \n\n74\n\n } \n\n75\n\n } \n\n76\n\n }, \n\n77\n\n \"shippingSimulator\": { \n\n78\n\n \"title\": \"Shipping Simulation\", \n\n79\n\n \"type\": \"object\", \n\n80\n\n \"properties\": { \n\n81\n\n \"title\": { \n\n82\n\n \"title\": \"Title\", \n\n83\n\n \"type\": \"string\", \n\n84\n\n \"default\": \"Shipping\" \n\n85\n\n }, \n\n86\n\n \"inputLabel\": { \n\n87\n\n \"title\": \"Input Label\", \n\n88\n\n \"type\": \"string\", \n\n89\n\n \"default\": \"Postal Code\" \n\n90\n\n }, \n\n91\n\n \"link\": { \n\n92\n\n \"title\": \"Postal Code Discovery\", \n\n93\n\n \"type\": \"object\", \n\n94\n\n \"properties\": { \n\n95\n\n \"text\": { \n\n96\n\n \"title\": \"Link Text\", \n\n97\n\n \"type\": \"string\", \n\n98\n\n \"default\": \"I don't know my Postal Code\" \n\n99\n\n }, \n\n100\n\n \"to\": { \"title\": \"URL\", \"type\": \"string\" } \n\n101\n\n } \n\n102\n\n }, \n\n103\n\n \"shippingOptionsTableTitle\": { \n\n104\n\n \"title\": \"Shipping Options Table Header\", \n\n105\n\n \"type\": \"string\" \n\n106\n\n } \n\n107\n\n } \n\n108\n\n }, \n\n109\n\n \"productDescription\": { \n\n110\n\n \"title\": \"Product Description\", \n\n111\n\n \"type\": \"object\", \n\n112\n\n \"properties\": { \n\n113\n\n \"initiallyExpanded\": { \n\n114\n\n \"type\": \"string\", \n\n115\n\n \"title\": \"Initially Expanded?\", \n\n116\n\n \"enumNames\": [\"First\", \"All\", \"None\"], \n\n117\n\n \"enum\": [\"first\", \"all\", \"none\"] \n\n118\n\n }, \n\n119\n\n \"displayDescription\": { \n\n120\n\n \"title\": \"Should display description?\", \n\n121\n\n \"type\": \"boolean\", \n\n122\n\n \"default\": true \n\n123\n\n }, \n\n124\n\n \"title\": { \n\n125\n\n \"title\": \"Description section title\", \n\n126\n\n \"type\": \"string\", \n\n127\n\n \"default\": \"Description\" \n\n128\n\n } \n\n129\n\n } \n\n130\n\n } \n\n131\n\n } \n\n132\n\n } \n\n133\n\n } \n\n`\n\n---\n\n### ProductGallery\n\n| Type | Availability |\n| --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Documentation | [FastStore UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/components) |\n| Overridable components | MobileFilterButton [(Button)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button) FilterIcon [(Icon)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon) PrevIcon [(Icon)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon) ResultsCountSkeleton [(Skeleton)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-skeleton) SortSkeleton [(Skeleton)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-skeleton) FilterButtonSkeleton [(Skeleton)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-skeleton) LinkButtonPrev [(LinkButton)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-link-button) LinkButtonNext [(LinkButton)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-link-button) \\_\\_experimentalFilterDesktop \\_\\_experimentalFilterSlider \\_\\_experimentalProductCard \\_\\_experimentalEmptyGallery |\n| Headless CMS: props customization | Previous Page Button: IconMobile Filter Button: IconProduct Card Configuration: showDiscountBadge, bordered |\n\n**Product Gallery - Available schema**\n\nCheck the available Headless CMS schema that you can customize for this component:\n\n`1\n\n{ \n\n2\n\n \"name\": \"NewSectionName\", \n\n3\n\n \"requiredScopes\": [\"plp\", \"search\"], \n\n4\n\n \"schema\": { \n\n5\n\n \"title\": \"Add the Section name\", \n\n6\n\n \"description\": \"Short description for the the section's purpose\", \n\n7\n\n \"type\": \"object\", \n\n8\n\n \"required\": [\"filter\"], \n\n9\n\n \"properties\": { \n\n10\n\n \"searchTermLabel\": { \n\n11\n\n \"title\": \"Search page term label\", \n\n12\n\n \"type\": \"string\", \n\n13\n\n \"default\": \"Showing results for:\" \n\n14\n\n }, \n\n15\n\n \"totalCountLabel\": { \n\n16\n\n \"title\": \"Total count label\", \n\n17\n\n \"type\": \"string\", \n\n18\n\n \"default\": \"Results\" \n\n19\n\n }, \n\n20\n\n \"previousPageButton\": { \n\n21\n\n \"title\": \"Previous page button\", \n\n22\n\n \"type\": \"object\", \n\n23\n\n \"required\": [\"icon\", \"label\"], \n\n24\n\n \"properties\": { \n\n25\n\n \"icon\": { \n\n26\n\n \"title\": \"Icon\", \n\n27\n\n \"type\": \"object\", \n\n28\n\n \"properties\": { \n\n29\n\n \"icon\": { \n\n30\n\n \"title\": \"Icon\", \n\n31\n\n \"type\": \"string\", \n\n32\n\n \"enumNames\": [\"ArrowLeft\"], \n\n33\n\n \"enum\": [\"ArrowLeft\"], \n\n34\n\n \"default\": \"ArrowLeft\" \n\n35\n\n }, \n\n36\n\n \"alt\": { \n\n37\n\n \"title\": \"Alternative label\", \n\n38\n\n \"type\": \"string\", \n\n39\n\n \"default\": \"Arrow Left icon\" \n\n40\n\n } \n\n41\n\n } \n\n42\n\n }, \n\n43\n\n \"label\": { \n\n44\n\n \"title\": \"Previous page button\", \n\n45\n\n \"type\": \"string\", \n\n46\n\n \"default\": \"Previous Page\" \n\n47\n\n } \n\n48\n\n } \n\n49\n\n }, \n\n50\n\n \"loadMorePageButton\": { \n\n51\n\n \"title\": \"Load more products Button\", \n\n52\n\n \"type\": \"object\", \n\n53\n\n \"required\": [\"label\"], \n\n54\n\n \"properties\": { \n\n55\n\n \"label\": { \n\n56\n\n \"title\": \"Load more products label\", \n\n57\n\n \"type\": \"string\", \n\n58\n\n \"default\": \"Load more products\" \n\n59\n\n } \n\n60\n\n } \n\n61\n\n }, \n\n62\n\n \"filter\": { \n\n63\n\n \"title\": \"Filter\", \n\n64\n\n \"type\": \"object\", \n\n65\n\n \"required\": [\"title\", \"mobileOnly\"], \n\n66\n\n \"properties\": { \n\n67\n\n \"title\": { \n\n68\n\n \"title\": \"Filter title\", \n\n69\n\n \"type\": \"string\", \n\n70\n\n \"default\": \"Filters\" \n\n71\n\n }, \n\n72\n\n \"mobileOnly\": { \n\n73\n\n \"title\": \"Mobile Only\", \n\n74\n\n \"type\": \"object\", \n\n75\n\n \"required\": [ \n\n76\n\n \"filterButton\", \n\n77\n\n \"clearButtonLabel\", \n\n78\n\n \"applyButtonLabel\" \n\n79\n\n ], \n\n80\n\n \"properties\": { \n\n81\n\n \"filterButton\": { \n\n82\n\n \"title\": \"Show filter button\", \n\n83\n\n \"type\": \"object\", \n\n84\n\n \"required\": [\"label\", \"icon\"], \n\n85\n\n \"properties\": { \n\n86\n\n \"label\": { \n\n87\n\n \"title\": \"Label\", \n\n88\n\n \"type\": \"string\", \n\n89\n\n \"default\": \"Filters\" \n\n90\n\n }, \n\n91\n\n \"icon\": { \n\n92\n\n \"title\": \"Icon\", \n\n93\n\n \"type\": \"object\", \n\n94\n\n \"required\": [\"icon\", \"alt\"], \n\n95\n\n \"properties\": { \n\n96\n\n \"icon\": { \n\n97\n\n \"title\": \"Icon\", \n\n98\n\n \"type\": \"string\", \n\n99\n\n \"enumNames\": [\"FadersHorizontal\"], \n\n100\n\n \"enum\": [\"FadersHorizontal\"], \n\n101\n\n \"default\": \"FadersHorizontal\" \n\n102\n\n }, \n\n103\n\n \"alt\": { \n\n104\n\n \"title\": \"Alternative label\", \n\n105\n\n \"type\": \"string\", \n\n106\n\n \"default\": \"Open Filters\" \n\n107\n\n } \n\n108\n\n } \n\n109\n\n } \n\n110\n\n } \n\n111\n\n }, \n\n112\n\n \"clearButtonLabel\": { \n\n113\n\n \"title\": \"Clear button label\", \n\n114\n\n \"type\": \"string\", \n\n115\n\n \"default\": \"Clear All\" \n\n116\n\n }, \n\n117\n\n \"applyButtonLabel\": { \n\n118\n\n \"title\": \"Apply button label\", \n\n119\n\n \"type\": \"string\", \n\n120\n\n \"default\": \"Apply\" \n\n121\n\n } \n\n122\n\n } \n\n123\n\n } \n\n124\n\n } \n\n125\n\n }, \n\n126\n\n \"productCard\": { \n\n127\n\n \"title\": \"Product Card Configuration\", \n\n128\n\n \"type\": \"object\", \n\n129\n\n \"properties\": { \n\n130\n\n \"showDiscountBadge\": { \n\n131\n\n \"title\": \"Show discount badge?\", \n\n132\n\n \"type\": \"boolean\", \n\n133\n\n \"default\": true \n\n134\n\n }, \n\n135\n\n \"bordered\": { \n\n136\n\n \"title\": \"Cards should be bordered?\", \n\n137\n\n \"type\": \"boolean\", \n\n138\n\n \"default\": true \n\n139\n\n } \n\n140\n\n } \n\n141\n\n }, \n\n142\n\n \"emptyGallery\": { \n\n143\n\n \"title\": \"Empty Gallery\", \n\n144\n\n \"type\": \"object\", \n\n145\n\n \"properties\": { \n\n146\n\n \"title\": { \n\n147\n\n \"title\": \"Title\", \n\n148\n\n \"type\": \"string\", \n\n149\n\n \"default\": \"Nothing matches with your search\" \n\n150\n\n }, \n\n151\n\n \"firstButton\": { \n\n152\n\n \"title\": \"First Button\", \n\n153\n\n \"type\": \"object\", \n\n154\n\n \"properties\": { \n\n155\n\n \"label\": { \n\n156\n\n \"type\": \"string\", \n\n157\n\n \"title\": \"Label\", \n\n158\n\n \"default\": \"Browse Offers\" \n\n159\n\n }, \n\n160\n\n \"url\": { \n\n161\n\n \"type\": \"string\", \n\n162\n\n \"title\": \"URL\", \n\n163\n\n \"default\": \"/office\" \n\n164\n\n }, \n\n165\n\n \"icon\": { \n\n166\n\n \"title\": \"Icon\", \n\n167\n\n \"type\": \"string\", \n\n168\n\n \"default\": \"CircleWavyWarning\" \n\n169\n\n } \n\n170\n\n } \n\n171\n\n }, \n\n172\n\n \"secondButton\": { \n\n173\n\n \"title\": \"Second Button\", \n\n174\n\n \"type\": \"object\", \n\n175\n\n \"properties\": { \n\n176\n\n \"label\": { \n\n177\n\n \"type\": \"string\", \n\n178\n\n \"title\": \"Label\", \n\n179\n\n \"default\": \"Just Arrived\" \n\n180\n\n }, \n\n181\n\n \"url\": { \n\n182\n\n \"type\": \"string\", \n\n183\n\n \"title\": \"URL\", \n\n184\n\n \"default\": \"/technology\" \n\n185\n\n }, \n\n186\n\n \"icon\": { \n\n187\n\n \"title\": \"Icon\", \n\n188\n\n \"type\": \"string\", \n\n189\n\n \"default\": \"RocketLaunch\" \n\n190\n\n } \n\n191\n\n } \n\n192\n\n } \n\n193\n\n } \n\n194\n\n } \n\n195\n\n } \n\n196\n\n } \n\n197\n\n } \n\n`\n\n---\n\n### ProductShelf\n\n| Type | Availability |\n| --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |\n| Overridable components | [ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf) \\_\\_experimentalCarousel \\_\\_experimentalProductCard |\n| Headless CMS: props customization | Product Card Configuration: showDiscountBadge, bordered |\n\n**Product Shelf - Available schema**\n\nCheck the available Headless CMS schema that you can customize for this component:\n\n`1\n\n{ \n\n2\n\n \"name\": \"NewSectionName\", \n\n3\n\n \"requiredScopes\": [], \n\n4\n\n \"schema\": { \n\n5\n\n \"title\": \"Add the Section name\", \n\n6\n\n \"description\": \"Short description for the the section's purpose\", \n\n7\n\n \"type\": \"object\", \n\n8\n\n \"required\": [\"title\", \"numberOfItems\", \"after\", \"sort\"], \n\n9\n\n \"properties\": { \n\n10\n\n \"title\": { \"type\": \"string\", \"title\": \"Title\" }, \n\n11\n\n \"numberOfItems\": { \n\n12\n\n \"type\": \"integer\", \n\n13\n\n \"title\": \"Total number of items\", \n\n14\n\n \"default\": 5, \n\n15\n\n \"description\": \"Total number of items. The quantity may be smaller if the query returns fewer products.\" \n\n16\n\n }, \n\n17\n\n \"itemsPerPage\": { \n\n18\n\n \"type\": \"integer\", \n\n19\n\n \"title\": \"Number of items per page\", \n\n20\n\n \"default\": 5, \n\n21\n\n \"description\": \"Number of items to display per page in carousel\" \n\n22\n\n }, \n\n23\n\n \"after\": { \n\n24\n\n \"type\": \"integer\", \n\n25\n\n \"title\": \"After\", \n\n26\n\n \"default\": \"0\", \n\n27\n\n \"description\": \"Initial pagination item\" \n\n28\n\n }, \n\n29\n\n \"sort\": { \n\n30\n\n \"title\": \"Sort\", \n\n31\n\n \"description\": \"Items order\", \n\n32\n\n \"default\": \"score_desc\", \n\n33\n\n \"enum\": [ \n\n34\n\n \"discount_desc\", \n\n35\n\n \"name_asc\", \n\n36\n\n \"name_desc\", \n\n37\n\n \"orders_desc\", \n\n38\n\n \"price_asc\", \n\n39\n\n \"price_desc\", \n\n40\n\n \"release_desc\", \n\n41\n\n \"score_desc\" \n\n42\n\n ], \n\n43\n\n \"enumNames\": [ \n\n44\n\n \"Discount: higher to lower\", \n\n45\n\n \"Name: A-Z\", \n\n46\n\n \"Name: Z-A\", \n\n47\n\n \"Orders: higher to lower\", \n\n48\n\n \"Price: lower to higher\", \n\n49\n\n \"Price: higher to lower\", \n\n50\n\n \"Release date: newer to older\", \n\n51\n\n \"Relevance: higher to lower\" \n\n52\n\n ] \n\n53\n\n }, \n\n54\n\n \"term\": { \"type\": \"string\", \"title\": \"Search term\" }, \n\n55\n\n \"selectedFacets\": { \n\n56\n\n \"title\": \"Facets\", \n\n57\n\n \"type\": \"array\", \n\n58\n\n \"items\": { \n\n59\n\n \"title\": \"Facet\", \n\n60\n\n \"type\": \"object\", \n\n61\n\n \"required\": [\"key\", \"value\"], \n\n62\n\n \"properties\": { \n\n63\n\n \"key\": { \n\n64\n\n \"title\": \"Key\", \n\n65\n\n \"description\": \"For collections use: productClusterIds\", \n\n66\n\n \"type\": \"string\", \n\n67\n\n \"default\": \"productClusterIds\" \n\n68\n\n }, \n\n69\n\n \"value\": { \n\n70\n\n \"title\": \"Value\", \n\n71\n\n \"description\": \"E.g. For 'Most Wanted' collection, use: 140. To consult your collection ids go to Collections page\", \n\n72\n\n \"type\": \"string\", \n\n73\n\n \"default\": \"140\" \n\n74\n\n } \n\n75\n\n } \n\n76\n\n } \n\n77\n\n }, \n\n78\n\n \"productCardConfiguration\": { \n\n79\n\n \"title\": \"Product Card Configuration\", \n\n80\n\n \"type\": \"object\", \n\n81\n\n \"properties\": { \n\n82\n\n \"showDiscountBadge\": { \n\n83\n\n \"title\": \"Show discount badge?\", \n\n84\n\n \"type\": \"boolean\", \n\n85\n\n \"default\": true \n\n86\n\n }, \n\n87\n\n \"bordered\": { \n\n88\n\n \"title\": \"Cards should be bordered?\", \n\n89\n\n \"type\": \"boolean\", \n\n90\n\n \"default\": true \n\n91\n\n } \n\n92\n\n } \n\n93\n\n } \n\n94\n\n } \n\n95\n\n } \n\n96\n\n } \n\n`\n\n---\n\n### RegionBar\n\n| Type | Availability |\n| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Overridable components | [RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-region-bar) LocationIcon [(Icon)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon) ButtonIcon [(Icon)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon) |\n| Headless CMS: props customization | LocationIcon: IconButtonIcon: Icon |\n\n**Region Bar - Available schema**\n\nCheck the available Headless CMS schema that you can customize for this component:\n\n`1\n\n { \n\n2\n\n \"name\": \"NewSectionName\", \n\n3\n\n \"requiredScopes\": [], \n\n4\n\n \"schema\": { \n\n5\n\n \"title\": \"Add the Section name\", \n\n6\n\n \"description\": \"Short description for the the section's purpose\", \n\n7\n\n \"type\": \"object\", \n\n8\n\n \"required\": [\"label\"], \n\n9\n\n \"properties\": { \n\n10\n\n \"icon\": { \n\n11\n\n \"title\": \"Location Icon\", \n\n12\n\n \"type\": \"object\", \n\n13\n\n \"properties\": { \n\n14\n\n \"icon\": { \n\n15\n\n \"title\": \"Icon\", \n\n16\n\n \"type\": \"string\", \n\n17\n\n \"enumNames\": [\"Map Pin\"], \n\n18\n\n \"enum\": [\"MapPin\"], \n\n19\n\n \"default\": \"MapPin\" \n\n20\n\n }, \n\n21\n\n \"alt\": { \n\n22\n\n \"title\": \"Alternative Label\", \n\n23\n\n \"type\": \"string\", \n\n24\n\n \"default\": \"Map Pin icon\" \n\n25\n\n } \n\n26\n\n } \n\n27\n\n }, \n\n28\n\n \"label\": { \n\n29\n\n \"title\": \"Location label\", \n\n30\n\n \"type\": \"string\", \n\n31\n\n \"default\": \"Set your location\" \n\n32\n\n }, \n\n33\n\n \"editLabel\": { \n\n34\n\n \"title\": \"Location edit label\", \n\n35\n\n \"type\": \"string\", \n\n36\n\n \"default\": \"Edit\" \n\n37\n\n }, \n\n38\n\n \"buttonIcon\": { \n\n39\n\n \"title\": \"Button Icon\", \n\n40\n\n \"type\": \"object\", \n\n41\n\n \"properties\": { \n\n42\n\n \"icon\": { \n\n43\n\n \"title\": \"Icon\", \n\n44\n\n \"type\": \"string\", \n\n45\n\n \"enumNames\": [\"Caret Right\"], \n\n46\n\n \"enum\": [\"CaretRight\"], \n\n47\n\n \"default\": \"CaretRight\" \n\n48\n\n }, \n\n49\n\n \"alt\": { \n\n50\n\n \"title\": \"Alternative Label\", \n\n51\n\n \"type\": \"string\", \n\n52\n\n \"default\": \"Caret Right icon\" \n\n53\n\n } \n\n54\n\n } \n\n55\n\n } \n\n56\n\n } \n\n57\n\n } \n\n58\n\n } \n\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/list-of-native-sections.mdx)\n\n[Creating a new section« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section)[Experimental exports - Hooks and ComponentsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-experimental-exports-hooks-and-components)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Considerations while customizing default components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23considerations-while-customizing-default-components)\n\n[\\_\\_experimentalProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23experimentalproductcard)[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23searchinput)\n\n[FastStore Native Sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23faststore-native-sections)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23alert)[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23bannertext)[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23breadcrumb)[CrossSellingShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23crosssellingshelf)[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23emptystate)[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23hero)[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23navbar)[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23newsletter)[ProductDetails](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23productdetails)[ProductGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23productgallery)[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23productshelf)[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23regionbar)\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/list-of-native-sections.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Considerations while customizing default components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23considerations-while-customizing-default-components)\n\n[\\_\\_experimentalProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23experimentalproductcard)[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23searchinput)\n\n[FastStore Native Sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23faststore-native-sections)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23alert)[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23bannertext)[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23breadcrumb)[CrossSellingShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23crosssellingshelf)[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23emptystate)[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23hero)[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23navbar)[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23newsletter)[ProductDetails](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23productdetails)[ProductGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23productgallery)[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23productshelf)[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections%23regionbar)\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_a8fba8b2
|
[
{
"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 infocard 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-infocard/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-infocard/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-infocard/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-infocard/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-infocard/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-infocard/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-infocard/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-infocard/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-infocard/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-infocard/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-infocard/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-infocard/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-infocard/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-infocard/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-infocard/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-infocard/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-infocard/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-infocard/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-infocard/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-infocard/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-infocard/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-infocard/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-infocard/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-infocard/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-infocard/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-infocard/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-infocard/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-infocard/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-infocard/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-infocard/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-infocard/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-infocard/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-infocard/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-infocard/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-infocard/docs/vtex-io-apps)\n\nInfo Card\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 `info-card` component groups information on a single topic. It often includes text, an image, and a call-to-action button.\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 `info-card` block to the desired page template.\n2. Add the `info-card` block to the same template file using the props stated in the [Props](#props) table. For example:\n\n`1\n\n \"info-card\": { \n\n2\n\n \"props\": { \n\n3\n\n \"id\": \"info-card-example\", \n\n4\n\n \"isFullModeStyle\": false, \n\n5\n\n \"textPosition\": \"left\", \n\n6\n\n \"imageUrl\": \"https://storecomponents.vteximg.com.br/arquivos/banner-infocard2.png\", \n\n7\n\n \"headline\": \"Clearance Sale\", \n\n8\n\n \"callToActionText\": \"DISCOVER\", \n\n9\n\n \"callToActionUrl\": \"/sale/d\", \n\n10\n\n \"blockClass\": \"info-card-example\", \n\n11\n\n \"textAlignment\": \"center\", \n\n12\n\n \"fetchpriority\": \"auto\", \n\n13\n\n \"preload\": true \n\n14\n\n } \n\n15\n\n }, \n\n`\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| ---------------------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| blockClass | String | Extra class name for custom styling. | null |\n| callToActionLinkTarget | LinkTargetEnum | Where to display the call-to-action component's linked URL, as the name for a browsing context (a tab, window, or iframe). | \"\\_self\" |\n| callToActionMode | CallToActionEnum | Mode of the call-to-action component. | \"button\" |\n| callToActionText | string | Text displayed inside the call-to-action component. | \"\" |\n| callToActionUrl | string | URL of the call-to-action component. | \"\" |\n| headline | string | Headline of the Info Card. | null |\n| htmlId | string | ID of the container element. | null |\n| imageUrl | string | Path to the image used on desktop devices. | \"\" |\n| imageActionUrl | string | Redirect URL used when the image component is clicked. | \"\" |\n| isFullModeStyle | boolean | Style of the Info Card component. If true, the image component is used as the background, and text is displayed over it. | false |\n| linkTarget | LinkTargetEnum | Where to display the linked URL when the Info Card component is clicked. | \"\\_self\" |\n| mobileImageUrl | string | Path to the image used on mobile devices. If empty, the desktop image is used. | null |\n| subhead | string | Text to be displayed underneath the headline. If not provided, it will not be rendered. | null |\n| bodyText | string | Text to be displayed underneath the subhead. If not provided, it will not be rendered. | null |\n| textAlignment | TextAlignmentEnum | Text alignment inside the component: left, center or right. This prop is ignored if isFullModeStyle is true. | \"left\" |\n| textMode | TextModeEnum | Text mode used to process the text from headline and subhead props. | \"html\" |\n| textPosition | TextPositionEnum | Position of the text component: left, center or right. | \"left\" |\n| fetchpriority | string | The fetch priority hint ('high', 'low' or 'auto'). | |\n| auto | | | |\n| preload | boolean | Preloads the first image in a list, prioritizing the image display over other assets. | |\n| false | | | |\n\n#### `TextPositionEnum` possible values\n\n| Enum name | Enum value | Description |\n| --------- | ---------- | -------------------------------------------------------------------------------------- |\n| Left | 'left' | Text will be on the left. If isFullModeStyle is false, the image will be on the right. |\n| Center | 'center' | Text will be in the center. Not applicable if isFullModeStyle is false. |\n| Right | 'right' | Text will be on the right. If isFullModeStyle is false, the image will be on the left. |\n\n#### `CallToActionEnum` possible values\n\n| Enum name | Enum value | Description |\n| --------- | ---------- | ---------------------------------------------------------------- |\n| None | none | Does not render any call-to-action components. |\n| Button | button | Renders the call-to-action component as a button. |\n| Link | link | Renders the call-to-action component as a text in a link format. |\n\n#### `LinkTargetEnum` possible values\n\nThese values are the same ones supported by HTML5 anchor tags. For more information, please read the [MDN](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a) documentation.\n\n| Enum name | Enum value | Description |\n| -------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Self (default) | \\_self | Opens the link in the current browsing context. |\n| Blank | \\_blank | Opens the link in a new tab, but users can configure browsers to open a new window instead. |\n| Parent | \\_parent | Opens the link in the parent browsing context of the current one. If there is no parent, it behaves as \\_self. |\n| Top | \\_top | Opens the link in the topmost browsing context (the \"highest\" context that is an ancestor of the current one). If there is no ancestor, it behaves as \\_self. |\n\n#### `TextModeEnum` possible values\n\n| Enum name | Enum value | Description |\n| --------- | ---------- | -------------------------------------------------------------------------------------------------------------------- |\n| HTML | html | Uses HTML text for headline and subhead props. |\n| Rich Text | rich-text | Uses markdown text and the [rich-text block](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/rich-text) for headline and subhead props. |\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| infoCardCallActionContainer |\n| infoCardCallActionText |\n| infoCardContainer |\n| infoCardHeadline |\n| infoCardImage |\n| infoCardImageContainer |\n| infoCardImageLinkWrapper |\n| infoCardSubhead |\n| infoCardBodyText |\n| infoCardTextContainer |\n\nSee also\n\n[Vtex.store ComponentsVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-infocard/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/guides/vtex-store-components-infocard/docs/apps/vtex.store-components/InfoCard%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-infocard/docs/apps/vtex.store-components/InfoCard%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-infocard/docs/apps/vtex.store-components/InfoCard%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_50fac653
|
[
{
"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 add coupons to the cart 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/add-coupons-to-the-cart/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/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/add-coupons-to-the-cart/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/add-coupons-to-the-cart/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/add-coupons-to-the-cart/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/add-coupons-to-the-cart/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/add-coupons-to-the-cart/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/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/add-coupons-to-the-cart/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/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/add-coupons-to-the-cart/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/add-coupons-to-the-cart/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/add-coupons-to-the-cart/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/add-coupons-to-the-cart/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/add-coupons-to-the-cart/docs/guides/remove-all-personal-data)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/add-cart-items)\n\n[Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/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/add-coupons-to-the-cart/docs/guides/change-price)\n\n[Ignore profile data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/ignore-profile-data)\n\n[Get cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/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/add-coupons-to-the-cart/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/add-coupons-to-the-cart/docs/guides/add-service-to-the-cart)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/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/add-coupons-to-the-cart/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/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/add-coupons-to-the-cart/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/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/add-coupons-to-the-cart/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/add-coupons-to-the-cart/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/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/add-coupons-to-the-cart/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/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/add-coupons-to-the-cart/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/add-coupons-to-the-cart/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/add-coupons-to-the-cart/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/add-coupons-to-the-cart/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/add-coupons-to-the-cart/docs/guides/remove-all-personal-data)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/add-cart-items)\n\n[Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/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/add-coupons-to-the-cart/docs/guides/change-price)\n\n[Ignore profile data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/ignore-profile-data)\n\n[Get cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/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/add-coupons-to-the-cart/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/add-coupons-to-the-cart/docs/guides/add-service-to-the-cart)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/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/add-coupons-to-the-cart/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/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/add-coupons-to-the-cart/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/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/add-coupons-to-the-cart/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/add-coupons-to-the-cart/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/checkout-api-overview)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Add coupons to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/add-coupons-to-the-cart)\n\nAdd coupons to the cart\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 add coupons to the shopping cart by the API.\n\n> ️ Before adding the coupon code to the cart, call the [Get all coupons](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getall) endpoint to confirm that it is active in your store. If necessary, you can [create a new coupon](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/creating-and-managing-coupons-with-promotions-api).\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 number 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## Adding coupons to the cart\n\nTo add coupons to the shopping cart, you must use the [Add coupons to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/addcoupons) endpoint. In this request, the `ordeFormId` of the shopping cart must be sent through the URL request, as shown by the example below:\n\n`https://{accountname}.{environment.com.br}/api/checkout/pub/orderForm/36a1646105f243e1a9012c9156315644b/coupons`\n\nAdditionally, you need to send the request body containing the coupon code to be applied to the shopping cart:\n\n`1\n\n{ \n\n2\n\n \"text\": \"summersale30\" \n\n3\n\n} \n\n`\n\nAfter sending the request, the endpoint will return the response body containing the coupon information, as shown in the example below:\n\n`1\n\n... \n\n2\n\n\"marketingData\": { \n\n3\n\n \"utmSource\": null, \n\n4\n\n \"utmMedium\": null, \n\n5\n\n \"utmCampaign\": null, \n\n6\n\n \"utmipage\": null, \n\n7\n\n \"utmiPart\": null, \n\n8\n\n \"utmiCampaign\": null, \n\n9\n\n \"coupon\": \"summersale30\", \n\n10\n\n \"marketingTags\": [] \n\n11\n\n } \n\n12\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### 200 - OK\n\nDespite the code `200` (which indicates the success of the request), if the coupon code (`text`) sent is incorrect or unavailable, the following message will be displayed.\n\n* **Message error example (code couponNotFound)**: `\"Cupom free inválido\"` (_Coupon name invalid_).\n\n`1\n\n... \n\n2\n\n\"messages\": [ \n\n3\n\n { \n\n4\n\n \"code\": \"couponNotFound\", \n\n5\n\n \"text\": \"Cupom free inválido\", \n\n6\n\n \"status\": \"warning\", \n\n7\n\n \"fields\": {} \n\n8\n\n }, \n\n9\n\n] \n\n10\n\n... \n\n`\n\n### 400 - Bad Request\n\n* **Message error example (code ORD002)**: `\"Carrinho inválido\"` (_Invalid Cart_). This message indicates that the `orderFormId` used in the request does not exist or is incorrect.\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\": \"Carrinho inválido\", \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### 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/add-coupons-to-the-cart.md)\n\n[Get cart installments information« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart//docs/guides/get-cart-installments-information)[Add a service (offering) to a shopping cartNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart//docs/guides/add-service-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/add-coupons-to-the-cart/docs/guides/add-coupons-to-the-cart%23getting-shopping-cart-information)\n\n[Adding coupons to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/add-coupons-to-the-cart%23adding-coupons-to-the-cart)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/add-coupons-to-the-cart%23error-codes)\n\n[200 - OK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/add-coupons-to-the-cart%23200-ok)[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/add-coupons-to-the-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/add-coupons-to-the-cart%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/add-coupons-to-the-cart.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/add-coupons-to-the-cart/docs/guides/add-coupons-to-the-cart%23getting-shopping-cart-information)\n\n[Adding coupons to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/add-coupons-to-the-cart%23adding-coupons-to-the-cart)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/add-coupons-to-the-cart%23error-codes)\n\n[200 - OK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/add-coupons-to-the-cart%23200-ok)[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/add-coupons-to-the-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-coupons-to-the-cart/docs/guides/add-coupons-to-the-cart%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_f976a8d7
|
[
{
"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 app store 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-app-store/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store/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-app-store/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-app-store/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-app-store/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-app-store/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-app-store/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-app-store/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-app-store/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-app-store/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-app-store/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store/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-app-store/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-app-store/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-app-store/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-app-store/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-app-store/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-app-store/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store/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-app-store/docs/guides/vtex-app-store)\n\n[Becoming a registered VTEX App Store developer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer)\n\n[Developing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store/docs/guides/vtex-io-documentation-developing-an-app)\n\n[Setting your app's billing model](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store/docs/guides/vtex-io-documentation-setting-your-apps-billing-model)\n\n[Preparing your app for distribution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store/docs/guides/vtex-io-documentation-preparing-your-app-distribution)\n\n[Submitting your app to the VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store)\n\n[Using the Docs builder to publish app documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store/docs/guides/using-the-docs-builder-to-publish-app-documentation)\n\n[App Store Guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store/docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store/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-app-store/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-app-store/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store/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-app-store/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-app-store/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-app-store/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-app-store/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store/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-app-store/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-app-store/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-app-store/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-app-store/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-app-store/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-app-store/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store/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-app-store/docs/guides/vtex-app-store)\n\n[Becoming a registered VTEX App Store developer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer)\n\n[Developing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store/docs/guides/vtex-io-documentation-developing-an-app)\n\n[Setting your app's billing model](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store/docs/guides/vtex-io-documentation-setting-your-apps-billing-model)\n\n[Preparing your app for distribution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store/docs/guides/vtex-io-documentation-preparing-your-app-distribution)\n\n[Submitting your app to the VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store)\n\n[Using the Docs builder to publish app documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store/docs/guides/using-the-docs-builder-to-publish-app-documentation)\n\n[App Store Guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store/docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store/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-app-store/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-app-store/docs/app-development)\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store/docs/guides/vtex-app-store)\n\nVTEX App Store\n\nGet to know the VTEX App Store, a marketplace of plug-and-play apps built on VTEX IO, where merchants can discover, install, and purchase solutions developed by VTEX and third-party partners.\n\nThe [VTEX App Store](https://read.calvincode.net/reader?url=https://apps.vtex.com/) is a marketplace for VTEX IO plug-and-play solutions. It is where both first-party and third-party apps are published for download by clients and partners.\n\nDevelopers who want to publish their solutions in the VTEX App Store have to follow a series of procedures, which are detailed in the cards below.\n\n> For an app to be eligible for publication in the App Store, it must be [public](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available) – meaning it should be available for all VTEX accounts to install or purchase. In technical terms, this translates to setting up a [billing model for the app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-your-apps-billing-model%23setting-the-app-as-public).\n\nEvery app in the VTEX App Store must go through the [homologation process](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store%23step-3-waiting-for-the-app-homologation) before publication in the App Store, regardless of the type of functionality (storefront, admin, backend, pixel). In this process, our team assesses whether the app follows our [guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store). The homologation process is required for new apps and new major versions of apps (e.g., when updating an app version from `1.x` to `2.x`).\n\n[Becoming a registered VTEX App Store developerBecome a VTEX App Store developer and share your own solutions with other VTEX users in the VTEX App Store.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer)[Developing an appLearn how to develop an app to the VTEX App Store.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-an-app)[Preparing your app for distributionLearn how to prepare your app for distribution in the VTEX App Store and let merchants benefit from your solution.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-preparing-your-app-distribution)[Setting your app's billing modelLearn how to monetize and define your app audience.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-your-apps-billing-model)[Submitting your app to the VTEX App StoreLearn how to submit your app for distribution with four main steps.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store)\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-app-store.md)\n\n[Promoting a workspace to Master« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store//docs/guides/vtex-io-documentation-promoting-a-workspace-to-master)[Becoming a registered VTEX App Store developerNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store//docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer)\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/App-Guides/vtex-app-store.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_8ee5d151
|
[
{
"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 dynamic content step 1 setting up the store code for dynamic content 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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/dynamic-content-overview)\n\n[Step 1 - Setting up the store code for Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content)\n\n[Step 2 - Handling Dynamic Content in custom sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/dynamic-content-overview)\n\n[Step 1 - Setting up the store code for Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content)\n\n[Step 2 - Handling Dynamic Content in custom sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/headless-cms-overview)\n\n[Customizing pages with Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/dynamic-content-overview)\n\nStep 1 - Setting up the store code for Dynamic Content\n\nNow that you have an overview of the [Dynamic Content feature](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview), let's start the feature implementation by setting up your store code.\n\n## Instructions\n\n## 1\\. Mapping pages and data-fetching functions\n\nCreate a file to map the home and landing Pages to their data-fetching functions. This file maps the home or the landing pages slug to a respective data fetch function, which will fetch, handle, and return the desired server-side data to display the content in a store section. For example, you can add an image from a third-party source in a Hero component.\n\n1. Open your FastStore project in any code editor that you prefer.\n2. In the `src` folder, create the `dynamicContent` folder.\n3. Inside the `dynamicContent` folder, create the `index.ts` file.\n4. Inside `index.ts`, add the following code: \nsrc/dynamicContent/index.ts \n`1 \nconst fetchDataMyLandingPage = async () => { \n2 \n const response = await fetch(\"https://fakestoreapi.com/products\").then( \n3 \n (res) => res.json() \n4 \n ); \n5 \n \n6 \n return { data: response }; \n7 \n}; \n8 \n \n9 \nconst dynamicContent = { \n10 \n \"my-landing-page\": fetchDataMyLandingPage, \n11 \n}; \n12 \n \n13 \nexport default dynamicContent; \n` \n * First, we define the `fetchDataMyLandingPage`, which calls for an external API (`https://fakestoreapi.com/products`) to fetch the product information. \n * The `data` object returns the information. \n * The `dynamicContent` relates the slug that we will define in the [Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-consuming-the-dynamic-content-in-custom-sections).\n\nLet’s dive deep into `dynamicContent` and the pages allowed to be customized with the Dynamic Content feature: home and landing pages:\n\n**`dynamicContent`**\n\nThe `dynamicContent` object stores key-value pairs:\n\n* The key represents the page slug (e.g., `home` for the Home page and `my-landing-page` for a specific Landing page).\n* The value is the corresponding data-fetching function responsible for fetching data for that page. In this example, `fetchDataMyLandingPage`.\n**Home**\n\nThis page is a [singleton](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/managing-singleton-content-types--VBibMN1BqV2OFmavUFCdo?%26utm%5Fsource=autocomplete) page, meaning it is unique in your store. This page is mapped using the key `home` for the Dynamic Content feature. The value of the `home` key is a data-fetching function that returns the necessary data for the Home.\n\n**Landing page**\n\nLanding pages can represent different pages and URLs. To identify the landing page, use the slug from the Headless CMS SEO Path input in the **Settings** tab as the key to the `dynamicContent` object without the initial `/`. In the example below, the value `/my-landing-page`.\n\n\n\nNow that we've established the file for mapping pages to data fetching functions let's define those functions to customize your component using third-party sources.\n\n## 2\\. Creating Dynamic Content via API fetching\n\nAfter [mapping pages and data-fetching functions](#1-mapping-pages-and-data-fetching-functions), you need to define these functions and create the logic to fetch the data from other data sources. There are two ways for fetching data:\n\n* [Using API extensions](#using-api-extensions): Leverage the existing [API Extension](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview) feature to fetch the data.\n* [Using fetch API or any requesting library](#using-fetch-api-or-any-request-library): Request Fetch API or any HTTP library to directly fetch the data ([Axios](https://read.calvincode.net/reader?url=https://axios-http.com/docs/intro), fetch, etc).\n\n### Using API Extensions\n\n1. In the store code, create the folder `graphql` in the' src' folder.\n2. Inside `graphql`, create the folder `thirdParty`. This folder will contain the external data that we want to obtain.\n3. Create two other folders inside the `thirdParty`: `resolvers` and `typeDefs`.\n4. Inside `typeDefs` create the `extra.graphql` file.\n5. Add the following code: \nsrc/graphql/thirdParty/typeDefs/extra.graphql \n`1 \ntype Rating { \n2 \n rate: String \n3 \n count: Int \n4 \n} \n5 \n \n6 \ntype ProductsExtraData { \n7 \n id: Int \n8 \n title: String \n9 \n price: Float \n10 \n description: String \n11 \n category: String \n12 \n image: String \n13 \n rating: Rating \n14 \n} \n15 \n \n16 \ntype ExtraData { \n17 \n \"\"\" \n18 \n Data customizing ExtraData \n19 \n \"\"\" \n20 \n data: [ProductsExtraData] \n21 \n customFieldFromRoot: String \n22 \n customField: String \n23 \n} \n24 \n \n25 \ntype NamedExtraData { \n26 \n \"\"\" \n27 \n Data customizing NamedExtraData \n28 \n \"\"\" \n29 \n data: String! \n30 \n} \n31 \n \n32 \ntype Query { \n33 \n extraData: ExtraData \n34 \n namedExtraData(name: String!): NamedExtraData \n35 \n} \n` \n * The field `ProductsExtraData` represents product data, with fields for id, title, price, description, category, image, and rating. \n * The field `ExtraData` combines a list of `ProductsExtraData` and additional custom fields. \n * The field `Query` defines queries for fetching extraData and namedExtraData. \nNow, create the logic to fill these fields:\n6. Create a file called `query.ts` inside the' resolvers' folder.\n7. Add the following code to it: \nsrc/graphql/thirdParty/resolvers/query.ts \n`` 1 \nexport type ProductsExtraData = { \n2 \n id: number; \n3 \n title: string; \n4 \n price: number; \n5 \n description: string; \n6 \n category: string; \n7 \n image: string; \n8 \n rating: { \n9 \n rate: number; \n10 \n count: number; \n11 \n }; \n12 \n }; \n13 \n \n14 \n async function getProductsFromAPI() { \n15 \n const response = await fetch(\"https://fakestoreapi.com/products\"); \n16 \n return response.json(); \n17 \n } \n18 \n \n19 \n export const Query = { \n20 \n extraData: async (): Promise<{ data: ProductsExtraData[] }> => { \n21 \n const products = await getProductsFromAPI(); \n22 \n return { data: products }; \n23 \n }, \n24 \n namedExtraData: (_: unknown, { name }: { name: string }) => ({ \n25 \n data: `Named extra data: ${name}`, \n26 \n }), \n27 \n }; \n `` \n * `getProductsFromAPI` fetches product data from an external API. \n * `extraData` resolves the `extraData` query by fetching and returning products. \n * `namedExtraData` resolves the `namedExtraData` query by returning a custom message.\n8. Create a file called `extra.ts` inside the' resolvers' folder.\n9. Add the following code to it: \nsrc/graphql/thirdParty/resolvers/extra.ts \n`1 \nimport { ExtraDataRoot } from \"./query\"; \n2 \n \n3 \nexport const ExtraData = { \n4 \n data: (root: ExtraDataRoot) => root.data, \n5 \n customFieldFromRoot: (root: ExtraDataRoot) => root?.data?.[0]?.image ?? \"\", \n6 \n customField: async (_: ExtraDataRoot) => { \n7 \n const res = await fetch( \n8 \n \"https://fakestoreapi.com/products/category/jewelery\" \n9 \n ); \n10 \n const customField = await res.json(); \n11 \n return (customField?.[0]?.title as string) ?? \"\"; \n12 \n }, \n13 \n}; \n` \n * The `Query` function returns the API data in the field `extraData` through a request on an external API.\n10. Inside the `resolvers` folder, create a file called `index.ts` and add the following code: \nsrc/graphql/thirdParty/resolvers/index.ts \n`1 \nimport { ExtraData } from \"./extraData\"; \n2 \nimport { Query } from \"./query\"; \n3 \n \n4 \nconst resolvers = { \n5 \n ExtraData, \n6 \n Query, \n7 \n}; \n8 \n \n9 \nexport default resolvers; \n`\n11. Combine your resolvers and queries into the store's dynamic content in the `index.tsx` file inside the `dynamicContent` folder. \nsrc/dynamicContent/index.tsx \n`` 1 \nimport { gql } from \"@faststore/core/api\"; \n2 \nimport { execute_unstable as execute } from \"@faststore/core/experimental\"; \n3 \n \n4 \nconst query = gql(` \n5 \n query ServerDynamicContent($name: String!){ \n6 \n extraData { \n7 \n data { \n8 \n title \n9 \n rating { \n10 \n rate \n11 \n count \n12 \n } \n13 \n } \n14 \n customField \n15 \n customFieldFromRoot \n16 \n } \n17 \n namedExtraData(name: $name) { \n18 \n data \n19 \n } \n20 \n } \n21 \n`); \n22 \n \n23 \nasync function fetchDataUsingApiExtension() { \n24 \n try { \n25 \n const result = await execute({ \n26 \n variables: { name: \"example-name\" }, \n27 \n operation: query, \n28 \n }); \n29 \n return { data: result.data }; \n30 \n } catch (error) { \n31 \n return { data: null, errors: [\"Error fetching data from API Extensions\"] }; \n32 \n } \n33 \n} \n34 \n \n35 \n// Map slugs to data-fetching functions \n36 \nconst dynamicContent = { \n37 \n \"my-landing-page-api-extensions\": fetchDataUsingApiExtension, \n38 \n}; \n39 \n \n40 \nexport default dynamicContent; \n `` \n * Imports: \n * Import `gql` for defining GraphQL queries. \n * Import execute\\_unstable for running server-side GraphQL queries. \n * `query` Defining the GraphQL Query: \n * Query named `ServerDynamicContent` accepts a `name` parameter. \n * Fetches fields under `extraData` including nested `rating`. \n * Fetches `namedExtraData` based on the name parameter. \n * `fetchDataUsingApiExtension`: \n * It executes to run the GraphQL query with specified variables. \n * Returns the result data or logs and returns an error if it fails. \n * `dynamicContent`: \n * Maps the slug `my-landing-page-api-extensions` to the `fetchDataUsingApiExtension function`. \n * This slug identifies in the code which content we want to bring to the page.\n\nYou can render this data in your store sections once you've set up your dynamic content fetching functions and mappings. See the [Step 2 - Handling Dynamic Content within custom sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections) guide for more information on using this data in a new section.\n\n### Using Fetch API or any request library\n\n#### Single request\n\nYou can use [Fetch API](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/API/Fetch%5FAPI) to directly fetch data from an endpoint.\n\nsrc/dynamicContent/index.ts\n\n`1\n\nasync function fetchDataMyLandingPage() { \n\n2\n\n const response = await fetch(\"https://fakestoreapi.com/products\"); \n\n3\n\n const data = await response.json(); \n\n4\n\n return { data }; \n\n5\n\n} \n\n6\n\n \n7\n\n// Mapping slug to the data-fetching function \n\n8\n\nconst dynamicContent = { \n\n9\n\n \"my-landing-page\": fetchDataMyLandingPage, \n\n10\n\n}; \n\n11\n\n \n12\n\nexport default dynamicContent; \n\n`\n\n* `fetchDataMyLandingPage`: \n * Fetches data from `https://fakestoreapi.com/products`. \n * Returns the fetched data as an object with a data key.\n\n#### Multiple Requests Example\n\nUse `Promise.all` to fetch data from multiple endpoints concurrently.\n\nsrc/dynamicContent/index.ts\n\n`1\n\nasync function fetchDataHomepage() { \n\n2\n\ntry { \n\n3\n\n const [apiData1, apiData2] = await Promise.all([ \n\n4\n\n fetch(\"https://fakestoreapi.com/products/1\").then(res => res.json()), \n\n5\n\n fetch(\"https://fakestoreapi.com/products/2\").then(res => res.json()) \n\n6\n\n ]); \n\n7\n\n \n8\n\n return { \n\n9\n\n data: { \n\n10\n\n product1: apiData1, \n\n11\n\n product2: apiData2, \n\n12\n\n }, \n\n13\n\n }; \n\n14\n\n} catch (error) { \n\n15\n\n return { data: null, error: \"Error fetching data from APIs\" }; \n\n16\n\n } \n\n17\n\n} \n\n18\n\n \n19\n\n// Mapping slugs to their respective data-fetching functions \n\n20\n\nconst dynamicContent = { \n\n21\n\n home: fetchDataHomepage, \n\n22\n\n \"my-landing-page\": fetchDataMyLandingPage, \n\n23\n\n}; \n\n24\n\n \n25\n\nexport default dynamicContent; \n\n`\n\n* `fetchDataHomepage`: \n * Concurrently fetches data from two endpoints. \n * Returns the data from both endpoints in a single data object with separate keys for each product.\n\nOnce you've set up your dynamic content fetching functions and mappings, you can render this data in your store sections. For more information on using this data in a new section, see the [Step 2 - Handling Dynamic Content within custom sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections) guide.\n\n### Returning the data Object\n\nFor both approaches, [data fetching using Fetch API](#using-fetch-api-or-any-request-library) or [Data Fetching using API extensions](#using-api-extensions), the data-fetching function must return an object with data as the root key in the following format:\n\n`1\n\nreturn { \n\n2\n\n data: { \n\n3\n\n // data fetched \n\n4\n\n }, \n\n5\n\n}; \n\n`\n\nThe data object can contain other objects inside:\n\n`1\n\nreturn { \n\n2\n\n data: { \n\n3\n\n key1: result1, \n\n4\n\n key2: result2, \n\n5\n\n }, \n\n6\n\n}; \n\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/headless-cms/dynamic-content/step-1-setting-up-the-store-code-for-dynamic-content.mdx)\n\n[Customizing pages with Dynamic Content« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/dynamic-content-overview)[Step 2 - Handling Dynamic Content in custom sectionsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/dynamic-content-step-2-handling-the-dynamic-content-in-custom-sections)\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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content%23instructions)\n\n[1\\. Mapping pages and data-fetching functions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content%231-mapping-pages-and-data-fetching-functions)\n\n[2\\. Creating Dynamic Content via API fetching](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content%232-creating-dynamic-content-via-api-fetching)\n\n[Using API Extensions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content%23using-api-extensions)[Using Fetch API or any request library](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content%23using-fetch-api-or-any-request-library)[Returning the data Object](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content%23returning-the-data-object)\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/dynamic-content/step-1-setting-up-the-store-code-for-dynamic-content.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/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content%23instructions)\n\n[1\\. Mapping pages and data-fetching functions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content%231-mapping-pages-and-data-fetching-functions)\n\n[2\\. Creating Dynamic Content via API fetching](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content%232-creating-dynamic-content-via-api-fetching)\n\n[Using API Extensions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content%23using-api-extensions)[Using Fetch API or any request library](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content%23using-fetch-api-or-any-request-library)[Returning the data Object](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content/docs/guides/faststore/dynamic-content-step-1-setting-up-the-store-code-for-dynamic-content%23returning-the-data-object)\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_9d14e044
|
[
{
"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 schema queries 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/schema-queries/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/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/schema-queries/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/schema-queries/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/schema-queries/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/schema-queries/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/schema-queries/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/schema-queries/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/schema-queries/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/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/schema-queries/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/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/schema-queries/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/faststore-api-overview)\n\n[Queries](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/schema-queries)\n\n[Mutations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/schema-mutations)\n\n[Objects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/schema-objects)\n\n[Inputs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/schema-inputs)\n\n[Enums](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/schema-enums)\n\n[Scalars](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/schema-scalars)\n\n[Configuring GraphQL cache control for GET requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/faststore-api-configuring-graphql-cache-control)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/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/schema-queries/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/schema-queries/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/schema-queries/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/schema-queries/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/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/schema-queries/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/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/schema-queries/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/schema-queries/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/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/schema-queries/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/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/schema-queries/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/faststore-api-overview)\n\n[Queries](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/schema-queries)\n\n[Mutations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/schema-mutations)\n\n[Objects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/schema-objects)\n\n[Inputs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/schema-inputs)\n\n[Enums](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/schema-enums)\n\n[Scalars](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/schema-scalars)\n\n[Configuring GraphQL cache control for GET requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/faststore-api-configuring-graphql-cache-control)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/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/schema-queries/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/schema-queries/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/schema-queries/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/schema-queries/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/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/schema-queries/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/faststore-api-overview)\n\nQueries\n\nArguments must be provided by the user.\n\nArguments preceded by an exclamation mark (`!`) are not nullable.\n\n## Product\n\n| Field | Argument | Type | Description |\n| --------------- | ------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------- | ----------- |\n| **product** | [StoreProduct](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storeproduct)! | Returns the details of a product based on the specified locator. | |\n| locator | \\[[IStoreSelectedFacet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs%23istoreselectedfacet)!\\]! | An array of selected search facets. | |\n| **allProducts** | [StoreProductConnection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storeproductconnection)! | Returns information about all products. | |\n| first | [Int](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23int)! | Product pagination argument, indicating how many items should be returned from the complete result list. | |\n| after | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | Product pagination argument, indicating the cursor corresponding with the item after which the items should be fetched. | |\n\n## Collection\n\n| Field | Argument | Type | Description |\n| ------------------ | ------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| **collection** | [StoreCollection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storecollection)! | Returns the details of a collection based on the collection slug. | |\n| slug | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Collection slug. | |\n| **allCollections** | [StoreCollectionConnection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storecollectionconnection)! | Returns information about all collections. | |\n| first | [Int](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23int)! | Collection pagination argument, indicating how many items should be returned from the complete result list. | |\n| after | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | Collection pagination argument, indicating the cursor corresponding with the item after which the items should be fetched. | |\n\n## Search\n\n| Field | Argument | Type | Description |\n| -------------- | --------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | ----------- |\n| **search** | [StoreSearchResult](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storesearchresult)! | Returns the result of a product, facet, or suggestion search. | |\n| first | [Int](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23int)! | Search pagination argument, indicating how many results should be returned from the complete result list. | |\n| after | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | Search pagination argument, indicating the cursor corresponding with the item after which the results should be fetched. | |\n| sort | [StoreSort](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-enums%23storesort) | Search results sorting mode. | |\n| term | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | Search term. | |\n| selectedFacets | \\[[IStoreSelectedFacet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs%23istoreselectedfacet)!\\] | Array of selected search facets. | |\n| **redirect** | [StoreRedirect](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storeredirect) | Returns if there's a redirect for a search. | |\n| term | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | Search term. | |\n| selectedFacets | \\[[IStoreSelectedFacet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs%23istoreselectedfacet)!\\] | Array of selected search facets. | |\n\n## Shipping\n\n| Field | Argument | Type | Description |\n| ------------ | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------- | ----------- |\n| **shipping** | [ShippingData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23shippingdata) | Returns information about shipping simulation. | |\n| items | \\[[IShippingItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs%23ishippingitem)!\\]! | Shipping Simulation item input. | |\n| postalCode | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Postal code to freight calculator. | |\n| country | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Country of postal code. | |\n\n## Sellers\n\n| Field | Argument | Type | Description |\n| -------------- | -------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ----------- |\n| **sellers** | [SellersData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23sellersdata) | Returns a list of sellers available for a specific localization. | |\n| postalCode | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | Postal code input to calculate sellers. | |\n| geoCoordinates | [IGeoCoordinates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs%23igeocoordinates) | Geocoordinates input to calculate sellers. | |\n| country | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)! | Country of localization. | |\n| salesChannel | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string) | Sales channel of the navigation. | |\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\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/faststore/docs/faststore-api/schema/queries.mdx)\n\n[FastStore API« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/faststore-api-overview)[MutationsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/schema-mutations)\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/schema-queries%23product)\n\n[Collection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/schema-queries%23collection)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/schema-queries%23search)\n\n[Shipping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/schema-queries%23shipping)\n\n[Sellers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/schema-queries%23sellers)\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/faststore-api/schema/queries.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/schema-queries%23product)\n\n[Collection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/schema-queries%23collection)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/schema-queries%23search)\n\n[Shipping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/schema-queries%23shipping)\n\n[Sellers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries/docs/guides/faststore/schema-queries%23sellers)\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_5b29449f
|
[
{
"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 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/getting-started-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/getting-started-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/getting-started-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/getting-started-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/getting-started-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/getting-started-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/getting-started-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/getting-started-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/getting-started-overview/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-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/getting-started-overview/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-overview/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-overview/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-overview/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-overview/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-overview/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)\n\n[6\\. Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-overview/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-overview/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-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-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/getting-started-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-overview/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-overview/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-overview/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-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/getting-started-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/getting-started-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/getting-started-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/getting-started-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-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/getting-started-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/getting-started-overview/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-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-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/getting-started-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/getting-started-overview/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-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/getting-started-overview/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-overview/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-overview/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-overview/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-overview/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-overview/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)\n\n[6\\. Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-overview/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-overview/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-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-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/getting-started-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-overview/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-overview/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-overview/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-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/getting-started-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/getting-started-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/getting-started-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/getting-started-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-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/getting-started-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/getting-started-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/getting-started-overview/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-overview/docs/guides/faststore)\n\nGetting started\n\nBuild and deploy your first FastStore storefront from scratch.\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore) is a headless commerce storefront framework built on [Next.js](https://read.calvincode.net/reader?url=https://nextjs.org/). It enables you to build high-performance, customizable ecommerce websites.\n\n## What you'll build in this track\n\nThis track guides you through building your first FastStore storefront from scratch. By the end of this track, you’ll have a production-ready storefront deployed at `https://{accountName}.vtex.app/`, fully integrated with the Headless CMS for content management.\n\nBelow is an overview of the modules covered in this track:\n\n[1\\. Setting up your environmentPrepare your development environment and VTEX account with all required tools, apps, and configurations before starting your FastStore project.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-1-setting-up-your-environment)[2\\. Starting a new FastStore projectUse the WebOps app onboarding flow to create your FastStore project. It automatically sets up a GitHub repository and provides a live preview of your site.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project)[3\\. Running the project locallyRun your FastStore project in a local development environment to preview changes in real time.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally)[4\\. Understanding the project structureLearn how the FastStore project is organized, including its main directories, configurations, and code architecture.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure)[5\\. Integrating your project with the Headless CMSConnect your FastStore project with the Headless CMS to manage and publish your store’s content efficiently.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-with-the-headless-cms)[6\\. Next stepsDiscover additional resources and best practices to optimize your store’s performance and user experience.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-6-next-steps)\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\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/faststore/docs/getting-started/overview.mdx)\n\n[FastStore versions and support levels« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-overview/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)[1\\. Setting up your environmentNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-overview/docs/guides/faststore/getting-started-1-setting-up-your-environment)\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[What you'll build in this track](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-overview/docs/guides/faststore/getting-started-overview%23what-youll-build-in-this-track)\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/overview.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[What you'll build in this track](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-overview/docs/guides/faststore/getting-started-overview%23what-youll-build-in-this-track)\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_552f250a
|
[
{
"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 search products 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-search-products/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-search-products/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-search-products/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-search-products/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-search-products/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-search-products/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-search-products/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-search-products/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-search-products/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/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-search-products/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/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-search-products/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/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-search-products/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-search-products/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-search-products/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-search-products/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/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-search-products/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-search-products/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/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-search-products/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-search-products/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/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-search-products/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/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-search-products/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/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-search-products/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-search-products/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-search-products/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-search-products/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/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-search-products/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-search-products/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-search-products/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/components-index)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-overview)\n\nSearchProducts\n\nList of `SearchProductItem` to show details of the suggested products.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/SearchProducts)\n\nList of `SearchProductItem` to show details of the suggested products. This component is part of the [Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search) feature.\n\nExample\n\nCode\n\nSuggested Products\n\n1. [Apple Magic MouseOriginal price:$999Price:$950.04](#)\n2. [Apple Magic MouseOriginal price:$999Price:$950.04](#)\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { \n\n2\n\n SearchProducts, \n\n3\n\n SearchProductItem, \n\n4\n\n SearchProductItemImage, \n\n5\n\n SearchProductItemContent, \n\n6\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/molecules/SearchProducts/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-search-products-padding-top | var(--fs-spacing-2) |\n| \\--fs-search-products-padding-right | var(--fs-spacing-3) |\n| \\--fs-search-products-padding-bottom | var(--fs-search-products-padding-top) |\n| \\--fs-search-products-padding-left | var(--fs-search-products-padding-right) |\n| \\--fs-search-products-transition-property | var(--fs-transition-property) |\n| \\--fs-search-products-transition-function | var(--fs-transition-function) |\n| \\--fs-search-products-transition-timing | var(--fs-transition-timing) |\n\n### Header\n\n| Local token | Default value/Global token linked |\n| ------------------------------------------- | -------------------------------------------- |\n| \\--fs-search-products-header-padding-top | var(--fs-spacing-1) |\n| \\--fs-search-products-header-padding-bottom | var(--fs-search-products-header-padding-top) |\n\n### Title\n\n| Local token | Default value/Global token linked |\n| --------------------------------------- | --------------------------------- |\n| \\--fs-search-products-title-size | var(--fs-text-size-lead) |\n| \\--fs-search-products-title-line-height | 1.5 |\n\n### Item\n\n| Local token | Default value/Global token linked |\n| ----------------------------------------- | ----------------------------------------- |\n| \\--fs-search-product-item-padding-top | var(--fs-spacing-1) |\n| \\--fs-search-product-item-padding-right | var(--fs-search-product-item-padding-top) |\n| \\--fs-search-product-item-bkg-color-hover | var(--fs-color-tertiary-bkg-hover) |\n\n### Item control\n\n| Local token | Default value/Global token linked |\n| --------------------------------------------- | --------------------------------- |\n| \\--fs-search-product-item-control-actions-gap | var(--fs-spacing-1) |\n| \\--fs-search-product-item-control-input-width | 4.625rem |\n\n### Item image\n\n| Local token | Default value/Global token linked |\n| --------------------------------------------- | --------------------------------- |\n| \\--fs-search-product-item-image-border-radius | var(--fs-border-radius) |\n| \\--fs-search-product-item-image-margin-right | var(--fs-spacing-3) |\n| \\--fs-search-product-item-image-size | 3.5rem |\n\n### Item title\n\n| Local token | Default value/Global token linked |\n| --------------------------------------------- | --------------------------------- |\n| \\--fs-search-product-item-title-margin-bottom | var(--fs-spacing-0) |\n| \\--fs-search-product-item-title-size | var(--fs-text-size-2) |\n| \\--fs-search-product-item-title-line-height | 1.2 |\n| \\--fs-search-product-item-title-color | var(--fs-color-text) |\n\n### Item price\n\n| Local token | Default value/Global token linked |\n| ------------------------------------ | --------------------------------- |\n| \\--fs-search-product-item-price-gap | var(--fs-spacing-1) |\n| \\--fs-search-product-item-price-size | var(--fs-text-size-base) |\n\n---\n\n## Data attributes\n\nYou can target and override `SearchProducts` styles using the following data attributes:\n\n`data-fs-search-products`\n\n`data-fs-search-products-header`\n\n`data-fs-search-products-title`\n\n`data-fs-search-product-item`\n\n`data-fs-search-product-item-link`\n\n`data-fs-search-product-item-image`\n\n`data-fs-search-product-item-content`\n\n---\n\n## Props\n\nAll search product related components support all attributes also supported by their respective HTML tags. Besides those attributes, the following props are also supported:\n\n### SearchProducts\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-search-products |\n| **title** | string | Title attribute for the <section> tag rendered by this component. | Suggested Products |\n\n### SearchProductItem\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-search-product-item |\n| **linkProps** | Partial<LinkProps<LinkElementType>> | Props for the link from SearchProduct component. | |\n\n### SearchProductItemImage\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-search-product-item-image |\n\n### SearchProductItemContent\n\n| Name | Type | Description | Default |\n| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | ------- |\n| **title\\*** | string | Specifies the product's title. | |\n| **price\\*** | PriceDefinition | Specifies product's prices. | |\n| **quickOrder** | { enabled: boolean; outOfStockLabel: string; availability: boolean; hasVariants: boolean; skuMatrixControl: React.ReactNode; quantity: number; min?: number; max?: number; onChangeQuantity(value: number): void; buyProps?: { ...; }; } | Quick order settings. | |\n| **onValidateBlur** | (min: number, maxValue: number, quantity: number) => void | Event emitted when value is out of the min and max bounds | |\n\n### Other Resources\n\n#### PriceDefinition\n\n| Name | Type | Description | Default |\n| ------------- | -------------- | --------------------------------------------------- | ------- |\n| **value** | number | The raw price value. | |\n| **listPrice** | number | Product's list price | |\n| **formatter** | PriceFormatter | (price: number, variant: PriceVariant) => ReactNode | |\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/molecules/search-products.mdx)\n\n[SearchInputField« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-input-field)[SearchTopNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-top)\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/molecules-search-products/docs/guides/faststore/molecules-search-products%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23design-tokens)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23header)[Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23title)[Item](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23item)[Item control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23item-control)[Item image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23item-image)[Item title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23item-title)[Item price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23item-price)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23props)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23searchproducts)[SearchProductItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23searchproductitem)[SearchProductItemImage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23searchproductitemimage)[SearchProductItemContent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23searchproductitemcontent)[Other Resources](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23other-resources)\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/search-products.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-search-products/docs/guides/faststore/molecules-search-products%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23design-tokens)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23header)[Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23title)[Item](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23item)[Item control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23item-control)[Item image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23item-image)[Item title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23item-title)[Item price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23item-price)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23props)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23searchproducts)[SearchProductItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23searchproductitem)[SearchProductItemImage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23searchproductitemimage)[SearchProductItemContent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23searchproductitemcontent)[Other Resources](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-products/docs/guides/faststore/molecules-search-products%23other-resources)\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_59aa86d2
|
[
{
"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 radio 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-radio/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-radio/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-radio/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-radio/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-radio/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-radio/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-radio/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-radio/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-radio/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/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-radio/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/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-radio/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-overview)\n\n[Badge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-badge)\n\n[Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-button)\n\n[Checkbox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-checkbox)\n\n[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-icon)\n\n[Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-input)\n\n[Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-label)\n\n[Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-link)\n\n[List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-list)\n\n[Loader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-loader)\n\n[Overlay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-overlay)\n\n[Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-price)\n\n[Radio](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-radio)\n\n[Select](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-select)\n\n[SROnly](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-sr-only)\n\n[Skeleton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-skeleton)\n\n[Slider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-slider)\n\n[Textarea](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-textarea)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/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-radio/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-radio/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-radio/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-radio/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/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-radio/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-radio/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/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-radio/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-radio/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/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-radio/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/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-radio/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-overview)\n\n[Badge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-badge)\n\n[Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-button)\n\n[Checkbox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-checkbox)\n\n[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-icon)\n\n[Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-input)\n\n[Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-label)\n\n[Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-link)\n\n[List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-list)\n\n[Loader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-loader)\n\n[Overlay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-overlay)\n\n[Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-price)\n\n[Radio](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-radio)\n\n[Select](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-select)\n\n[SROnly](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-sr-only)\n\n[Skeleton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-skeleton)\n\n[Slider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-slider)\n\n[Textarea](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-textarea)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/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-radio/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-radio/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-radio/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-radio/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/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-radio/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-radio/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-radio/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-overview)\n\nRadio\n\nRadios allow users to select one option from a set.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/atoms/Radio)\n\nThe `Radio` component allows users to select a single option from a set of mutually exclusive choices. Typical use cases include:\n\n* Selecting a shipping method (e.g., `Standard`, `Express`, or `Next-day delivery`).\n* Choosing payment options (e.g., `Credit card`, `PayPal`, or `Bank transfer`).\n* Selecting product variants or configurations (e.g., size or subscription frequency).\n\nExample\n\nCode\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { Radio } 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/Radio/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### Variants\n\n#### Checked\n\nExample\n\nCode\n\n#### Disabled\n\nExample\n\nCode\n\n#### Checked and Disabled\n\nExample\n\nCode\n\n---\n\n## Design tokens\n\n| Local token | Default value/Global token linked |\n| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| \\--fs-radio-width | 1.25rem |\n| \\--fs-radio-height | var(--fs-radio-width) |\n| \\--fs-radio-border-width | var(--fs-border-width) |\n| \\--fs-radio-border-radius | var(--fs-border-radius-circle) |\n| \\--fs-radio-border-color | var(--fs-border-color) |\n| \\--fs-radio-border-color-hover | var(--fs-border-color-hover) |\n| \\--fs-radio-transition | border var(--fs-transition-timing) var(--fs-transition-function), background-color var(--fs-transition-timing) var(--fs-transition-function), box-shadow var(--fs-transition-timing) var(--fs-transition-function) |\n| \\--fs-radio-bkg-color-hover | var(--fs-color-primary-bkg-light) |\n| \\--fs-radio-shadow-hover | 0 0 0 var(--fs-radio-border-width) var(--fs-border-color-active) |\n\n### Design tokens: Knob\n\nThe knob is the inner circle that appears when the radio is checked, providing visual feedback for the selected state.\n\n| Local token | Default value/Global token linked |\n| ----------------------------------- | --------------------------------- |\n| \\--fs-radio-knob-width | var(--fs-spacing-1) |\n| \\--fs-radio-knob-height | var(--fs-radio-knob-width) |\n| \\--fs-radio-knob-bkg-color | var(--fs-color-body-bkg) |\n| \\--fs-radio-knob-disabled-bkg-color | var(--fs-color-neutral-5) |\n\n### Design tokens: Checked\n\nChecked radio buttons use a distinct background color to indicate the selected option, ensuring users can easily identify their choice.\n\n| Local token | Default value/Global token linked |\n| ----------------------------------- | --------------------------------- |\n| \\--fs-radio-checked-bkg-color | var(--fs-color-primary-bkg) |\n| \\--fs-radio-checked-bkg-color-hover | var(--fs-color-primary-bkg-hover) |\n\n### Design tokens: Disabled\n\nDisabled radio buttons use muted colors and reduced contrast to visually communicate that the option is unavailable for interaction.\n\n| Local token | Default value/Global token linked |\n| --------------------------------- | --------------------------------- |\n| \\--fs-radio-disabled-bkg-color | var(--fs-color-disabled-bkg) |\n| \\--fs-radio-disabled-border-width | var(--fs-radio-border-width) |\n| \\--fs-radio-disabled-border-color | var(--fs-border-color-disabled) |\n| \\--fs-radio-disabled-text-color | var(--fs-color-disabled-text) |\n\n---\n\n## Data attributes\n\nYou can target and override `Radio` styles using the following data attributes:\n\n`data-fs-radio`\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-radio |\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) when using radio input. Descriptive labels help users understand the purpose of a form control.\n\n---\n\n## Related components\n\n* RadioField \nRadioField \nRadioField wraps a Radio input and its corresponding Label. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/molecules-radio-field)\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/atoms/radio.mdx)\n\n[Price« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-price)[SelectNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-select)\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/atoms-radio/docs/guides/faststore/atoms-radio%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-radio%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-radio%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-radio%23examples)\n\n[Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-radio%23variants)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-radio%23design-tokens)\n\n[Design tokens: Knob](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-radio%23design-tokens-knob)[Design tokens: Checked](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-radio%23design-tokens-checked)[Design tokens: Disabled](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-radio%23design-tokens-disabled)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-radio%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-radio%23props)\n\n[Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-radio%23best-practices)\n\n[✅ Do's](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-radio%23-dos)\n\n[Related components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-radio%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/radio.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-radio/docs/guides/faststore/atoms-radio%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-radio%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-radio%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-radio%23examples)\n\n[Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-radio%23variants)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-radio%23design-tokens)\n\n[Design tokens: Knob](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-radio%23design-tokens-knob)[Design tokens: Checked](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-radio%23design-tokens-checked)[Design tokens: Disabled](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-radio%23design-tokens-disabled)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-radio%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-radio%23props)\n\n[Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-radio%23best-practices)\n\n[✅ Do's](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-radio%23-dos)\n\n[Related components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-radio/docs/guides/faststore/atoms-radio%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=)"
}
] |
doc_c4403079
|
[
{
"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 seo configuring seo for plp and pdp 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/seo-configuring-seo-for-plp-and-pdp/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/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/seo-configuring-seo-for-plp-and-pdp/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/seo-configuring-seo-for-plp-and-pdp/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/seo-configuring-seo-for-plp-and-pdp/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/seo-configuring-seo-for-plp-and-pdp/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/seo-configuring-seo-for-plp-and-pdp/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/seo-configuring-seo-for-plp-and-pdp/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/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/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/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/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/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/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/seo-configuring-seo-for-plp-and-pdp/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/seo-configuring-seo-for-plp-and-pdp/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/seo-configuring-seo-for-plp-and-pdp/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/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/seo-overview)\n\n[Configuring SEO for PLPs and PDPs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp)\n\n[Optimizing SEO by managing lazy loading on PLPs and PDPs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp)\n\n[Validating UTM tracking in FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/seo-validating-utm-tracking-in-faststore)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/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/seo-configuring-seo-for-plp-and-pdp/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/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/seo-configuring-seo-for-plp-and-pdp/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/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/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/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/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/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/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/seo-configuring-seo-for-plp-and-pdp/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/seo-configuring-seo-for-plp-and-pdp/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/seo-configuring-seo-for-plp-and-pdp/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/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/seo-overview)\n\n[Configuring SEO for PLPs and PDPs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp)\n\n[Optimizing SEO by managing lazy loading on PLPs and PDPs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp)\n\n[Validating UTM tracking in FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/seo-validating-utm-tracking-in-faststore)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/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/seo-configuring-seo-for-plp-and-pdp/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/seo-overview)\n\nConfiguring SEO for PLPs and PDPs\n\nConfiguring SEO settings for Product Listing Pages (PLPs) and Product Details Pages (PDPs) is essential for improving search engine visibility and discoverability. This guide walks you through setting up title and description templates for PLPs and PDPs and provides best practices for optimizing SEO performance.\n\n## SEO metadata\n\nFastStore follows a structured approach to generating SEO metadata for PLPs and PDPs, prioritizing available catalog data before falling back to predefined templates in the [discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options) file.\n\nTitle\n\nYes\n\nNo\n\nYes\n\nNo\n\nChecks the Catalog for PLP's and PDP's title\n\nIs there a title in the Catalog?\n\nUses the title from the Catalog\n\nChecks the Catalog for PLP's and PDP's name\n\nIs there a name in the Catalog?\n\nUses the name from the Catalog\n\nChecks 'discovery.config.js' file\n\nUses general SEO title\n\nDisplays Title\n\nTitle template\n\nYes\n\nNo\n\nChecks for a template configured in 'discovery.config.js' in the 'seo' section\n\nIs there a title template?\n\nDisplays Title using the template\n\nUses the generic title template from the 'seo' object in 'discovery.config.js'.\n\nDescription template\n\nYes\n\nNo\n\nYes\n\nNo\n\nChecks the Catalog for the PLP's and PDP's description\n\nIs there a description in the Catalog?\n\nUses the description from the Catalog\n\nChecks the PLP and PDP description template in the 'plp' and 'pdp' property of 'discovery.config.js'\n\nIs there a PLP and PDP description template?\n\nUses the PLP and PDP description template using the PLP and PDP title in it\n\nUses the generic description template in the 'seo' object of 'discovery.config.js'\n\nDisplays Description\n\n## Instructions\n\n1. Open your FastStore project in a code editor of your preference.\n2. Go to the `discovery.config.js` file and in the `seo` section add the following:\n\n`1\n\n... \n\n2\n\nseo: { \n\n3\n\n ... \n\n4\n\n plp: { \n\n5\n\n titleTemplate: '%s | FastStore PLP', \n\n6\n\n descriptionTemplate: '%s products on FastStore Product Listing Page', \n\n7\n\n }, \n\n8\n\n pdp: { \n\n9\n\n titleTemplate: '%s | FastStore PDP', \n\n10\n\n descriptionTemplate: '%s products on FastStore Product Detail Page', \n\n11\n\n }, \n\n12\n\n}, \n\n`\n\n> Change the values in `titleTemplate` and `descriptionTemplate` according to your needs. Use `%s` as a placeholder for the PLP and PDP title/name.\n\n* **Title template:** This template will be applied to all PLPs and PDPs, including collections, categories, subcategories, and brands.\n* **Description template:** This template is used for `collections`, as descriptions for `collections` are not configured in the Catalog. If a specific description isn't configured in the Catalog for a category, subcategory, or brand, this template will be used as a fallback.\n\n## Lazy loading and SEO considerations\n\nFastStore uses lazy loading to improve performance. However, certain [custom sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section), such as those containing H1 headers, may need to appear in the initial HTML for SEO purposes, as search engine crawlers may not index dynamically loaded content. To optimize SEO for PLPs and PDPs, see the [Optimizing SEO by managing Lazy Loading on PLPs and PDPs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp) guide.\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/seo/configuring-seo-for-plp-and-pdp.mdx)\n\n[SEO« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/seo-overview)[Optimizing SEO by managing lazy loading on PLPs and PDPsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[SEO metadata](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp%23seo-metadata)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp%23instructions)\n\n[Lazy loading and SEO considerations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp%23lazy-loading-and-seo-considerations)\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/seo/configuring-seo-for-plp-and-pdp.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[SEO metadata](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp%23seo-metadata)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp%23instructions)\n\n[Lazy loading and SEO considerations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp%23lazy-loading-and-seo-considerations)\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_ad64f382
|
[
{
"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 accessibe 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.accessibe/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/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/apps/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/apps/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/apps/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/apps/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/apps/vtex.accessibe/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.accessibe/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.accessibe/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.accessibe/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.accessibe/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.accessibe/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.accessibe/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.accessibe/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.accessibe/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.accessibe/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.accessibe/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.accessibe/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.accessibe/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.accessibe/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.accessibe/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.accessibe/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.accessibe/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.accessibe/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.accessibe/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.accessibe/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.accessibe/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.accessibe/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.accessibe/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.accessibe/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.accessibe/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.accessibe/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.accessibe/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.accessibe/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.accessibe/docs/vtex-io-apps)\n\naccessiBe\n\nOfficial extension\n\nVersion: 1.0.9\n\nLatest version: 1.0.9\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\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[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.accessibe/docs/apps/vtex.accessibe%23installation)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.accessibe/docs/apps/vtex.accessibe%23configuration)\n\n[Deletion and uninstall](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.accessibe/docs/apps/vtex.accessibe%23deletion-and-uninstall)\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_79e65fa7
|
[
{
"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 orders 2 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/orders-2/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/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/orders-2/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/orders-2/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/orders-2/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/orders-2/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/orders-2/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/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/orders-2/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/orders-2)\n\n[Creating a regular order with the Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/creating-a-regular-order-with-the-checkout-api)\n\n[Creating a regular order from an existing cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/creating-a-regular-order-from-an-existing-cart)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/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/orders-2/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/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/orders-2/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/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/orders-2/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/orders-2/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/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/orders-2/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/orders-2)\n\n[Creating a regular order with the Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/creating-a-regular-order-with-the-checkout-api)\n\n[Creating a regular order from an existing cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/creating-a-regular-order-from-an-existing-cart)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/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/orders-2/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/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/orders-2/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/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/orders-2/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/orders-2/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/checkout-api-overview)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2/docs/guides/orders-2)\n\nOrder Placement\n\nThis section contains articles about creating orders on Checkout. Here you will find the following articles:\n\n* [Creating a regular order with the Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api)\n* [Creating a regular order from an existing cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-from-an-existing-cart)\n\nContributors\n\n2\n\n[](https://github.com/ricardoaerobr)\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/orders-2.md)\n\n[Configure the Global Checkout« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2//docs/guides/configure-the-global-checkout)[Creating a regular order with the Checkout APINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-2//docs/guides/creating-a-regular-order-with-the-checkout-api)\n\nContributors\n\n2\n\n[](https://github.com/ricardoaerobr)\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/Checkout/orders-2.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_304d7af6
|
[
{
"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 price range 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-price-range/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-price-range/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-price-range/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-price-range/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-price-range/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-price-range/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-price-range/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-price-range/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-price-range/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/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-price-range/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/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-price-range/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-overview)\n\n[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-banner-text)\n\n[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-cart-sidebar)\n\n[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-empty-state)\n\n[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-filter-slider)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-filter)\n\n[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-hero)\n\n[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-image-gallery)\n\n[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-navbar-slider)\n\n[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-navbar)\n\n[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-newsletter)\n\n[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-out-of-stock)\n\n[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-payment-methods)\n\n[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-price-range)\n\n[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-product-grid)\n\n[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-product-shelf)\n\n[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-region-modal)\n\n[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-search-input)\n\n[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-shipping-simulation)\n\n[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/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-price-range/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/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-price-range/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-price-range/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-price-range/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-price-range/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/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-price-range/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-price-range/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/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-price-range/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-price-range/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/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-price-range/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/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-price-range/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-overview)\n\n[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-banner-text)\n\n[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-cart-sidebar)\n\n[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-empty-state)\n\n[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-filter-slider)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-filter)\n\n[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-hero)\n\n[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-image-gallery)\n\n[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-navbar-slider)\n\n[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-navbar)\n\n[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-newsletter)\n\n[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-out-of-stock)\n\n[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-payment-methods)\n\n[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-price-range)\n\n[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-product-grid)\n\n[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-product-shelf)\n\n[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-region-modal)\n\n[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-search-input)\n\n[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-shipping-simulation)\n\n[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/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-price-range/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/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-price-range/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-price-range/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-price-range/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-price-range/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/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-price-range/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-price-range/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-price-range/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/components-index)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-overview)\n\nPriceRange\n\nSliders that allows users to select a maximum and minimum price.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/organisms/PriceRange)\n\nThe `PriceRange` component is a [Slider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider) that allows users to select a maximum and minimum price from a range.\n\nExample\n\nCode\n\n$0$500\n\n$100$250\n\nMin\n\nMax\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { PriceRange } 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/PriceRange/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 `PriceRange` styles using the following data attributes:\n\n`data-fs-price-range`\n\n`data-fs-price-range-inputs`\n\n---\n\n## Props\n\n| Name | Type | Description | Default | | |\n| -------------------------- | ------------------------------------------------- | --------------------------------------------------------------------------------------- | -------------- | ------------- | ---------------------------------------- |\n| **variant** | \"selling\" \\| \"listing\" | \"spot\" | \"savings\" | \"installment\" | The current use case variant for prices. |\n| **formatter\\*** | PriceFormatter | Formatter function that transforms the raw price value and render the result. | | | |\n| **aria-label** | string | Defines a string value that labels the current element. | | | |\n| **onChange** | (value: { min: number; max: number; }) => void | Callback that fires when the slider value changes. | | | |\n| **testId** | string | ID to find this component in testing tools (e.g.: cypress, testing library, and jest). | fs-price-range | | |\n| **min\\*** | Range | The minimum value of the slider. | | | |\n| **max\\*** | Range | The maximum value of the slider. | | | |\n| **step** | number | Specifies the number interval to be used in the inputs. | 1 | | |\n| **onEnd** | (value: { min: number; max: number; }) => void | Callback that fires when the slider value ends changing. | | | |\n| **getAriaValueText** | (value: number, thumb?: \"min\" \\| \"max\") => string | A function used to set a human-readable value text based on the slider's current value. | | | |\n| **minValueLabelComponent** | (minValue: number) => ReactNode | Component that renders min value label above the left thumb. | | | |\n| **maxValueLabelComponent** | (maxValue: number) => ReactNode | Component that renders max value label above the right thumb. | | | |\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/price-range.mdx)\n\n[PaymentMethods« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-payment-methods)[ProductGridNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-product-grid)\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-price-range/docs/guides/faststore/organisms-price-range%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-price-range%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-price-range%23import-styles)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-price-range%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-price-range%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/price-range.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-price-range/docs/guides/faststore/organisms-price-range%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-price-range%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-price-range%23import-styles)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-price-range%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-price-range/docs/guides/faststore/organisms-price-range%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_1f75e0ec
|
[
{
"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 segmenting the search result 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-segmenting-the-search-result/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-segmenting-the-search-result/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-segmenting-the-search-result/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-segmenting-the-search-result/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-segmenting-the-search-result/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-segmenting-the-search-result/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-segmenting-the-search-result/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-segmenting-the-search-result/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-segmenting-the-search-result/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-segmenting-the-search-result/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-io-documentation-segmenting-the-search-result/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-segmenting-the-search-result/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-segmenting-the-search-result/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/vtex-io-documentation-segmenting-the-search-result/docs/guides/how-search-parameters-work)\n\n[Search Control – fulltextSearchBox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-segmenting-the-search-result/docs/guides/search-control-fulltextsearchbox)\n\n[Consult store search terms information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-segmenting-the-search-result/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/vtex-io-documentation-segmenting-the-search-result/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/vtex-io-documentation-segmenting-the-search-result/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/vtex-io-documentation-segmenting-the-search-result/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/vtex-io-documentation-segmenting-the-search-result/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/vtex-io-documentation-segmenting-the-search-result/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/vtex-io-documentation-segmenting-the-search-result/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/vtex-io-documentation-segmenting-the-search-result/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-segmenting-the-search-result/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-io-documentation-segmenting-the-search-result/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-io-documentation-segmenting-the-search-result/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-segmenting-the-search-result/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-segmenting-the-search-result/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-segmenting-the-search-result/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-segmenting-the-search-result/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-segmenting-the-search-result/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-segmenting-the-search-result/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-segmenting-the-search-result/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-segmenting-the-search-result/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-segmenting-the-search-result/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-io-documentation-segmenting-the-search-result/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-segmenting-the-search-result/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-segmenting-the-search-result/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/vtex-io-documentation-segmenting-the-search-result/docs/guides/how-search-parameters-work)\n\n[Search Control – fulltextSearchBox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-segmenting-the-search-result/docs/guides/search-control-fulltextsearchbox)\n\n[Consult store search terms information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-segmenting-the-search-result/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/vtex-io-documentation-segmenting-the-search-result/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/vtex-io-documentation-segmenting-the-search-result/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/vtex-io-documentation-segmenting-the-search-result/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/vtex-io-documentation-segmenting-the-search-result/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/vtex-io-documentation-segmenting-the-search-result/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/vtex-io-documentation-segmenting-the-search-result/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/vtex-io-documentation-segmenting-the-search-result/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-segmenting-the-search-result/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-io-documentation-segmenting-the-search-result/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-io-documentation-segmenting-the-search-result/docs/guides)\n\nSearch\n\n[Segmenting the search result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-segmenting-the-search-result/docs/guides/vtex-io-documentation-segmenting-the-search-result)\n\nSegmenting the search result\n\nIn some situations, such as B2B accounts, you may want to present custom search results for each of your customers. To this end, this tutorial will guide you on how to segment the search result page of your store.\n\nTake the following example in which different results for the same search are obtained based on the customer's email.\n\n\n\n> This app only works on your store's final domain when the customer is logged in. If the customer navigates without authentication, the filter will not be inserted into their session. Note that, in the `myvtex` environment, the app always functions because authentication is enforced at all times.\n\n> If you are using the [B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-suite) solution, the configuration described in this guide is not necessary, because the [B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations) app allows product collections to be assigned to organizations.\n\n## Instructions\n\nTo create segmented search results, we'll create a new VTEX IO app from the [vtex.search-segment-resolver](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/search-segment-resolver) boilerplate and customize it to establish our own segmentation rules.\n\n1. Clone the `vtex.search-segment-resolver` app into your machine: \n`1 \ngit clone https://github.com/vtex-apps/search-segment-resolver \n`\n2. Open the `search-segment-resolver` project in any code editor of your preference.\n3. Go to the `manifest.json` file and replace the `vendor` value with the name of your VTEX account.\n4. Go to the `node/resolvers` folder and open the `searchSegment.ts` file. \n> The `segmentSearch` function is responsible for providing a JSON array of facets. For example, if you want to segment the search by the `shoes` category, the `segmentSearch` function returns `[{\"key\": \"category-1\", \"value\": \"shoes\"}]`.\n5. Replace the `searchSegment` definition with your own segmentation rules. Take the following example in which we segmented the search result to filter by the `123`collection for `vtex.com.br` emails and by the `456` collection otherwise: \n`1 \nexport const queries = { \n2 \n searchSegment: async (ctx: any, args: SearchSegmentInput, __: Context) => { \n3 \n const userEmail = args.userEmail \n4 \n const domain = userEmail.split('@')[1] \n5 \n \n6 \n return domain === 'vtex.com.br' ? [{ key: 'productClusterIds', value: '123' }] : [{ key: 'productClusterIds', value: '456' }] \n7 \n }, \n8 \n} \n` \nNotice that the `searchSegment` function receives the `args` variable, which has the `SearchSegmentInput` type: \n`1 \ninterface SearchSegmentInput { \n2 \n // User email \n3 \n userEmail?: string \n4 \n // Whether the user is authenticated or not \n5 \n isAuthenticated?: boolean \n6 \n // Array of selected facets (optionally you can control it by the session itself) \n7 \n selectedFacets?: SelectedFacet[] \n8 \n} \n` \n> ️Filtering by facets in the final domain without the customer’s authentication requires adding the facet to the `public` namespace, a configuration that this app does not handle by default. You need to ensure this step is completed manually by following the [Sessions System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview%23changing-information-from-a-session) guide if required.\n6. [Create a development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace) and [link your app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app) to test if your segmentation rules are working as expected.\n7. Once you finish your tests, follow all the necessary steps to [make your app publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available) before promoting it to master.\n\nContributors\n\n3\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/geisecosta)\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/vtex-io-documentation-segmenting-the-search-result.md)\n\n[Get a list of the possible facets for a specific search« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-segmenting-the-search-result//docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search)[Access Control ListNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-segmenting-the-search-result//docs/guides/access-control-list)\n\nContributors\n\n3\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/geisecosta)\n\nON THIS PAGE\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-segmenting-the-search-result/docs/guides/vtex-io-documentation-segmenting-the-search-result%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/Search/vtex-io-documentation-segmenting-the-search-result.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-segmenting-the-search-result/docs/guides/vtex-io-documentation-segmenting-the-search-result%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_df89e44e
|
[
{
"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 troubleshooting 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-troubleshooting/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-troubleshooting/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-troubleshooting/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-troubleshooting/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-troubleshooting/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-troubleshooting/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-troubleshooting/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-troubleshooting/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-troubleshooting/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-troubleshooting/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-troubleshooting/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-troubleshooting/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-troubleshooting/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-troubleshooting/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-troubleshooting/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-troubleshooting/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-troubleshooting/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-troubleshooting/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-troubleshooting/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-troubleshooting/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-troubleshooting/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-troubleshooting/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-troubleshooting/docs/storefront-development)\n\nTroubleshooting\n\n## GraphQL changes not visible during development\n\nIf your GraphQL changes aren't visible during development, the changes you have made since you started the development server (`yarn dev`) are probably not optimized. Follow these steps to trigger the optimization:\n\n* Run `yarn generate` (recommended) or `yarn run faststore generate-graphql`. \n> This optimization can also be performed while the development server is running.\n* Alternatively, you can stop and restart the development server using `yarn dev`.\n\n## Deploy preview/production GraphQL schema different from development\n\nIf you notice differences between the GraphQL schema in your deploy preview or production environment compared to your development setup, it may be due to the schema not being optimized since the development server's initiation. The build process optimizes the schema before deployment to accurately reflect the schema declared in the store's code.\n\nTo fix the issue, refer to the [GraphQL changes not visible during development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-extension/troubleshooting%23graphql-changes-not-visible-during-development) topic.\n\n## Type generation errors and warnings\n\nSome errors can occur during GraphQL optimizations and type generation. Here's how to troubleshoot them:\n\n`error Failed to run 'yarn generate:schema'. Please check your setup.`\n\n**\\- Possible cause:** Malformed files in your GraphQL Schema Extensions definitions.\n\n**\\- Solution:** Check the graphql files inside the `src/graphql/(vtex or thirdParty)/typeDefs` folders for syntax or definition errors.\n\n`error GraphQL was not optimized and TS files were not updated. Changes in the GraphQL layer did not take effect`\n\n**\\- Possible Cause:** Malformed files or GraphQL types within your GraphQL layer, including errors in GraphQL Schema Extensions, declared queries, and fragments.\n\n**\\- Solution:** Check the graphql files inside the `src/graphql/(vtex or thirdParty)/typeDefs` folders and component (.ts, tsx) files declaring queries and fragments in your project for syntax or definition errors.\n\n`warn Failed to format generated files. 'yarn format:generated' thrown errors`\n\nAfter generating GraphQL Optimization and types files, they are formatted for readability. This step is recommended but not mandatory. If it fails, your changes to the GraphQL layer will still be visible. Therefore, it is a warning, not an error.\n\n### Error details\n\nTo access more detailed error information, use the `--debug` flag when manually running the `yarn generate` command to see detailed errors on why the generation has failed.\n\n## GraphQL changes not visible in production/deploy preview\n\nDuring the build step, the GraphQL optimization and type files are always generated fresh, which means they always reflect the most recent changes in the code.\n\nIf your changes are not visible in production, this means you must not have committed them to the branch you're currently working on. If you see different GraphQL schema, queries, or data during development, refer to the [GraphQL changes not visible during development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-extension/troubleshooting%23graphql-changes-not-visible-during-development) topic.\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\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/faststore/docs/api-extensions/troubleshooting.mdx)\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[GraphQL changes not visible during development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-troubleshooting/docs/guides/faststore/api-extensions-troubleshooting%23graphql-changes-not-visible-during-development)\n\n[Deploy preview/production GraphQL schema different from development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-troubleshooting/docs/guides/faststore/api-extensions-troubleshooting%23deploy-previewproduction-graphql-schema-different-from-development)\n\n[Type generation errors and warnings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-troubleshooting/docs/guides/faststore/api-extensions-troubleshooting%23type-generation-errors-and-warnings)\n\n[Error details](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-troubleshooting/docs/guides/faststore/api-extensions-troubleshooting%23error-details)\n\n[GraphQL changes not visible in production/deploy preview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-troubleshooting/docs/guides/faststore/api-extensions-troubleshooting%23graphql-changes-not-visible-in-productiondeploy-preview)\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/troubleshooting.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[GraphQL changes not visible during development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-troubleshooting/docs/guides/faststore/api-extensions-troubleshooting%23graphql-changes-not-visible-during-development)\n\n[Deploy preview/production GraphQL schema different from development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-troubleshooting/docs/guides/faststore/api-extensions-troubleshooting%23deploy-previewproduction-graphql-schema-different-from-development)\n\n[Type generation errors and warnings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-troubleshooting/docs/guides/faststore/api-extensions-troubleshooting%23type-generation-errors-and-warnings)\n\n[Error details](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-troubleshooting/docs/guides/faststore/api-extensions-troubleshooting%23error-details)\n\n[GraphQL changes not visible in production/deploy preview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-troubleshooting/docs/guides/faststore/api-extensions-troubleshooting%23graphql-changes-not-visible-in-productiondeploy-preview)\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_520eb189
|
[
{
"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 icons 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-icons/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-icons/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-icons/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-icons/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-icons/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-icons/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-icons/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/updates/release-notes)\n\nStore Icons\n\nAll Store icons components.\n\n## Table of Contents\n\n* [Store Icons](#store-icons) \n * [Description](#description) \n * [Release schedule](#release-schedule) \n * [Table of Contents](#table-of-contents) \n * [Concept](#concept) \n * [Usage](#usage) \n * [Dedicated Icon](#dedicated-icon) \n * [Generic Icon](#generic-icon) \n * [Icons](#icons) \n * [Props](#props) \n * [Icons List](#icons-list) \n * [Brand](#brand) \n * [High Priority Actions](#high-priority-actions) \n * [Middle Priority Actions](#middle-priority-actions) \n * [Informational](#informational) \n * [Navigation](#navigation) \n * [Status Indicators](#status-indicators) \n * [Customize](#customize) \n * [Overwriting the default IconPack](#overwriting-the-default-iconpack) \n * [Nomenclature](#nomenclature) \n * [Icon Intention](#icon-intention) \n * [Troubleshooting](#troubleshooting) \n * [Contributing](#contributing) \n * [Tests](#tests)\n\n## Concept\n\nThis project is based on [SVG fragment identifiers](https://read.calvincode.net/reader?url=https://css-tricks.com/svg-fragment-identifiers-work/). All store icons are served by Render SDK, and with HTML tag `<use>` we can render a fragment from our icon pack. If you want to know the complete list of fragment SVG's, [see here](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/master/docs/ICONPACK.md)\n\n## Usage\n\nFirst of all, add into the dependencies of your `manifest.tsxon` and use it as an npm module:\n\n`1\n\n\"dependencies\": { \n\n2\n\n \"vtex.store-icons\": \"0.x\" \n\n3\n\n} \n\n`\n\nThere are two different ways to use the icons available here. If you're developing a store's theme, you should use the `icon` block for the icon you want to render, which behaves just like any other block and expects to receive the props exposed by its [API](#props). But if you're developing custom components and want to use icons defined here, just follow the instructions below.\n\n### Dedicated Icon\n\nImport the desired icon and use it into your code, for example:\n\n`1\n\nimport { IconMenu } from \"vtex.store-icons\"; \n\n2\n\n \n3\n\nconst YourComponent = (props) => <IconMenu />; \n\n`\n\nYou can see [here](#icon-list) a list of every available icon.\n\n### Generic Icon\n\nThe API provides a generic icon, The `Icon` component. You can choose from any other icon passing only the `id` from the respective one you want to add.\n\nFor example:\n\n`1\n\nimport { Icon } from \"vtex.store-icons\"; \n\n2\n\n \n3\n\nconst YourComponent = (props) => <Icon id=\"hpa-cart\" />; \n\n`\n\n⚠️ This component is meant to be used on icons there aren't common throughout the store. Choose [dedicated](#dedicated-icon) components whenever possible.\n\n## Icons\n\n### Props\n\nAny icon can receive the following props:\n\n| Property | Description | Type | Default value |\n| --------------- | ------------------------------------------ | ------- | ------------- |\n| id | The ID for the desired icon | String | '' |\n| size | Desired size | Number | 16 |\n| isActive | desc | Boolean | true |\n| activeClassName | The className it should have if active | String | 🚫 |\n| mutedClassName | The className it should have if not active | String | 🚫 |\n\nObs: **...props**: It is important to notice that any other `<svg>` prop passed will work with an icon as well.\n\n#### Enhanced Props\n\nSome components support modifiers. These are props that define the icon type, orientation, state or shape.\n\n| Modifier | Possible values |\n| ----------- | --------------------- |\n| type | filled line outline |\n| orientation | up down left right |\n| state | on off |\n| shape | square rounded circle |\n\n### Icon List\n\n#### Brand\n\n| Component | id | Type | Orientation | State | Shape | |\n| --------------------------------------------------------------------------------------- | ------ | ---- | ----------- | ----- | ----------------- | ------ |\n| [IconSocial](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/master/react/IconSocial.tsx) | social | 🚫 | 🚫 | 🚫 | square \\| rounded | circle |\n\n#### High Priority Actions\n\n| Component | id | Type | Orientation | State | Shape |\n| ------------------------------------------------------------------------------------------------------- | --------------- | ---- | ----------- | ----- | ----- |\n| [IconArrowBack](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/master/react/IconArrowBack.tsx) | arrow-back | 🚫 | 🚫 | 🚫 | 🚫 |\n| [IconAssistantSales](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/master/react/IconAssistantSales.tsx) | assistant-sales | 🚫 | 🚫 | 🚫 | 🚫 |\n| [IconProfile](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/master/react/IconProfile.tsx) | profile | 🚫 | 🚫 | 🚫 | 🚫 |\n| [IconCart](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/master/react/IconCart.tsx) | cart | 🚫 | 🚫 | 🚫 | 🚫 |\n| [IconSearch](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/master/react/IconSearch.tsx) | search | 🚫 | 🚫 | 🚫 | 🚫 |\n| [IconDelete](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/master/react/IconDelete.tsx) | delete | 🚫 | 🚫 | 🚫 | 🚫 |\n| [IconMenu](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/master/react/IconMenu.tsx) | menu | 🚫 | 🚫 | 🚫 | 🚫 |\n| [IconLocationMarker](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/master/react/IconLocationMarker.tsx) | location-marker | 🚫 | 🚫 | 🚫 | 🚫 |\n\n#### Medium Priority Actions\n\n| Component | id | Type | Orientation | State | Shape | | ----------------------------------------------------------------------------------------------- | ------------- | ------------------------- | ----------- | --------- | ----- | ------ | | [IconEyeSight](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/master/react/IconEyeSight.tsx) | `eyesight` | filled | outline | 🚫 | on | off | 🚫 | | [IconMinus](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/master/react/IconMinus.tsx) | `minus` | filled | outline | line | 🚫 | 🚫 brands | | [IconPlus](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/master/react/IconPlus.tsx) | `plus` | filled | outline | line | 🚫 | 🚫 | 🚫 | brands | | [IconSingleGrid](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/master/react/IconSingleGrid.tsx) | `single-item` | 🚫 | 🚫 | 🚫 | 🚫 | | [IconRemove](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/master/react/IconRemove.tsx) | `remove` | 🚫 | 🚫 | 🚫 | 🚫 | | [IconSwap](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/master/react/IconSwap.tsx) | `swap` | 🚫 | 🚫 | 🚫 | 🚫 | | [IconHeart](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/master/react/IconHeart.tsx) | `heart` | 🚫 | 🚫 | 🚫 | 🚫 | | [IconGlobe](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/master/react/IconGlobe.tsx) | `globe` | 🚫 | 🚫 | 🚫 | 🚫 | | [IconBookmark](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/master/react/IconBookmark.tsx) | `bookmark` | filled | outline | 🚫 | 🚫 | 🚫 | | [IconPlay](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/master/react/IconPlay.tsx) | `play` | filled | outline | 🚫 | 🚫 | 🚫 | | [IconPause](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/master/react/IconPause.tsx) | `pause` | filled | outline | 🚫 | 🚫 | 🚫 |\n\n#### Navigation\n\n| Component | id | Type | Orientation | State | Shape | | ------------------------------------------------------------------------------------- | ------- | ---- | --------------------------- | ----- | ----- | ------------- | | [IconCaret](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/master/react/IconCaret.tsx) | `caret` | 🚫 | up | down | left | right | 🚫 | 🚫 | true | false |\n\n#### Status Indicators\n\n| Component | id | Type | Orientation | State | Shape | |\n| --------------------------------------------------------------------------------------------- | ---------- | ----------------- | ----------- | ----- | ----- | -- |\n| [IconClose](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/master/react/IconClose.tsx) | close | filled \\| outline | 🚫 | 🚫 | 🚫 | |\n| [IconCheck](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/master/react/IconCheck.tsx) | check | filled \\| outline | line | 🚫 | 🚫 | 🚫 |\n| [IconVolumeOn](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/master/react/IconVolumeOn.tsx) | volume-on | filled \\| outline | line | 🚫 | 🚫 | 🚫 |\n| [IconVolumeOff](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/master/react/IconVolumeOff.tsx) | volume-off | filled \\| outline | line | 🚫 | 🚫 | 🚫 |\n\n## Customize\n\nIn the [usage](#usage) section, we discuss two ways of using icons. These ways extend to customization, so, prefer to change an existing Icon so that you can use the [dedicated](#dedicated-icon) version. You can check how to override and name icons below.\n\n### Overwriting the default IconPack\n\nAs mentioned before, all icon IDs are stored at the [iconpack.svg](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/master/docs/ICONPACK.md) file. You can overwrite the default one by:\n\n1. On your [store-theme](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-theme/tree/master/styles) create a new folder called `iconpacks`\n2. Create a file called `iconpack.svg`\n3. Declare your icon IDs (use the default `iconpack` as an example in how to do that properly).\n\n### Nomenclature\n\nThe naming convention is: [intention](#icon-intention)\\-[id](#icon-list)\\--[?modifiers](#enhanced-props)\n\nWhere the `modifiers` follows the rule:`?type`\\--`?orientation`\\--`?state`\\--`?shape`\n\n**🤓 ? stands for optional inputs**\n\n#### Icon Intention\n\n`bnd` **Brand** \\- Display logos, brands or advertisements.\n\n`hpa` **High priority actions** \\- Actions that are important to the global context.\n\n`mpa` **Mild priority actions** \\- Actions that are important only to the current component context.\n\n`inf` **Informational** \\- Represents information display or actions that, when triggered, reveal further details about the current context.\n\n`nav` **Navigation** \\- Actions that triggers navigation.\n\n`sti` **Status indicators** \\- Indicates the current item/component semantic status.\n\n## CSS 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://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization).\n\n| CSS Handles |\n| -------------------- |\n| 'arrowBackIcon' |\n| 'assistantSalesIcon' |\n| 'caretIcon' |\n| 'cartIcon' |\n| 'checkIcon' |\n| 'closeIcon' |\n| 'deleteIcon' |\n| 'equalsIcon' |\n| 'eyeSightIcon' |\n| 'filterIcon' |\n| 'globeIcon' |\n| 'gridIcon' |\n| 'heartIcon' |\n| 'homeIcon' |\n| 'inlineGridIcon' |\n| 'locationInputIcon' |\n| 'locationMarkerIcon' |\n| 'menuIcon' |\n| 'minusIcon' |\n| 'plusIcon' |\n| 'profileIcon' |\n| 'removeIcon' |\n| 'searchIcon' |\n| 'singleGridIcon' |\n| 'socialIcon' |\n| 'starIcon' |\n| 'swapIcon' |\n| 'playIcon' |\n| 'pauseIcon' |\n| 'fullscreenIcon' |\n| 'volumeOnIcon' |\n| 'volumeOffIcon' |\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/functional-apps/vtex-store-icons.md)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Table of Contents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/docs/guides/vtex-store-icons%23table-of-contents)\n\n[Concept](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/docs/guides/vtex-store-icons%23concept)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/docs/guides/vtex-store-icons%23usage)\n\n[Dedicated Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/docs/guides/vtex-store-icons%23dedicated-icon)[Generic Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/docs/guides/vtex-store-icons%23generic-icon)\n\n[Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/docs/guides/vtex-store-icons%23icons)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/docs/guides/vtex-store-icons%23props)[Icon List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/docs/guides/vtex-store-icons%23icon-list)\n\n[Customize](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/docs/guides/vtex-store-icons%23customize)\n\n[Overwriting the default IconPack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/docs/guides/vtex-store-icons%23overwriting-the-default-iconpack)[Nomenclature](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/docs/guides/vtex-store-icons%23nomenclature)\n\n[CSS Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/docs/guides/vtex-store-icons%23css-customization)\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/functional-apps/vtex-store-icons.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Table of Contents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/docs/guides/vtex-store-icons%23table-of-contents)\n\n[Concept](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/docs/guides/vtex-store-icons%23concept)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/docs/guides/vtex-store-icons%23usage)\n\n[Dedicated Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/docs/guides/vtex-store-icons%23dedicated-icon)[Generic Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/docs/guides/vtex-store-icons%23generic-icon)\n\n[Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/docs/guides/vtex-store-icons%23icons)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/docs/guides/vtex-store-icons%23props)[Icon List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/docs/guides/vtex-store-icons%23icon-list)\n\n[Customize](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/docs/guides/vtex-store-icons%23customize)\n\n[Overwriting the default IconPack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/docs/guides/vtex-store-icons%23overwriting-the-default-iconpack)[Nomenclature](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/docs/guides/vtex-store-icons%23nomenclature)\n\n[CSS Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/docs/guides/vtex-store-icons%23css-customization)\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_9909ee94
|
[
{
"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 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/erp-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/erp-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/erp-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/erp-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/erp-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/erp-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/erp-integration-guide/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-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/erp-integration-guide/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-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/erp-integration-guide/docs/guides/erp-integration-guide)\n\n[Set up catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/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-guide/docs/guides/erp-integration-import-prices)\n\n[Import inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/docs/guides/faq-erp-integration)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-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/erp-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/erp-integration-guide/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-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/erp-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/erp-integration-guide/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-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/erp-integration-guide/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-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/erp-integration-guide/docs/guides/erp-integration-guide)\n\n[Set up catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/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-guide/docs/guides/erp-integration-import-prices)\n\n[Import inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/docs/guides/faq-erp-integration)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-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/erp-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/erp-integration-guide/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-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/erp-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/erp-integration-guide/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-guide/docs/guides/erp-integration-guide)\n\nBack office integration guide (ERP/PIM/WMS)\n\nUse our APIs to build a complete back-office integration\n\n> This guide refers mostly to ERPs. But keep in mind that integrating PIMs and WMSs basically follows the same principles and the content will point out whenever that is not the case.\n\nAn ecommerce operation may use a range of software to better manage its resources and information. In this guide, we take a look at the best ways to integrate these systems with your VTEX store. This allows your store to optimize operations by creating efficient communications between VTEX and other software.\n\nEach operation has its specific needs and we do not recommend any particular software. However, here are some examples used by different operations:\n\n* Enterprise Resource Planning (ERP) and Warehouse Management System (WMS) \n * Aquilon \n * Aptean Catalyst \n * Brightpearl \n * ECI Software Solutions \n * IBM Sterling WMS \n * JDA \n * Microsoft \n * Oracle Netsuite \n * Sage \n * SAP \n * Manhattan\n* Product Information Manager (PIM) \n * Akeneo \n * Simplus \n * IBM Product Master \n * Informatica \n * inRiver \n * Widen Collective\n\nFor a complete back-office integration, you should use our APIs to send your Products, Pricing, and Inventory to VTEX and to receive your Orders from VTEX. In order to provide more detail on this data flow, this overview is split into the initial setup and the ongoing integration flow.\n\n> Check the new [Catalog onboarding guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Catalog and is organized by focusing on the developer's journey.\n\n## Initial setup\n\nTo get your integration up and running, you need to perform some configuration steps and then set up the middleware that will handle the ongoing flow. See the steps below.\n\n### Configuration\n\nImport prices\n\n\\- [Set base price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices)\n\n\\- [Set fixed prices for specific contexts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices%23set-fixed-prices-for-specific-contexts) \n\n\\- Set base price...Set up catalog\n\n\\- [Category tree](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog)\n\n\\- [Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog%23create-brands)\n\n\\- [Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog%23create-specifications-groups)\n\n\\- [Groups](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog%23create-specifications-groups)\n\n\\- [Fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog%23create-specification-fields)\n\n\\- [Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog%23create-specification-values) \n\n\\- Category tree...Import products\n\n\\- [Import product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products)\n\n\\- [Import product specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products%23import-product-specifications)\n\n\\- [Add product to trade policy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products%23add-product-to-trade-policy)\n\n\\- [Import SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products%23import-sku)\n\n\\- [Import SKU specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products%23import-sku-specifications)\n\n\\- [Import SKU image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products%23import-sku-image) \n\n \n\\- Import product...Import inventory\n\n\\- [Create warehouses](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-inventory)\n\n\\- [Update SKU inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-inventory%23update-sku-inventory) \n\n\\- Create warehouses...Text is not SVG - cannot display\n\n> Note that some of these steps are also used in the ongoing integration. For example, the registering of products and inventory.\n\n#### Import customer data\n\nWhen implementing an ecommerce project, it may be necessary to import customer data from other systems, such as Customer Relationship Management (CRM) applications.\n\nUnlike the processes shown in the image above, this import does not require a specific order relative to other processes.\n\nSee the [Import customer data integration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data) to learn how to perform this process using [Master Data v2](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/master-data-v2--3JJ1mlzuo88w22gO0gy0QS%23).\n\n### Middleware setup\n\nSet up order processing\n\n\\- [Change order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing) \n\n\\- [Cancellation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing%23cancel-order)\n\n\\- [Invoicing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing%23invoice-order)\n\n\\- [Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing%23order-tracking) \n\n\\- Change order...Set up order integration\n\n\\- [Configure feed or hook](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration)\n\n\\- Configure feed or hookText is not SVG - cannot display\n\nAfter the configuration, you must set up your middleware to be able to send and receive information from VTEX according to events in the routine of your operation.\n\nThere are many different ways to do this and your store’s technical team must decide what processes suit your needs. Solutions can be divided into two main groups:\n\n* Integration platforms: third-party Platform as a Service companies whose product allows you to create VTEX integrations with minimal development effort.\n* In-house developing: when choosing this path, keep in mind that that you must not only build the software, but maintain the ongoing integration. For example, the middleware must be able to handle scalability issues that come with sales peaks such as may occur in a black friday event.\n\n## Ongoing middleware flow\n\nOnce you have configurated your store and set up the middleware, the general flow of information will look something like this:\n\nStore backoffice\n\nStore backoffice\n\nVTEX\n\nVTEX\n\n**Catalog**\n\nCatalog\n\n**Pricing**\n\nPricing\n\n**Logistics**\n\nLogistics\n\n**ERP**\n\nERP\n\n**WMS**\n\nWMS\n\n[Product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide%23send-product-updates)\n\nProduct updates\n\n[Order flow notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide%23receive-order-flow-notification)\n\nOrder flow notification\n\n**Orders**\n\nOrders\n\n[Pricing updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide%23send-pricing-updates)\n\nPricing updates\n\n[Tracking information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide%23send-tracking-information)\n\nTracking information\n\n[Inventory updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information%23inventory-updates)\n\nInventory updates\n\n[Invoice ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide%23send-invoice-information)\n\nInvoice \n\n[Order information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide%23get-order-information)\n\nOrder information\n\n[Cancelation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide%23send-order-cancelations)\n\nCancelation\n\n[Order change](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide%23send-order-changes)\n\nOrder changeText is not SVG - cannot display\n\nEach of the requests or processes represented by the arrows in the diagram above, is triggered by a different event in the day-to-day operation of an ecommerce. See details on the following sessions.\n\n### Send product updates\n\n**Trigger:** Whenever there are product updates in your ERP or PIM.\n\nThere are many business reasons that may lead to product updates to your store, be it adding new SKUs, editing existing ones, or removing them from your store. The goal here is for your integration to automatically pick up product updates from the ERP and send them to VTEX APIs.\n\nLearn more about how to implement this in our [Product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information%23product-updates) guide.\n\n### Send pricing updates\n\n**Trigger:** Whenever there are price changes in your ERP or PIM.\n\nSimilar to product updates, there are different reasons as to why stores change their prices. In any case, whenever you decide to change your store’s prices, you should set up the integration to automatically send these updates from the ERP to VTEX.\n\nLearn more in our guide [Pricing updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information%23pricing-updates).\n\n### Receive order flow notification\n\n**Trigger:** Whenever any order gets to one of the statuses predetermined by you.\n\nIn VTEX’s Order Management System (OMS) orders go through a [predetermined flow](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/order-flow-on-the-oms--tutorials%5F196). By setting up your order integration, you ensure your ERP gets notified whenever any order reaches some specific stages in its life cycle.\n\nFor example, the status `ready-for-handling` tells you that the order has been paid for and the grace period has expired. On the other hand, `request-cancel` means your customer wishes that the order be canceled.\n\nTo learn more see [Set up order integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration).\n\n### Get order information\n\n**Trigger:** When your store needs to take action regarding a specific order.\n\nWhen setting up order integration you may configure variate notifications for different stages that an order goes through. Some or all of these stages may prompt your store to take action based on the order’s specific information.\n\nFor instance, when an order gets to `ready-for-handling` it is time to pick and pack. For an order that got to `request-cancel`, you should assess the order’s situation and take action accordingly.\n\nTo learn more check [Set up order integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration).\n\n### Send invoice information\n\n**Trigger:** When your ERP has generated the invoice for the order.\n\nTo learn more see [Invoice order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing%23invoice-order).\n\n### Send tracking information\n\n**Trigger:** When the assigned carrier makes tracking information available for a given order.\n\nIn VTEX order management, tracking information is tied to the order’s invoice. Learn more in [Order tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing%23order-tracking).\n\n### Send order changes\n\n**Trigger:** When the store needs to change items or values of an existing order.\n\nOrder changes may be needed in various scenarios, such as when an item in the order is actually out of stock.\n\nTo learn more see [Change order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order).\n\nFor marketplaces, it may also be necessary to perform changes in sellers. Learn more with our [Change seller guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller)\n\n### Send order cancelations\n\n**Trigger:** When your store needs to cancel an order.\n\nTo learn more see [Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing%23cancel-order).\n\n> Make sure you have gone through our [Platform Overview guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-platform-overview) and have [created the appKey and appToken](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication%23api-keys) for the system you want to integrate with VTEX. You can find the Application Keys page by clicking on your **profile's avatar**, which is marked with the initial from your email, then going to **Account settings > Application keys.**\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/erp-integration-guide.md)\n\n[Subscriptions« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide//docs/guides/subscriptions)[Set up catalogNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide//docs/guides/erp-integration-set-up-catalog)\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[Initial setup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23initial-setup)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23configuration)[Middleware setup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23middleware-setup)\n\n[Ongoing middleware flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23ongoing-middleware-flow)\n\n[Send product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23send-product-updates)[Send pricing updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23send-pricing-updates)[Receive order flow notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23receive-order-flow-notification)[Get order information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23get-order-information)[Send invoice information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23send-invoice-information)[Send tracking information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23send-tracking-information)[Send order changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23send-order-changes)[Send order cancelations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23send-order-cancelations)\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.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Initial setup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23initial-setup)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23configuration)[Middleware setup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23middleware-setup)\n\n[Ongoing middleware flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23ongoing-middleware-flow)\n\n[Send product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23send-product-updates)[Send pricing updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23send-pricing-updates)[Receive order flow notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23receive-order-flow-notification)[Get order information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23get-order-information)[Send invoice information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23send-invoice-information)[Send tracking information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23send-tracking-information)[Send order changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23send-order-changes)[Send order cancelations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide/docs/guides/erp-integration-guide%23send-order-cancelations)\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_6870ab2d
|
[
{
"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 apps vtexbr.pickup 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/vtexbr.pickup-selector/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-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/vtexbr.pickup-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/vtexbr.pickup-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/vtexbr.pickup-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/vtexbr.pickup-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/vtexbr.pickup-selector/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.checkout-ui-custom)\n\n[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.messages)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/affiliates-program-app)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-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/vtexbr.pickup-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/vtexbr.pickup-selector/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.checkout-ui-custom)\n\n[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.messages)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/affiliates-program-app)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-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/vtexbr.pickup-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/vtexbr.pickup-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/vtexbr.pickup-selector/docs/vtex-io-apps)\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/guides/functional-apps)\n\nPickup point selector\n\nCommunity extension\n\nVersion: 3.0.1\n\nLatest version: 3.0.1\n\n> This app is no longer maintained by VTEX. This means support and maintenance are no longer provided.\n\n[](#contributors-)\n\nThe pickup point selector app adds a block to your store, which allows shoppers to add a product to cart and select a pickup point for it with a single action.\n\nThe app creates a list of available pickup points by running a simulation with the selected SKU and the zipcode provoded by the shopper.\n\n> Warning: This app should only be used inside the product page, since one of its dependencies is the `product-context`.\n\n## Configuration\n\nFollow the steps below to configure the app on your store theme.\n\n### 1\\. Install the app in your workspace and account.\n\nTo do this, you can go to the [Pickup point selector page](https://read.calvincode.net/reader?url=https://apps.vtex.com/vtexbr-pickup-selector/p) in the VTEX app store or run this command in your terminal:\n\n`1\n\nvtex install vtexbr.pickup-selector \n\n`\n\n### 2\\. Add the app as a theme dependency in the `manifest.json` file.\n\nSee an example of how to do this:\n\n`1\n\n \"peerDependencies\": { \n\n2\n\n \"vtexbr.pickup-selector\": \"2.x\" \n\n3\n\n } \n\n`\n\nNow, you are able to use all the [blocks](#blocks) exported by the **pickup-selector** app and its respective [props](#props).\n\n### 3\\. Adding the main block\n\nDeclare the app's main block in a given theme template or inside another block from the theme. See the code example below.\n\n`1\n\n \"pickup-selector\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"pickup-selector-zipcode-input\", \n\n4\n\n \"pickup-selector-search-sla-button\", \n\n5\n\n \"pickup-selector-sla-list\" \n\n6\n\n ] \n\n7\n\n } \n\n`\n\n> Note that the [blocks](#blocks) `pickup-selector-zipcode-input`, `pickup-selector-search-sla-button` and `pickup-selector-sla-list` are required inside the main block. But you can use them in any order you want. You can also use flex-layout if needed.\n\n### 4\\. Configuring the `pickup-selector-sla-list`\n\nThe only [block](#blocks) that should be used inside this one is the `pickup-selector-option-card`. We do this so that you can be free to style the option card as you want, and we will use that as a template for all the options. Below you can see an example.\n\n`1\n\n \"pickup-selector-sla-list\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"pickup-selector-option-card\" \n\n4\n\n ] \n\n5\n\n } \n\n`\n\n### 5\\. Configuring the `pickup-selector-option-card`\n\nYou are free to style this block as you wish.\n\nThe app provides [blocks](#blocks) that will help with the information about the pickup point. They are the following:\n\n* `pickup-selector-option-card-pickup-point-name`\n* `pickup-selector-option-card-pickup-point-address`\n* `pickup-selector-option-card-pickup-point-distance`\n* `pickup-selector-option-card-pickup-point-sla`\n\nThe only mandatory block inside this one is the `pickup-selector-option-card-add-product-button`.\n\nBelow you can see and example of this:\n\n`1\n\n \"pickup-selector-option-card\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"flex-layout.col#card-container\" \n\n4\n\n ] \n\n5\n\n }, \n\n6\n\n \n7\n\n \"flex-layout.col#card-container\": { \n\n8\n\n \"children\": [ \n\n9\n\n \"flex-layout.row#card-header\", \n\n10\n\n \"product-separator\", \n\n11\n\n \"flex-layout.row#card-body\" \n\n12\n\n ] \n\n13\n\n }, \n\n14\n\n \n15\n\n \"flex-layout.row#card-header\": { \n\n16\n\n \"props\": { \n\n17\n\n \"colSizing\": \"auto\" \n\n18\n\n }, \n\n19\n\n \"children\": [ \n\n20\n\n \"pickup-selector-option-card-pickup-point-distance\", \n\n21\n\n \"pickup-selector-option-card-pickup-point-name\" \n\n22\n\n ] \n\n23\n\n }, \n\n24\n\n \n25\n\n \"flex-layout.row#card-body\": { \n\n26\n\n \"props\": { \n\n27\n\n \"colSizing\": \"auto\" \n\n28\n\n }, \n\n29\n\n \"children\": [ \n\n30\n\n \"flex-layout.col#card-body-address\", \n\n31\n\n \"flex-layout.col#card-body-call-to-action\" \n\n32\n\n ] \n\n33\n\n }, \n\n34\n\n \n35\n\n \"flex-layout.col#card-body-address\": { \n\n36\n\n \"children\": [ \n\n37\n\n \"pickup-selector-option-card-pickup-point-address\" \n\n38\n\n ] \n\n39\n\n }, \n\n40\n\n \n41\n\n \"flex-layout.col#card-body-call-to-action\": { \n\n42\n\n \"children\":[ \n\n43\n\n \"pickup-selector-option-card-pickup-point-sla\", \n\n44\n\n \"pickup-selector-option-card-add-product-button\" \n\n45\n\n ] \n\n46\n\n } \n\n`\n\nUsing the configuration above, the end result would look like this:\n\n\n\n## Blocks\n\nCheck out the full list of exported blocks below:\n\n| Block name | Description |\n| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |\n| pickup-selector | Main block. |\n| pickup-selector-zipcode-input | Shows the zipcode input. |\n| pickup-selector-search-sla-button | Button used to search the pickup SLA options based on the provided postal code and the selected SKU. |\n| pickup-selector-sla-list | List that shows the card with the avaiable pickup options. |\n| pickup-selector-option-card | Card with pickup option information. |\n| pickup-selector-option-card-pickup-point-name | Pickup point name. |\n| pickup-selector-option-card-pickup-point-address | Pickup point address. |\n| pickup-selector-option-card-pickup-point-distance | Distance to pickup point (in Km). |\n| pickup-selector-option-card-pickup-point-sla | Pickup point SLA. |\n| pickup-selector-option-card-add-product-button | Button that adds the product to cart and selects the pickup point. |\n\n### Props\n\nSome of these blocks accept props as described below:\n\n#### `pickup-selector-option-card-pickup-point-distance` props\n\n| Prop name | Type | Description | Default value |\n| -------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| distanceSystem | string | This prop is used to calculate the distance displayed by the block, it accepts metric (shows distance in Km) and imperial (shows distance in Mi). | metric |\n\n#### `pickup-selector-option-card-add-product-button` props\n\n| Prop name | Type | Description | Default value |\n| ------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| customPixelEventId | string | This prop should only be used with [minicart.v2](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/minicart). It defines the ID for the event that is sent by the button upon user interaction. Should be the same ID configured on **minicart.v2** so that the drawer opens on successfully adding the product to the cart. | undefined |\n| showToastFeedback | boolean | This prop is a fallback in order to support minicart.v1. This will show a toast with feedback on successfully adding the product to the cart. | false |\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| pickupPointOptionCard |\n| pickupPointAddress |\n| pickupPointDistance |\n| pickupPointName |\n| pickupPointSla |\n| pickupSelectorContainer |\n| pickupSelectorSlaList |\n| searchSlaButtonContainer |\n| selectPickupPointButtonContainer |\n| zipcodeInputContainer |\n\n[Product Context« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.product-context)[RewriterNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtex.rewriter)\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/vtexbr.pickup-selector/docs/apps/vtexbr.pickup-selector%23configuration)\n\n[1\\. Install the app in your workspace and account.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtexbr.pickup-selector%231-install-the-app-in-your-workspace-and-account)[2\\. Add the app as a theme dependency in the manifest.json file.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtexbr.pickup-selector%232-add-the-app-as-a-theme-dependency-in-the-manifestjson-file)[3\\. Adding the main block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtexbr.pickup-selector%233-adding-the-main-block)[4\\. Configuring the pickup-selector-sla-list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtexbr.pickup-selector%234-configuring-the-pickup-selector-sla-list)[5\\. Configuring the pickup-selector-option-card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtexbr.pickup-selector%235-configuring-the-pickup-selector-option-card)\n\n[Blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtexbr.pickup-selector%23blocks)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtexbr.pickup-selector%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.pickup-selector/docs/apps/vtexbr.pickup-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_72279499
|
[
{
"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 carousel 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-carousel/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-carousel/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-carousel/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-carousel/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-carousel/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-carousel/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-carousel/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-carousel/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-carousel/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/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-carousel/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/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-carousel/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/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-carousel/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-carousel/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-carousel/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-carousel/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/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-carousel/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-carousel/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/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-carousel/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-carousel/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/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-carousel/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/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-carousel/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/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-carousel/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-carousel/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-carousel/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-carousel/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/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-carousel/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-carousel/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-carousel/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/components-index)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-overview)\n\nCarousel\n\nSlides through multiple elements using custom controls.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/Carousel)\n\nThe `Carousel` component slides through multiple elements using custom controls.\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { Carousel } 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/Carousel/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> This component is a work in progress, and in some cases, it may not perform as expected.\n\n### Default\n\nExample\n\nCode\n\n`itemsPerPage = 1`\n\n* 1\n* 2\n* 3\n* 4\n* 5\n* 6\n* 7\n* 8\n* 9\n* 10\n\nExample\n\nCode\n\n`itemsPerPage = 5`\n\n* 1\n* 2\n* 3\n* 4\n* 5\n* 6\n* 7\n* 8\n* 9\n* 10\n\nExample\n\nCode\n\n`itemsPerPage = 10`\n\n* 1\n* 2\n* 3\n* 4\n* 5\n* 6\n* 7\n* 8\n* 9\n* 10\n\n### Infinite Scroll Mode\n\n> This mode is only supported given the following props setup: `itemsPerPage={1}`, `variant=\"slide\"` and `infiniteMode={true}`\n\nExample\n\nCode\n\n* 1\n\n---\n\n## Design tokens\n\n### Track\n\n| Local token | Default value/Global token linked |\n| ----------------------------- | ------------------------------------------ |\n| \\--fs-carousel-padding-mobile | var(--fs-spacing-0) var(--fs-grid-padding) |\n\n| Local token | Default value/Global token linked |\n| ------------------------------ | --------------------------------------------------------------------------------- |\n| \\--fs-carousel-padding-desktop | var(--fs-spacing-0) calc((100% - var(--fs-grid-max-width))/2) var(--fs-spacing-0) |\n\n### Item\n\n| Local token | Default value/Global token linked |\n| -------------------------------- | --------------------------------- |\n| \\--fs-carousel-item-margin-right | var(--fs-spacing-3) |\n\n### Controls\n\n| Local token | Default value/Global token linked |\n| ---------------------------------------- | -------------------------------------------- |\n| \\--fs-carousel-controls-width | 3.125rem |\n| \\--fs-carousel-controls-height | var(--fs-carousel-controls-width) |\n| \\--fs-carousel-controls-bkg-color | var(--fs-color-neutral-0) |\n| \\--fs-carousel-controls-border-radius | var(--fs-border-radius-circle) |\n| \\--fs-carousel-controls-box-shadow | var(--fs-shadow-darker) |\n| \\--fs-carousel-controls-control-left | var(--fs-spacing-4) |\n| \\--fs-carousel-controls-control-right | var(--fs-carousel-controls-control-left) |\n| \\--fs-carousel-controls-control-max-left | calc(-1 \\* var(--fs-spacing-11)) |\n| \\--fs-carousel-controls-control-max-left | var(--fs-carousel-controls-control-max-left) |\n\n### Bullets\n\n| Local token | Default value/Global token linked |\n| ---------------------------------------- | ----------------------------------------- |\n| \\--fs-carousel-bullets-padding-top | var(--fs-carousel-controls-control-left) |\n| \\--fs-carousel-bullets-padding-left | var(--fs-spacing-3) |\n| \\--fs-carousel-bullets-padding-right | var(--fs-carousel-bullets-padding-left) |\n| \\--fs-carousel-bullets-column-gap-mobile | var(--fs-carousel-item-margin-right) |\n| \\--fs-carousel-bullets-column-gap-tablet | var(--fs-spacing-3) |\n| \\--fs-carousel-bullet-width-mobile | 100% |\n| \\--fs-carousel-bullet-width-desktop | var(--fs-spacing-1) |\n| \\--fs-carousel-bullet-height-mobile | var(--fs-carousel-item-margin-right) |\n| \\--fs-carousel-bullet-height-desktop | var(--fs-carousel-bullet-width-desktop) |\n| \\--fs-carousel-bullet-bkg-color | var(--fs-color-neutral-3) |\n| \\--fs-carousel-bullet-bkg-color-selected | var(--fs-color-main-4) |\n| \\--fs-carousel-bullet-border-radius | var(--fs-carousel-controls-border-radius) |\n\n---\n\n## Data attributes\n\nYou can target and override `Carousel` styles using the following data attributes:\n\n`data-fs-carousel`\n\n`data-fs-carousel-track-container`\n\n`data-fs-carousel-track`\n\n`data-fs-carousel-item`\n\n`data-fs-carousel-controls`\n\n`data-fs-carousel-control`\n\n`data-fs-carousel-bullets`\n\n`data-fs-carousel-bullet`\n\n---\n\n## Use cases\n\n### Using the `ProductCard` component\n\nFor the mobile preview, please refresh the browser after resizing it.\n\nExample\n\nCode\n\n`itemsPerPage = 3`\n\n*  \n### Apple Magic Mouse \nOriginal price:$999Price:$950.04\n*  \n### 4k Philips Monitor 27” \nOriginal price:$490Price:$420\n*  \n### Echo Dot Smart Speaker \nOriginal price:$310Price:$280\n*  \n### Aedle VK-1 L Headphone \nOriginal price:$150Price:$130\n*  \n### Oculus VR Headset \nOriginal price:$344Price:$315\n*  \n### Apple AirPods Pro \nOriginal price:$249Price:$229\n*  \n### Anker SoundCore Liberty Air \nOriginal price:$643.71Price:$486.34\n*  \n### Fujifilm X-T1 Camera \nOriginal price:$495.97Price:$366.11\n*  \n### SANDMARC Fisheye Lens \nOriginal price:$946.73Price:$636.05\n*  \n### Apple AirTag \nOriginal price:$679.29Price:$426.14\n\nExample\n\nCode\n\n`itemsPerPage = 8`\n\n*  \n### Apple Magic Mouse \nOriginal price:$999Price:$950.04\n*  \n### 4k Philips Monitor 27” \nOriginal price:$490Price:$420\n*  \n### Echo Dot Smart Speaker \nOriginal price:$310Price:$280\n*  \n### Aedle VK-1 L Headphone \nOriginal price:$150Price:$130\n*  \n### Oculus VR Headset \nOriginal price:$344Price:$315\n*  \n### Apple AirPods Pro \nOriginal price:$249Price:$229\n*  \n### Anker SoundCore Liberty Air \nOriginal price:$643.71Price:$486.34\n*  \n### Fujifilm X-T1 Camera \nOriginal price:$495.97Price:$366.11\n*  \n### SANDMARC Fisheye Lens \nOriginal price:$946.73Price:$636.05\n*  \n### Apple AirTag \nOriginal price:$679.29Price:$426.14\n\n> Considering the component structure placed inside the `Carousel`, determine the ideal `itemsPerPage` number to accommodate the items and achieve the desired UI properly.\n\n---\n\n## Props\n\n| Name | Type | Description | Default | |\n| ------------------- | ------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | ------------------------------------------------------ | -------- |\n| **id** | string | ID of the current instance of the component. | fs-carousel | |\n| **testId** | string | ID to find this component in testing tools (e.g.: cypress, testing library, and jest). | fs-carousel | |\n| **className** | string | Returns the value of element's class content attribute. | | |\n| **aria-label** | string | Defines a string value that labels the current element when title is not used. | | |\n| **infiniteMode** | false \\| true | Whether or not the Carousel is infinite slide/scroll. Only for the \\`slide\\` variant. | false | |\n| **controls** | \"complete\" \\| \"navigationArrows\" | \"paginationBullets\" | Specifies which navigation elements should be visible. | complete |\n| **transition** | { duration: number; property: string; delay?: number; timing?: string; } | Specifies the slide transition. Only for the \\`slide\\` variant | { duration: 400, property: 'transform', } | |\n| **itemsPerPage** | number | Specifies the number of items per page. | 1 | |\n| **variant** | \"slide\" \\| \"scroll\" | Specifies the Carousel track variant. | scroll | |\n| **navigationIcons** | { left?: ReactNode; right?: ReactNode; } | Specifies the navigation icons. | undefined | |\n\n---\n\n## Best Practices\n\n### ✅ Do's\n\n* We recommend using Carousel when the total of items being displayed is at least 10 items.\n* Choose an `itemsPerPage` value that effectively accommodates the items within the slide without compromising the UI. Consider proposing different values for mobile and desktop.\n* Maintain the visibility of the controls (`navigationArrows` & `paginationBullets`) to ensure that users can easily navigate through the slider. On desktop, these controls are displayed on `hover`, allowing for intuitive item selection.\n\n### ❌ Don'ts\n\n* Don't exaggerate the number of items according to the item's width. You can combine it, providing an alternate navigation path like a `See More` button to a collection. Also, make sure to check how they look on different screens.\n\n---\n\n## Related components\n\n* *  \n ### Apple Magic Mouse \n Original price:$999Price:$950.04 \n *  \n ### 4k Philips Monitor 27” \n Original price:$490Price:$420 \n *  \n ### Echo Dot Smart Speaker \n Original price:$310Price:$280 \n *  \n ### Aedle VK-1 L Headphone \n Original price:$150Price:$130 \n *  \n ### Oculus VR Headset \n Original price:$344Price:$315 \n *  \n ### Apple AirPods Pro \n Original price:$249Price:$229 \nProduct Shelf \nDisplays a list of products to be used as a section on the store. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/organisms-product-shelf)\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/molecules/carousel.mdx)\n\n[Card« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-card)[CartItemNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-cart-item)\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/molecules-carousel/docs/guides/faststore/molecules-carousel%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23examples)\n\n[Default](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23default)[Infinite Scroll Mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23infinite-scroll-mode)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23design-tokens)\n\n[Track](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23track)[Item](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23item)[Controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23controls)[Bullets](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23bullets)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23data-attributes)\n\n[Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23use-cases)\n\n[Using the ProductCard component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23using-the-productcard-component)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23props)\n\n[Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23best-practices)\n\n[✅ Do's](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23-dos)[❌ Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23-donts)\n\n[Related components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%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/molecules/carousel.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-carousel/docs/guides/faststore/molecules-carousel%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23examples)\n\n[Default](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23default)[Infinite Scroll Mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23infinite-scroll-mode)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23design-tokens)\n\n[Track](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23track)[Item](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23item)[Controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23controls)[Bullets](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23bullets)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23data-attributes)\n\n[Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23use-cases)\n\n[Using the ProductCard component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23using-the-productcard-component)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23props)\n\n[Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23best-practices)\n\n[✅ Do's](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23-dos)[❌ Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23-donts)\n\n[Related components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%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=)"
}
] |
doc_20fece92
|
[
{
"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 working with schemas in the profile system 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/working-with-schemas-in-the-profile-system/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/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/working-with-schemas-in-the-profile-system/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/working-with-schemas-in-the-profile-system/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/working-with-schemas-in-the-profile-system/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/working-with-schemas-in-the-profile-system/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/working-with-schemas-in-the-profile-system/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/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/working-with-schemas-in-the-profile-system/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/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/working-with-schemas-in-the-profile-system/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/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/working-with-schemas-in-the-profile-system/docs/guides/data-protection-plus)\n\n[PII Data Architecture specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/pii-data-architecture-specifications)\n\n[Data residency](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/data-residency)\n\n[Profile System integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/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/working-with-schemas-in-the-profile-system/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/working-with-schemas-in-the-profile-system/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/working-with-schemas-in-the-profile-system/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/working-with-schemas-in-the-profile-system/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/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/working-with-schemas-in-the-profile-system/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/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/working-with-schemas-in-the-profile-system/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/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/working-with-schemas-in-the-profile-system/docs/guides/data-protection-plus)\n\n[PII Data Architecture specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/pii-data-architecture-specifications)\n\n[Data residency](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/data-residency)\n\n[Profile System integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/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/working-with-schemas-in-the-profile-system/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/working-with-schemas-in-the-profile-system/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/working-with-schemas-in-the-profile-system/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/working-with-schemas-in-the-profile-system/docs/guides)\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/data-protection-plus)\n\n[Working with schemas in the Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/working-with-schemas-in-the-profile-system)\n\nWorking with schemas in the Profile System\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\nA JSON Schema defines the structure of data stored in the [Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system). It determines, for example, which fields a profile has and their respective formats. To learn more about JSON Schemas, read the [JSON Schema external documentation](https://read.calvincode.net/reader?url=http://json-schema.org/).\n\nThe following endpoints in the [Profile System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system) allow you to interact with the profile schema:\n\n| Endpoint name | Description |\n| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |\n| GET [Get full schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23get-/api/storage/profile-system/schemas/profileSystem) | Retrieves the full profile schema, including default and custom fields. |\n| GET [Get custom fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23get-/api/storage/profile-system/schemas/profileSystem/custom) | Retrieves custom fields in the profile schema. |\n| PUT [Create or delete custom fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23put-/api/storage/profile-system/schemas/profileSystem/custom) | Allows you to customize fields. Learn more about possible customizations in [Customizing the profile schema](#customizing-the-profile-schema). |\n\n## Customizing the profile schema\n\nUsing the `PUT` [Create or delete custom fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23put-/api/storage/profile-system/schemas/profileSystem/custom) endpoint allows you to customize the schema for the profile entity in the Profile System by:\n\n* [Adding custom fields](#adding-custom-fields)\n* [Defining PII and sensitive custom fields](#defining-pii-and-sensitive-custom-fields)\n* [Configuring TTL](#configuring-ttl)\n* [Deleting custom fields](#deleting-custom-fields)\n* [Restrictions](#restrictions)\n\n> Make sure you check the applicable [Restrictions](#restrictions).\n\n### Adding custom fields\n\nExtend the profile schema with custom fields by making a request to `PUT` [Create or delete custom fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23put-/api/storage/profile-system/schemas/profileSystem/custom), with a request body structured as in the following example.\n\n**Request body example**\n\n`1\n\n{ \n\n2\n\n \"customField1\": { \n\n3\n\n \"type\": [\"string\", \"null\"], \n\n4\n\n \"sensitive\": true, \n\n5\n\n \"pii\": true \n\n6\n\n }, \n\n7\n\n \"customField2\": { \n\n8\n\n \"type\": [\"string\", \"null\"], \n\n9\n\n \"sensitive\": false, \n\n10\n\n \"pii\": false \n\n11\n\n } \n\n12\n\n} \n\n`\n\n> Every time you add new custom properties or edit existing ones, you must pass all custom properties in the request body, or they will be replaced by those present in the most recent request body used. For example, to edit `customField2` later on, you need to include `customField1` in the request body even if it has not changed.\n\n### Defining PII and sensitive custom fields\n\nProperties marked as Personally Identifiable Information (PII) or sensitive are the ones that are masked by default and must be audited when accessed by a user for legal reasons.\n\nSet the `sensitive` and/or `pii` properties as `true` inside the JSON Schema property definition to determine that they must follow this behavior, as exemplified below.\n\n**Request body example - PII and sensitive field**\n\n`1\n\n{ \n\n2\n\n \"document\": { \n\n3\n\n \"type\": \"string\", \n\n4\n\n \"sensitive\": true, \n\n5\n\n \"pii\": true \n\n6\n\n } \n\n7\n\n} \n\n`\n\n### Configuring TTL\n\nThe TTL (Time To Live) property is a value expressed in days used to schedule the deletion of the document in the future. When this time expires, the document is automatically deleted.\n\n**Example**\n\n`1\n\n\"documentTTL\": 1825, \n\n`\n\n### Deleting custom fields\n\nIf you want to delete all custom fields, make a request to `PUT` [Create or delete custom fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23put-/api/storage/profile-system/schemas/profileSystem/custom) with an empty JSON as the request body.\n\nTo delete only one or more fields, but not all, make this request including every custom field in the request body except the ones to be removed.\n\n### Restrictions\n\nThe following restrictions apply when working with custom fields in the profile schema:\n\n* You cannot use `oneOf`, `anyOf`, `allOf,` or `not` [keywords](https://read.calvincode.net/reader?url=https://swagger.io/docs/specification/data-models/oneof-anyof-allof-not/).\n* The schema is valid per account.\n* You cannot remove or edit required fields. Custom fields cannot be mandatory, so the existing documents will still be compatible with the new schema.\n* Default fields cannot be changed.\n* Custom fields cannot be in `v-indexed` or in `v-unique`.\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/Integration-Guides/data-privacy/working-with-schemas-in-the-profile-system.md)\n\n[Profile System integration« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system//docs/guides/profile-system)[Changes in VTEX features behavior to handle PII dataNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system//docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data)\n\nSee also\n\n[Profile System integrationGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/profile-system)[Data Protection PlusGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/data-protection-plus)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Customizing the profile schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/working-with-schemas-in-the-profile-system%23customizing-the-profile-schema)\n\n[Adding custom fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/working-with-schemas-in-the-profile-system%23adding-custom-fields)[Defining PII and sensitive custom fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/working-with-schemas-in-the-profile-system%23defining-pii-and-sensitive-custom-fields)[Configuring TTL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/working-with-schemas-in-the-profile-system%23configuring-ttl)[Deleting custom fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/working-with-schemas-in-the-profile-system%23deleting-custom-fields)[Restrictions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/working-with-schemas-in-the-profile-system%23restrictions)\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/working-with-schemas-in-the-profile-system.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Customizing the profile schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/working-with-schemas-in-the-profile-system%23customizing-the-profile-schema)\n\n[Adding custom fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/working-with-schemas-in-the-profile-system%23adding-custom-fields)[Defining PII and sensitive custom fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/working-with-schemas-in-the-profile-system%23defining-pii-and-sensitive-custom-fields)[Configuring TTL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/working-with-schemas-in-the-profile-system%23configuring-ttl)[Deleting custom fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/working-with-schemas-in-the-profile-system%23deleting-custom-fields)[Restrictions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/working-with-schemas-in-the-profile-system%23restrictions)\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_9a01e746
|
[
{
"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 simulate a shopping cart 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/simulate-a-shopping-cart/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/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/simulate-a-shopping-cart/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/simulate-a-shopping-cart/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/simulate-a-shopping-cart/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/simulate-a-shopping-cart/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/simulate-a-shopping-cart/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/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/simulate-a-shopping-cart/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/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/simulate-a-shopping-cart/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/simulate-a-shopping-cart/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/simulate-a-shopping-cart/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/simulate-a-shopping-cart/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/simulate-a-shopping-cart/docs/guides/remove-all-personal-data)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/add-cart-items)\n\n[Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/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/simulate-a-shopping-cart/docs/guides/change-price)\n\n[Ignore profile data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/ignore-profile-data)\n\n[Get cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/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/simulate-a-shopping-cart/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/simulate-a-shopping-cart/docs/guides/add-service-to-the-cart)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/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/simulate-a-shopping-cart/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/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/simulate-a-shopping-cart/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/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/simulate-a-shopping-cart/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/simulate-a-shopping-cart/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/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/simulate-a-shopping-cart/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/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/simulate-a-shopping-cart/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/simulate-a-shopping-cart/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/simulate-a-shopping-cart/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/simulate-a-shopping-cart/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/simulate-a-shopping-cart/docs/guides/remove-all-personal-data)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/add-cart-items)\n\n[Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/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/simulate-a-shopping-cart/docs/guides/change-price)\n\n[Ignore profile data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/ignore-profile-data)\n\n[Get cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/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/simulate-a-shopping-cart/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/simulate-a-shopping-cart/docs/guides/add-service-to-the-cart)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/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/simulate-a-shopping-cart/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/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/simulate-a-shopping-cart/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/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/simulate-a-shopping-cart/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/simulate-a-shopping-cart/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/checkout-api-overview)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/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/simulate-a-shopping-cart/docs/guides/simulate-a-shopping-cart)\n\nSimulate a shopping cart\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 the process of simulating a shopping cart at Checkout.\n\n## Simulating a shopping cart\n\nThe first step is to send the parameters you want to be in the cart. This can be done via the [Cart Simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/cartsimulation) endpoint's request body.\n\nSee a request body example below:\n\n`1\n\n{ \n\n2\n\n \"items\": [ \n\n3\n\n { \n\n4\n\n \"id\": \"1\", \n\n5\n\n \"quantity\": 1, \n\n6\n\n \"seller\": \"1\" \n\n7\n\n } \n\n8\n\n ], \n\n9\n\n \"country\": \"BRA\" \n\n10\n\n} \n\n`\n\n> ️ The fields `id`, `quantity`, `seller`, and `country` are just examples of content that you can simulate in your cart. You can add more fields to the request as per your need. Access the [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) overview to check the available fields.\n\nAfter sending the request, the endpoint will return the response body containing the shopping cart information, as shown in the example below:\n\n`1\n\n\"items\": [ \n\n2\n\n { \n\n3\n\n \"id\": \"1\", \n\n4\n\n \"requestIndex\": 0, \n\n5\n\n \"quantity\": 1, \n\n6\n\n \"seller\": \"1\", \n\n7\n\n \"sellerChain\": [ \n\n8\n\n \"1\" \n\n9\n\n ], \n\n10\n\n \"tax\": 0, \n\n11\n\n \"priceValidUntil\": \"2023-09-28T11:53:03Z\", \n\n12\n\n \"price\": 9999, \n\n13\n\n \"listPrice\": 13499, \n\n14\n\n \"rewardValue\": 0, \n\n15\n\n \"sellingPrice\": 2999700, \n\n16\n\n \"offerings\": [], \n\n17\n\n \"priceTags\": [], \n\n18\n\n \"measurementUnit\": \"un\", \n\n19\n\n \"unitMultiplier\": 300.0000, \n\n20\n\n \"parentItemIndex\": null, \n\n21\n\n \"parentAssemblyBinding\": null, \n\n22\n\n \"availability\": \"available\", \n\n23\n\n \"catalogProvider\": \"vrn:vtex.catalog-api-proxy:-:lojadobreno:master:/proxy/authenticated/catalog/pvt/sku/stockkeepingunitbyid/1\", \n\n24\n\n \"priceDefinition\": { \n\n25\n\n \"calculatedSellingPrice\": 2999700, \n\n26\n\n \"total\": 2999700, \n\n27\n\n \"sellingPrices\": [ \n\n28\n\n { \n\n29\n\n \"value\": 2999700, \n\n30\n\n \"quantity\": 1 \n\n31\n\n } \n\n32\n\n ] \n\n33\n\n } \n\n34\n\n } \n\n35\n\n ], \n\n36\n\n ... \n\n`\n\n## Error codes\n\nThe following errors may appear as a message in the response body.\n\n### 200 - OK\n\nDespite the code `200` (which indicates the success of the request), if the item `id` sent is incorrect or unavailable, the following message will appear.\n\n* **Message error example (code ORD027)**: `\"Item 5550 não encontrado ou indisponível\"` (_item 5550 not found or unavailable_).\n\n`1\n\n\"messages\": [ \n\n2\n\n { \n\n3\n\n \"code\": \"ORD027\", \n\n4\n\n \"text\": \"Item 5550 não encontrado ou indisponível\", \n\n5\n\n \"status\": \"error\", \n\n6\n\n \"fields\": { \n\n7\n\n \"id\": \"5550\" \n\n8\n\n } \n\n9\n\n } \n\n10\n\n ] \n\n`\n\n### 400 - Bad Request\n\nThe Bad Request error appears for several reasons, such as when a mandatory field was not filled in correctly (eg seller) or the item quantity was not specified. In addition to the 400 error code, an additional code will be shown to indicate the type of error.\n\n* **Message error example (code ORD005)**: `\"O campo Id do item é obrigatório\"` (_item ID field is required_).\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"ORD005\", \n\n5\n\n \"message\": \"O campo Id do item é obrigatório\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"5ac2e42e-0967-43b3-b0b4-dcbc6da118b1\" \n\n9\n\n} \n\n`\n\n* **Message error example (code CHK0024)**: `\"Id de vendedor de item inválido\"` (_invalid item seller id_).\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"CHK0024\", \n\n5\n\n \"message\": \"Id de vendedor de item inválido\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"7adbc4af-32c8-4365-9f7e-c40ffc9ccf5a\" \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/simulate-a-shopping-cart.md)\n\n[Shopping Cart« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart//docs/guides/shopping-cart-section-api-quick-start-guides)[Get current or create a new cartNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart//docs/guides/create-a-new-cart)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Simulating a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/simulate-a-shopping-cart%23simulating-a-shopping-cart)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/simulate-a-shopping-cart%23error-codes)\n\n[200 - OK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/simulate-a-shopping-cart%23200-ok)[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/simulate-a-shopping-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/simulate-a-shopping-cart%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/simulate-a-shopping-cart.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Simulating a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/simulate-a-shopping-cart%23simulating-a-shopping-cart)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/simulate-a-shopping-cart%23error-codes)\n\n[200 - OK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/simulate-a-shopping-cart%23200-ok)[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/simulate-a-shopping-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/simulate-a-shopping-cart%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_6c5e51a1
|
[
{
"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 skuselector 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/SKUSelector/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/SKUSelector/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/SKUSelector/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/SKUSelector/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/SKUSelector/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/SKUSelector/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/SKUSelector/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/SKUSelector/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/SKUSelector/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/SKUSelector/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/SKUSelector/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/SKUSelector/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/SKUSelector/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/SKUSelector/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/SKUSelector/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/SKUSelector/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/SKUSelector/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/SKUSelector/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/SKUSelector/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/SKUSelector/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/SKUSelector/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/SKUSelector/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/SKUSelector/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/SKUSelector/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/SKUSelector/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/SKUSelector/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/SKUSelector/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/SKUSelector/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/SKUSelector/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/SKUSelector/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/SKUSelector/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/SKUSelector/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/SKUSelector/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/SKUSelector/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/SKUSelector/docs/vtex-io-apps)\n\nSKU Selector\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 `sku-selector` block is mainly used in Product Details Pages (PDPs) to display all the SKUs available for a product.\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 `sku-selector` block to any child of the `store.product` template (product page). 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+ \"sku-selector\" \n\n9\n\n ] \n\n10\n\n }, \n\n`\n\n1. Then, declare the `sku-selector` block using the props stated in the [Props](#props) table. For example:\n\n`1\n\n \"sku-selector\": { \n\n2\n\n \"props\": { \n\n3\n\n \"hideImpossibleCombinations\": false \n\n4\n\n } \n\n5\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, please refer to [this documentation](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/css-handles%23usecustomclasses). Please note that this is only helpful if you're using this block as a React component. | undefined |\n| disableUnavailableSelectOptions | boolean | Whether a product variation that leads to an impossible product combination should be displayed with the disabled attribute when displayMode is set to select. By default, all select options are configured without the disabled attribute set based on the type of variation | false |\n| displayMode | enum | Defines how the product variation names will be displayed (it does not apply to product variation images). Possible values are: default (displays all variation names), select (only displays the selected variation name), or slider (displays all variation names in a slider when the number of available options is greater than the value defined in the sliderDisplayThreshold prop). Please note that this prop is _responsive_, so you can declare an object as its value, specifying a value for each breakpoint (desktop and mobile). | default |\n| hideImpossibleCombinations | boolean | Defines whether a product variation should be clickable (true) or (false). The variation will not be displayed if true. If false, the variation will be displayed with less opacity. For example, there are two colors for a pair of sneakers: pink and white. If the pink sneaker is only available in one size, the other sizes will not be displayed (true). | true |\n| sortVariationsByLabel | boolean | Defines if the variations are to be sorted in alphabetical order. | false |\n| imageHeight | number | object | Height (in px) of the product thumbnail image. You can declare an object as its value in case you want to define a height for each device (desktop and mobile). |\n| imageWidth | number | object | Width (in px) of the product thumbnail image. You can declare an object as its value in case you want to define a width for each device (desktop and mobile). |\n| initialSelection | enum | Controls the user's initial selection for available variations when the product page is fully loaded. Possible values are: complete (selects the first available SKU variation values), image (selects the first available image variation), or empty (no variations will be selected when the page is loaded). | complete |\n| maxItems | number | The maximum number of variation items to be displayed in the SKU selector before the See more button. The button will always be displayed 2 items before the number set in maxItems. | 10 |\n| showValueForVariation | enum | Displays a value for the selected variation. This prop replaces the former showValueNameForImageVariation (deprecated). Possible values are: none (no values are displayed when the variation is selected), image (displays only the image value for the selected variation, if any), or all (all variation values are displayed). | none |\n| sliderArrowSize | number | Controls the size (height and width) in pixels of the navigation arrows rendered when displayMode is set as slider. | 12 |\n| sliderDisplayThreshold | number | The minimum number of product variation names that should be displayed using slider display mode. This prop only works properly when displayMode is set as slider. | 3 |\n| sliderItemsPerPage | object | Controls how many slides should be displayed on each type of device when displayMode is set as slider. There is more information regarding this prop structure below this table. | {desktop: 3, tablet: 2, phone: 1} |\n| showVariationsErrorMessage | boolean | Whether an error message should be displayed when the BuyButton is clicked but no available variation was selected (true) or (false). | true |\n| showVariationsLabels | enum | Where variation names should be displayed. Possible values are: none (does not display the variation names). Replaces the previous false behavior), variation (displays the variation name as a header of the items. Replaces the previous true behavior), itemValue (displays the variation name before each item's value), and variationAndItemValue (behaves as variation and itemValue at the same time). | variation |\n| thumbnailImage | string | The first image to be displayed. This prop value must be the same text string defined in the desired product image imageLabel field (from the Catalog module). If you use this prop and no image declaring the same text string in its imageLabel field is found, any product image will be randomly rendered. To apply the thumbnailImage configuration, please read the [Configuring custom images for the SKU Selector documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector) | undefined |\n| variationsSpacing | number | Defines the margin-bottom size to be applied in the rendered product variations. Possible values range from 0 to 11 (the prop value is not in px; every value represents a tachyon class). | 7 |\n| visibility | enum | Defines the scenarios in which the SKU selector should be displayed. Possible values are: always (it will always be displayed, even if the product has only one SKU option) or more-than-one (the SKU selector is only displayed when the product has more than one SKU option). | always |\n| visibleVariations | array | Specifies which product variations should be displayed on the product details page. Please note that no variations will be displayed if you declare a name that does not represent a real product variation or an empty array. There is more information regarding this prop structure below this table. | undefined |\n\n* **`visibleVariations` props**\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | ----------------------- | ------------- |\n| name | string | Product variation name. | undefined |\n\n* **`sliderItemsPerPage` props**\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | ------------------------------------------------------------------------------------------ | ------------- |\n| desktop | number | The number of slides to be displayed on desktop devices when displayMode is set as slider. | 3 |\n| tablet | number | The number of slides to be displayed on tablet devices when displayMode is set as slider. | 2 |\n| phone | number | The number of slides to be displayed on phone devices when displayMode is set as slider. | 1 |\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| frameAround |\n| seeMoreButton |\n| skuSelectorContainer |\n| skuSelectorInternalBox |\n| skuSelectorItemImageValue |\n| skuSelectorItemImage |\n| skuSelectorItemTextValue |\n| skuSelectorItem |\n| skuSelectorNameContainer |\n| skuSelectorNameSeparator |\n| skuSelectorName |\n| skuSelectorOptionsList |\n| skuSelectorSelectorImageValue |\n| skuSelectorSubcontainer |\n| skuSelectorTextContainer |\n| valueWrapper |\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/SKUSelector/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/SKUSelector/docs/apps/vtex.store-components/SKUSelector%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/SKUSelector/docs/apps/vtex.store-components/SKUSelector%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/SKUSelector/docs/apps/vtex.store-components/SKUSelector%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_6f6508ab
|
[
{
"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 seller integration vtex marketplace operation 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-seller-integration-vtex-marketplace-operation/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/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-seller-integration-vtex-marketplace-operation/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-seller-integration-vtex-marketplace-operation/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-seller-integration-vtex-marketplace-operation/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-seller-integration-vtex-marketplace-operation/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-seller-integration-vtex-marketplace-operation/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/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-seller-integration-vtex-marketplace-operation/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/external-seller-integration-guide)\n\n[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/external-seller-integration-architecture)\n\n[Store setup for VTEX Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/external-seller-integration-vtex-marketplace-setup)\n\n[External seller processing payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/external-seller-processing-payments)\n\n[External seller connector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/external-seller-integration-connector)\n\n[Catalog management for VTEX Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/external-seller-integration-vtex-marketplace-operation)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/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-seller-integration-vtex-marketplace-operation/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/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-seller-integration-vtex-marketplace-operation/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-seller-integration-vtex-marketplace-operation/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/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-seller-integration-vtex-marketplace-operation/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/external-seller-integration-guide)\n\n[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/external-seller-integration-architecture)\n\n[Store setup for VTEX Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/external-seller-integration-vtex-marketplace-setup)\n\n[External seller processing payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/external-seller-processing-payments)\n\n[External seller connector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/external-seller-integration-connector)\n\n[Catalog management for VTEX Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/external-seller-integration-vtex-marketplace-operation)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/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-seller-integration-vtex-marketplace-operation/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/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-seller-integration-vtex-marketplace-operation/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-seller-integration-vtex-marketplace-operation/docs/guides)\n\nIntegration Guides\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/external-seller-integration-guide)\n\n[Catalog management for VTEX Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/external-seller-integration-vtex-marketplace-operation)\n\nCatalog management for VTEX Marketplace\n\nAfter you build the integration flow explained in the last section of this guide, there is a final configuration step before the marketplace is ready to start receiving SKU offers from the external seller.\n\n## Map the brands, categories, and specifications\n\nFor the external seller's offers to integrate into a VTEX marketplace, its brands, categories, and specifications need to be properly mapped in the marketplace. This is necessary for the marketplace to know where to fit each SKU in its catalog structure.\n\nThe action is performed in the marketplace's management panel. Read the article [Mapping categories, brands, and specifications for the marketplace](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/mapping-categories-and-brands-for-the-marketplace) for more information on how to do it.\n\n## Approve the seller's SKU offers\n\nThe sellers' SKUs are not added directly to the marketplace's catalog. Instead, there is an approval step for each new SKU, which is done by the marketplace in its management panel.\n\nNew SKUs are sent by the seller as suggestions, as explained in the section [External Seller Connector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector). Each suggestion is approved or denied by the marketplace in the Received SKUs panel, which can be done individually or in bulk.\n\nTo learn more about how to manage suggestions, read our documentation about [Cataloging received SKUs](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/manual-sku-cataloging--tutorials%5F396).\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\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-seller-integration-guide/external-seller-integration-vtex-marketplace-operation.md)\n\n[External seller connector« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation//docs/guides/external-seller-integration-connector)[Gift CardNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation//docs/guides/gift-card-integration-guide)\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Map the brands, categories, and specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/external-seller-integration-vtex-marketplace-operation%23map-the-brands-categories-and-specifications)\n\n[Approve the seller's SKU offers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/external-seller-integration-vtex-marketplace-operation%23approve-the-sellers-sku-offers)\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-seller-integration-guide/external-seller-integration-vtex-marketplace-operation.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Map the brands, categories, and specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/external-seller-integration-vtex-marketplace-operation%23map-the-brands-categories-and-specifications)\n\n[Approve the seller's SKU offers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-operation/docs/guides/external-seller-integration-vtex-marketplace-operation%23approve-the-sellers-sku-offers)\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_fe498831
|
[
{
"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 delivery promise 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/delivery-promise-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/delivery-promise-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/delivery-promise-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/delivery-promise-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/delivery-promise-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/delivery-promise-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/delivery-promise-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/delivery-promise-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/delivery-promise-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-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/delivery-promise-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-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/delivery-promise-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/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/delivery-promise-overview/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/delivery-promise-overview/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/delivery-promise-overview/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/delivery-promise-overview/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/delivery-promise-overview/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/delivery-promise-overview/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/delivery-promise-overview/docs/guides/faststore/delivery-promise-implementation)\n\n[Understanding Delivery Promise operation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides/faststore/delivery-promise-overview)\n\n[Working with Delivery Promise components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides/faststore/delivery-promise-components)\n\n[Implementing Live Shopping for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/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/delivery-promise-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-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/delivery-promise-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/delivery-promise-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/delivery-promise-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/delivery-promise-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-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/delivery-promise-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/delivery-promise-overview/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-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/delivery-promise-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/delivery-promise-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-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/delivery-promise-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-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/delivery-promise-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/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/delivery-promise-overview/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/delivery-promise-overview/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/delivery-promise-overview/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/delivery-promise-overview/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/delivery-promise-overview/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/delivery-promise-overview/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/delivery-promise-overview/docs/guides/faststore/delivery-promise-implementation)\n\n[Understanding Delivery Promise operation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides/faststore/delivery-promise-overview)\n\n[Working with Delivery Promise components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides/faststore/delivery-promise-components)\n\n[Implementing Live Shopping for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/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/delivery-promise-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-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/delivery-promise-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/delivery-promise-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/delivery-promise-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/delivery-promise-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-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/delivery-promise-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/delivery-promise-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/delivery-promise-overview/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides/faststore)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides/faststore/storefront-features-overview)\n\n[Implementing Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides/faststore/delivery-promise-implementation)\n\nUnderstanding Delivery Promise operation\n\n> This feature is in closed beta, meaning only selected customers can access it. If you're interested in implementing it, please contact our [Support](https://read.calvincode.net/reader?url=https://support.vtex.com/hc/en-us) team.\n\nThis guide explains how Delivery Promise operates, covering the following:\n\n* [Hooks](#hooks): Discover the hooks used to manage user location, fulfillment options, and Delivery Promise workflows.\n* [Filter options](#filter-options): Learn how shoppers can filter products by delivery or pickup methods.\n* [Location priority](#location-priority): Understand the order and logic used to determine the shopper's location for accurate delivery estimates.\n\n> To learn how to implement Delivery Promise in your store, see the guide [Implementing Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation).\n\n## Hooks\n\nThis feature introduces the following hooks as part of the regionalization and location workflow:\n\n* `useGeoLocation`: Uses the browser's geolocation API or other client-side methods to auto-detect the user's location when not provided.\n* `useRegion`: Accesses or updates the user's region information, such as a postal code or location and manages region validation flows.\n* `useRegionModal`: Handles modal display logic for region selection, especially when the location input is mandatory.\n* [useDeliveryPromise\\_unstable](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-experimental-exports-hooks-and-components%23list-of-hooks-and-components): Manages all logic for querying, displaying, and updating delivery availability filters and states.\n* [deliveryPromiseStore\\_unstable](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-experimental-exports-hooks-and-components%23list-of-hooks-and-components): Stores and retrieves Delivery Promise data (pickup points, default/global selection, simulation state).\n\n## Filter options\n\nDelivery Promise offers shoppers two product filtering options:\n\n* [Global filters](#global-filters): Apply to all store navigation.\n* [Product List Page (PLP) or search page](#plp-or-search-page-filters): Apply only to the current page the shopper is viewing.\n\n> Learn more about filter usage and user flows on the [Delivery Promise Figma Community](https://read.calvincode.net/reader?url=https://www.figma.com/community/file/1545494767147168145/delivery-promise-by-vtex) page.\n\n### Global filters\n\nGlobal filters remain active across all user navigation and are applied to all product searches until they are changed or cleared.\n\nShoppers can filter available products globally using the **Filter by store** option, which displays only products available for pickup at a specific store. This filter shows all available pickup points within a 50-km radius, as configured in Checkout. The number of pickup points displayed is unlimited.\n\n\n\n### PLP or search page filters\n\nOn PLPs or search pages, shoppers have the following options for applying filters: [Delivery Methods](#delivery-methods-filters), [Delivery Option](#delivery-option-filters), and [Availability](#availability).\n\n> To edit the filter labels, follow the instructions in [Managing filters and badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation).\n\n#### Delivery Methods\n\nThis filter displays available products according to the shopper's location, allowing them to filter using the following options:\n\n\n\n| **Filter option** | **Description** |\n| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **All delivery methods** | Displays products that match all active delivery method filters: **Shipping to**, **Pickup anywhere**, **Pickup at**, and **Pickup nearby**. |\n| **Shipping to** | Displays products that can be shipped to the shopper's specified location. |\n| **Pickup anywhere** | Displays products available for pickup at any participating store within the merchant's network, rather than restricting results to a selected pickup location or geographic proximity. This is often used by B2B stores, and this filter is deactivated in Headless CMS by default. |\n| **Pickup at** | Displays the store specified in the global pickup point filter or the one closest to the shopper's location. To change the store set in Pickup at {storeName}, the shopper can click on it and select a new store in the slideover that opens. This slideover shows all available pickup points within a 50-km radius, as configured in Checkout. |\n| **Pickup nearby** | Displays products available for pickup at the shopper's nearby stores. This filter considers up to 40 pickup points within 10 km of the shopper's location. |\n\n#### Delivery Option\n\nThis filter allows shoppers to refine search results based on the type of delivery or pickup method available for each item, helping to find products that match the shopper's preferred fulfillment method.\n\n\n\nTo create, configure, and manage delivery options in the VTEX Admin, see the instructions in the [Delivery Option (Beta)](https://read.calvincode.net/reader?url=https://newhelp.vtex.com/docs/tutorials/delivery-options-beta) guide.\n\n> While following the instructions to [create the delivery options](https://read.calvincode.net/reader?url=https://newhelp.vtex.com/docs/tutorials/delivery-options-beta%23creating-delivery-options), make sure to enable the option **Use option as a filter on the store product**. This will allow shoppers to filter products by the delivery option using [Intelligent Search filters](https://read.calvincode.net/reader?url=https://newhelp.vtex.com/en/tutorial/filters--k24mQQa9SjmhNWSwdqIMB).\n\n#### Availability (In-stock filter)\n\nThis filter helps shoppers refine product results based on whether items are available for purchase and fulfillment, preventing the display of products they can't immediately buy in their preferred fulfillment method and narrowing results to only what’s actually in stock.\n\n\n\nThe Availability filter is disabled by default in the Headless CMS. This filter is helpful for stores where the `discovery.config.js` file has `hideUnavailableItems` set to `false`. Otherwise, when this setting is `true`, unavailable products are already hidden by default, so the Availability filter would have no functionality in this scenario.\n\nTo enable this filter in your store, follow the instructions in [Enabling the Availability filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation%23enabling-the-availability-filter).\n\n## Badges\n\nWhen Delivery Promise data is available, the `ProductCard` automatically displays badges so shoppers can quickly see shipping and pickup availability for their location.\n\n> An error occurred while loading the image https://vtexhelp.vtexassets.com/assets/docs/src/dp-badges\\_\\_\\_4b6a40b957e4eb45da5a854e676dce77.png\n\nIn the following table, see the available types of badges:\n\n| Badge label | Description |\n| -------------------------------------------------- | -------------------------------------------------------------------------- |\n| Available for shipping or Unavailable for shipping | Indicates whether the product can be shipped to the shopper's postal code. |\n| Available for pickup or Unavailable for pickup | Indicates that the product can be collected from a nearby pickup point. |\n| No badges available | The product is out of stock. Delivery and pickup are unavailable. |\n\n> To edit the badge labels or disable the badges, follow the instructions in [Managing filters and badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-implementation).\n\n## Understanding location priority\n\nTo provide accurate Delivery Promise estimates, FastStore projects determine the user's location based on the following priority:\n\n1. **Logged-in user's address:** If the user is logged in and has a saved address, this information is used.\n2. **User-provided location:** If the user is logged in but doesn't have a saved address, or isn't logged in but provides their location (like a postal code), this data is used.\n3. **Default postal code:** If the user hasn't provided a location, isn't logged in, or has no saved address, we check if the merchant has configured a default postal code for all buyers. Learn how to do so in [Defining a default postal code](#step-4-optional-defining-a-default-postal-code).\n4. **No postal code (optional):** If no postal code is provided and not required, products are displayed without using Delivery Promise.\n5. **No postal code (required):** If no postal code is provided when required, a modal is displayed that the buyer cannot close until a postal code is entered. To make the postal code required, open your `discovery.config.js` file and change the `mandatory` field in the `deliveryPromise` object to `true`, as shown in the [Default settings](#default-settings) section.\n\nTo better understand how this flow works, see the following diagram:\n\nYes\n\nNo\n\nYes\n\nNo\n\nYes\n\nNo\n\nYes\n\nNo\n\nYes\n\nNo\n\nIs the user logged in?\n\nLogged-in user's address available?\n\nLocation provided?\n\nUse the logged-in user's address\n\nUse the provided location\n\nDefault postal code configured?\n\nUse the default postal code\n\nPostal code mandatory?\n\nDisplay mandatory postal code modal\n\nUser inputs postal code\n\nUse the provided postal code\n\nDisplay products without using Delivery Promise\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/features/delivery-promise/overview.mdx)\n\n[Implementing Delivery Promise« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides/faststore/delivery-promise-implementation)[Working with Delivery Promise componentsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides/faststore/delivery-promise-components)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Hooks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides/faststore/delivery-promise-overview%23hooks)\n\n[Filter options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides/faststore/delivery-promise-overview%23filter-options)\n\n[Global filters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides/faststore/delivery-promise-overview%23global-filters)[PLP or search page filters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides/faststore/delivery-promise-overview%23plp-or-search-page-filters)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides/faststore/delivery-promise-overview%23badges)\n\n[Understanding location priority](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides/faststore/delivery-promise-overview%23understanding-location-priority)\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/features/delivery-promise/overview.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Hooks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides/faststore/delivery-promise-overview%23hooks)\n\n[Filter options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides/faststore/delivery-promise-overview%23filter-options)\n\n[Global filters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides/faststore/delivery-promise-overview%23global-filters)[PLP or search page filters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides/faststore/delivery-promise-overview%23plp-or-search-page-filters)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides/faststore/delivery-promise-overview%23badges)\n\n[Understanding location priority](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview/docs/guides/faststore/delivery-promise-overview%23understanding-location-priority)\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_29deea87
|
[
{
"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 search history 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-search-history/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-search-history/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-search-history/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-search-history/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-search-history/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-search-history/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-search-history/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-search-history/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-search-history/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/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-search-history/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/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-search-history/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/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-search-history/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-search-history/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-search-history/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-search-history/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/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-search-history/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-search-history/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/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-search-history/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-search-history/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/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-search-history/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/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-search-history/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/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-search-history/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-search-history/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-search-history/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-search-history/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/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-search-history/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-search-history/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-search-history/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/components-index)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-overview)\n\nSearchHistory\n\nShows the latest terms searched by a user.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/SearchHistory)\n\nResponsible for showing the latest terms searched by a user. This component is part of the [Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search) feature.\n\nExample\n\nCode\n\nHistory\n\nClear History\n\n1. [Headphone](#)\n2. [Audio & Video](#)\n3. [mh-7000](#)\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { SearchHistory, SearchHistoryTerm } 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/SearchHistory/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## Other Icons\n\nExample\n\nCode\n\nHistory\n\nClear History\n\n1. [Headphone](#)\n2. [Audio & Video](#)\n\n---\n\n## Design tokens\n\n| Local token | Default value/Global token linked |\n| ---------------------------------------- | -------------------------------------- |\n| \\--fs-search-history-padding-top | var(--fs-spacing-2) |\n| \\--fs-search-history-padding-right | var(--fs-spacing-3) |\n| \\--fs-search-history-padding-bottom | var(--fs-search-history-padding-top) |\n| \\--fs-search-history-padding-left | var(--fs-search-history-padding-right) |\n| \\--fs-search-history-transition-property | var(--fs-transition-property) |\n| \\--fs-search-history-transition-function | var(--fs-transition-function) |\n| \\--fs-search-history-transition-timing | var(--fs-transition-timing) |\n\n### Design tokens: Header\n\n| Local token | Default value/Global token linked |\n| ------------------------------------------ | ------------------------------------------- |\n| \\--fs-search-history-header-padding-top | var(--fs-spacing-1) |\n| \\--fs-search-history-header-padding-bottom | var(--fs-search-history-header-padding-top) |\n\n### Design tokens: Title\n\n| Local token | Default value/Global token linked |\n| -------------------------------------- | --------------------------------- |\n| \\--fs-search-history-title-size | var(--fs-text-size-lead) |\n| \\--fs-search-history-title-line-height | 1.5 |\n\n### Design tokens: Item\n\n| Local token | Default value/Global token linked |\n| ----------------------------------------- | ---------------------------------- |\n| \\--fs-search-history-item-column-gap | var(--fs-spacing-1) |\n| \\--fs-search-history-item-text-size | var(--fs-text-size-2) |\n| \\--fs-search-history-item-line-height | 1.25 |\n| \\--fs-search-history-item-bkg-color-hover | var(--fs-color-tertiary-bkg-hover) |\n\n### Design tokens: Icon\n\n| Local token | Default value/Global token linked |\n| ------------------------------------ | --------------------------------- |\n| \\--fs-search-history-item-icon-color | var(--fs-color-neutral-4) |\n| \\--fs-search-history-item-icon-size | 1.125rem |\n\n---\n\n## Data attributes\n\nYou can target and override `SearchHistory` styles using the following data attributes:\n\n`data-fs-search-history`\n\n`data-fs-search-history-header`\n\n`data-fs-search-history-title`\n\n`data-fs-search-history-item`\n\n`data-fs-search-history-item-link`\n\n`data-fs-search-history-item-icon`\n\n---\n\n## Props\n\n### SearchHistory\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-search-history |\n| **title** | string | Title attribute for the <section> tag rendered by this component. | History |\n| **clearLabel** | string | Defines the text displayed in clear history button. | Clear History |\n| **onClear** | () => void | Event handler for click on clear history button. | |\n\n### SearchHistoryTerm\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-search-history-term | | | | | | | |\n| **value\\*** | string | Defines the text displayed in history term item. | | | | | | | | |\n| **linkProps** | Partial<LinkProps<LinkElementType>> | Props for the link from term component. | | | | | | | | |\n| **icon** | string \\| number | false | true | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | A React component that will be rendered as an icon. | <Icon name=\"ClockClockwise\" width={18} height={18} /> |\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/molecules/search-history.mdx)\n\n[SearchDropdown« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-dropdown)[SearchInputFieldNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-input-field)\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/molecules-search-history/docs/guides/faststore/molecules-search-history%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-history%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-history%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-history%23examples)\n\n[Other Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-history%23other-icons)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-history%23design-tokens)\n\n[Design tokens: Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-history%23design-tokens-header)[Design tokens: Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-history%23design-tokens-title)[Design tokens: Item](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-history%23design-tokens-item)[Design tokens: Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-history%23design-tokens-icon)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-history%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-history%23props)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-history%23searchhistory)[SearchHistoryTerm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-history%23searchhistoryterm)\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/search-history.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-search-history/docs/guides/faststore/molecules-search-history%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-history%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-history%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-history%23examples)\n\n[Other Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-history%23other-icons)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-history%23design-tokens)\n\n[Design tokens: Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-history%23design-tokens-header)[Design tokens: Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-history%23design-tokens-title)[Design tokens: Item](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-history%23design-tokens-item)[Design tokens: Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-history%23design-tokens-icon)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-history%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-history%23props)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-history%23searchhistory)[SearchHistoryTerm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-history/docs/guides/faststore/molecules-search-history%23searchhistoryterm)\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_45032528
|
[
{
"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 orderform fields 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/orderform-fields/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/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/orderform-fields/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/orderform-fields/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/orderform-fields/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/orderform-fields/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/orderform-fields/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/updates/release-notes)\n\norderForm\n\nThe `orderForm` is the main object processed by VTEX checkout, and one of the most important data structures in the architecture of every VTEX store.\n\nIt stores a lot of contextual information about the order which is important to the processing of the order: order items, client's personal data, delivery address, freight information, etc.\n\nUsing VTEX APIs this information can be accessed, processed, and even changed on certain occasions.\n\nVTEX's Checkout API is one of the main interfaces interacting with the `orderForm` object. Most of its operations will return the `orderForm` or part of it.\n\nThe object's basic structure is:\n\n`1\n\n{ \n\n2\n\n \"allowManualPrice\": boolean, \n\n3\n\n \"canEditData\": boolean, \n\n4\n\n \"clientPreferencesData\": {}, \n\n5\n\n \"clientProfileData\": {}, \n\n6\n\n \"commercialConditionData\": {}, \n\n7\n\n \"customData\": {}, \n\n8\n\n \"giftRegistryData\": {}, \n\n9\n\n \"hooksData\": {}, \n\n10\n\n \"ignoreProfileData\": boolean, \n\n11\n\n \"isCheckedIn\": boolean, \n\n12\n\n \"itemMetadata\": {}, \n\n13\n\n \"items\": {}, \n\n14\n\n \"itemsOrdination\": {}, \n\n15\n\n \"loggedIn\": boolean, \n\n16\n\n \"marketingData\": {}, \n\n17\n\n \"messages\": [], \n\n18\n\n \"openTextField\": {}, \n\n19\n\n \"orderFormId\": string, \n\n20\n\n \"paymentData\": {}, \n\n21\n\n \"ratesAndBenefitsData\": {}, \n\n22\n\n \"salesChannel\": \"1\", \n\n23\n\n \"selectableGifts\": {}, \n\n24\n\n \"sellers\": {}, \n\n25\n\n \"shippingData\": {}, \n\n26\n\n \"storeId\": {}, \n\n27\n\n \"storePreferencesData\": {}, \n\n28\n\n \"totalizers\": {}, \n\n29\n\n \"userProfileId\": {}, \n\n30\n\n \"userType\": {}, \n\n31\n\n \"value\": number \n\n32\n\n} \n\n`\n\nThis structure is made of many **sections**.\n\n> Any properties representing monetary values will have **cents** as their units. (e.g. `10390` means **R$103,90** in Brazilian stores). In the following menu, you can find details regarding these sections.\n\n## `OrderForm` Sections\n\n* [clientPreferencesData](#clientpreferencesdata)\n* [clientProfileData](#clientprofiledata)\n* [commercialConditionData](#commercialconditiondata)\n* [customData](#customdata)\n* [giftRegistryData](#giftregistrydata)\n* [hooksData](#hooksdata)\n* [items](#items) \n * [items\\[\\].priceDefinition](#itemspricedefinition)\n* [invoiceData](#invoicedata)\n* [itemsOrdination](#itemsordination)\n* [marketingData](#marketingdata)\n* [messages](#messages)\n* [openTextField](#opentextfield)\n* [paymentData](#paymentdata)\n* [ratesAndBenefitsData](#ratesandbenefitsdata)\n* [selectableGifts](#selectablegifts)\n* [sellers](#sellers)\n* [shippingData](#shippingdata)\n* [storeId](#storeid)\n* [storePreferencesData](#storepreferencesdata)\n* [subscriptionData](#subscriptiondata)\n* [totalizers](#totalizers)\n\n### clientPreferencesData\n\nObject containing preferences from the client who placed the order.\n\n**Example:**\n\n`1\n\n{ \n\n2\n\n \"locale\": \"pt-BR\", \n\n3\n\n \"optinNewsLetter\": true \n\n4\n\n} \n\n`\n\n| Field | Type | Description |\n| --------------- | ------- | ----------------------------------------------------------------------------------------------------------------------- |\n| locale | String | Client's locale. Examples: \"pt-BR\" and \"en-US\". The method sendLocale(), from vtex.js, changes the value of this field. |\n| optinNewsLetter | Boolean | true if the client opted to receive newsletters from the store. |\n\n### clientProfileData\n\nObject containing the data of the customer who placed the order.\n\nIf the customer has not yet informed her or his email, much of the data may be empty (`null`).\n\nIf the customer's email has not yet been confirmed, several personal data will be censored, that is, some of its parts will be hidden by asterisks to avoid identification.\n\n**Example:**\n\n`1\n\n{ \n\n2\n\n \"email\": \"customer@mailprovider.com\", \n\n3\n\n \"firstName\": \"Bre******\", \n\n4\n\n \"lastName\": \"Bar******\", \n\n5\n\n \"document\": \"*1*2*5*5*3*\", \n\n6\n\n \"documentType\": \"cpf\", \n\n7\n\n \"phone\": \"******0879\", \n\n8\n\n \"corporateName\": null, \n\n9\n\n \"tradeName\": null, \n\n10\n\n \"corporateDocument\": null, \n\n11\n\n \"stateInscription\": null, \n\n12\n\n \"corporatePhone\": null, \n\n13\n\n \"isCorporate\": false \n\n14\n\n} \n\n`\n\n| Field | Type | Description |\n| ----------------- | ------- | --------------------------------------------------- |\n| email | String | Customer's email. |\n| firstName | String | Customer's first name. |\n| lastName | String | Customer's last name. |\n| document | String | Document number informed by the customer. |\n| documentType | String | Type of the document informed by the customer. |\n| phone | String | Customer's phone number. |\n| corporateName | String | If it's a legal entity, here goes the company name. |\n| tradeName | String | If legal entity, here goes the trade name. |\n| corporateDocument | String | If legal entity, here goes the corporate document. |\n| stateInscription | String | If legal entity, here goes the state inscription. |\n| corporatePhone | String | If legal entity, here goes the company phone. |\n| isCorporate | Boolean | It has the value true if it's a legal entity. |\n\n### commercialConditionData\n\n> This guide is currently being written and published as content becomes available.\n\n### customData\n\nDuring the checkout process, some stores need to include data gathered from the client that is not part of our standard `orderForm` format (e.g. gender, cell phone number, age).\n\nTo do that you will need to create extra fields in the `orderForm` and those will be located inside the `customData` parameter.\n\n**Example:**\n\n`1\n\n\"customData\": { \n\n2\n\n \"attachmentId\": \"customData\", \n\n3\n\n \"customApps\": [ \n\n4\n\n { \n\n5\n\n \"fields\": { \n\n6\n\n \"number\": \"78550693\", \n\n7\n\n \"street\": \"Rua Voluntários da Pátria\", \n\n8\n\n \"complement\": \"Em frente à Torre Citi\", \n\n9\n\n \"name\": \"101 - Delco Autopista\", \n\n10\n\n \"neighborhood\": \"Botafogo\", \n\n11\n\n \"city\": \"Rio de Janeiro\", \n\n12\n\n \"state\": \"RJ\" \n\n13\n\n }, \n\n14\n\n \"id\": \"pickupinfo\", \n\n15\n\n \"major\": 1 \n\n16\n\n }, \n\n17\n\n { \n\n18\n\n \"fields\": { \n\n19\n\n \"deliveryEstimate\": \"30\" \n\n20\n\n }, \n\n21\n\n \"id\": \"deliveryinfo\", \n\n22\n\n \"major\": 1 \n\n23\n\n } \n\n24\n\n ] \n\n25\n\n} \n\n`\n\n| Field | Type | Description |\n| ---------- | ------- | ------------------------------------------------------------------ |\n| customApps | Array | Array containing the apps created by the store. |\n| fields | Object | Object that contains the fields created by the store for each app. |\n| id | String | App ID. |\n| major | Integer | App major version. |\n\n### giftRegistryData\n\nObject containing the gift registration list data.\n\n**Example:**\n\n`1\n\n{ \n\n2\n\n \"giftRegistryId\": \"22222\", \n\n3\n\n \"giftRegistryType\": null, \n\n4\n\n \"giftRegistryTypeName\": null, \n\n5\n\n \"addressId\": null, \n\n6\n\n \"description\": \"gift1\" \n\n7\n\n} \n\n`\n\n| Field | Type | Description |\n| -------------------- | ------ | ----------------------------- |\n| giftRegistryId | String | Gift registry ID. |\n| giftRegistryType | String | Gift registry type. |\n| giftRegistryTypeName | String | Gift registration typen name. |\n| addressId | String | Address ID. |\n| description | String | Gift registry description. |\n\n### hooksData\n\n> This guide is currently being written and published as content becomes available.\n\n### items\n\nit is an array containing an object describing every item in the buyer's cart.\n\n**Example:**\n\n`1\n\n\"items\": [ \n\n2\n\n { \n\n3\n\n \"uniqueId\": \"3B31329E5DDA4A1A81449DD7466D9575\", \n\n4\n\n \"id\": \"4\", \n\n5\n\n \"productId\": \"3\", \n\n6\n\n \"productRefId\": \"\", \n\n7\n\n \"refId\": null, \n\n8\n\n \"ean\": \"978073487962\", \n\n9\n\n \"name\": \"Mild Hair Cleanser 50 ml\", \n\n10\n\n \"skuName\": \"50 ml\", \n\n11\n\n \"modalType\": null, \n\n12\n\n \"parentItemIndex\": null, \n\n13\n\n \"parentAssemblyBinding\": null, \n\n14\n\n \"priceValidUntil\": \"2022-04-07T18:31:11Z\", \n\n15\n\n \"tax\": 0, \n\n16\n\n \"taxCode\":\"54WC8ZN6K8\", \n\n17\n\n \"price\": 3190, \n\n18\n\n \"listPrice\": 3190, \n\n19\n\n \"manualPrice\": 1700, \n\n20\n\n \"manualPriceAppliedBy\": \"in542e51-5863-4c34-8i86-ed8fcf597a09\", \n\n21\n\n \"sellingPrice\": 1700, \n\n22\n\n \"rewardValue\": 0, \n\n23\n\n \"isGift\": false, \n\n24\n\n \"additionalInfo\": { \n\n25\n\n \"dimension\": null, \n\n26\n\n \"brandName\": \"VALCOSMETICS\", \n\n27\n\n \"brandId\": \"2000000\", \n\n28\n\n \"offeringInfo\": null, \n\n29\n\n \"offeringType\": null, \n\n30\n\n \"offeringTypeId\": null \n\n31\n\n }, \n\n32\n\n \"preSaleDate\": null, \n\n33\n\n \"productCategoryIds\": \"/2/\", \n\n34\n\n \"productCategories\": { \n\n35\n\n \"2\": \"Computers\" \n\n36\n\n }, \n\n37\n\n \"quantity\": 3, \n\n38\n\n \"seller\": \"seller1\", \n\n39\n\n \"sellerChain\": [ \n\n40\n\n \"seller1\" \n\n41\n\n ], \n\n42\n\n \"imageUrl\": \"http://cosmeticsstore.vteximg.com.br/arquivos/ids/155401-55-55/ID-001-MAIN.jpg?v=637109313796670000\", \n\n43\n\n \"detailUrl\": \"/mild-hair-cleanser/p\", \n\n44\n\n \"bundleItems\": [], \n\n45\n\n \"attachments\": [], \n\n46\n\n \"attachmentOfferings\": [], \n\n47\n\n \"offerings\": [], \n\n48\n\n \"priceTags\": [ \n\n49\n\n { \n\n50\n\n \"name\": \"DISCOUNT@MANUALPRICE\", \n\n51\n\n \"value\": -4470, \n\n52\n\n \"rawValue\": -44.7, \n\n53\n\n \"isPercentual\": false, \n\n54\n\n \"identifier\": null \n\n55\n\n } \n\n56\n\n ], \n\n57\n\n \"availability\": \"available\", \n\n58\n\n \"measurementUnit\": \"un\", \n\n59\n\n \"unitMultiplier\": 1.0000, \n\n60\n\n \"manufacturerCode\": null, \n\n61\n\n \"priceDefinition\": { \n\n62\n\n \"sellingPrice\": [ \n\n63\n\n { \n\n64\n\n \"quantity\": 1, \n\n65\n\n \"value\": 1700 \n\n66\n\n } \n\n67\n\n ], \n\n68\n\n \"total\": 5100 \n\n69\n\n } \n\n70\n\n } \n\n71\n\n ] \n\n`\n\n| Field | Type | Description |\n| ---------------------- | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| uniqueId | String | Obsolete field. This string is the unique identifier for each occurrence of a SKU in an order. Two units of the same SKU in an order will have different uniqueIds. |\n| id | String | ID of the item. |\n| productId | String | Product ID. |\n| productRefId | String | Product Ref ID. |\n| refId | String | Ref ID. |\n| ean | String | EAN (codebar) field from [SKU registry](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tutorial/cadastrar-o-codigo-de-barra-dos-skus-para-o-instore--2jkOdRB4XSMG2ke0uUQIKS%23cadastrar-o-campo-ean). |\n| name | String | Product name. |\n| skuName | String | SKU name. |\n| modalType | String | Modal type. |\n| parentItemIndex | Integer | Parent item index. |\n| parentAssemblyBinding | String | Parent assembly binding. |\n| priceValidUntil | String | Price expiration date and time. |\n| tax | Integer | Tax value in cents. |\n| taxCode | String | A unique identifier code assigned to a tax within the VTEX Admin. |\n| price | Integer | Price in cents. |\n| listPrice | Integer | List price in cents. |\n| manualPrice | Integer | Manual price in cents. |\n| manualPriceAppliedBy | String | User that applied the manual price, if that is the case. |\n| sellingPrice | Integer | Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the priceDefinition data structure instead. |\n| rewardValue | Integer | Reward value in cents. |\n| isGift | Boolean | Indicates whether item is a gift. |\n| additionalInfo | Object | Additional information. |\n| dimension | String | Dimension. |\n| brandName | String | Brand name. |\n| brandId | String | Brand ID. |\n| offeringInfo | String | Offering information. |\n| offeringType | String | Offering type. |\n| offeringTypeId | String | Offering type ID. |\n| preSaleDate | String | Presale date. |\n| productCategoryIds | String | Product category IDs. |\n| productCategories | Object | Object, where each field is an ID from productCategoryIds. |\n| {ID} | String | Product category corresponding to the ID in the field key. |\n| quantity | Integer | Quantity. |\n| seller | String | Seller information. |\n| sellerChain | Array of strings | Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order. |\n| imageUrl | String | Image URL. |\n| detailUrl | String | Detail URL. |\n| bundleItems | Array of objects | Information on services sold along with the SKU. Example: a gift package. |\n| type | String | Service type. |\n| id | Integer | Service identifier. |\n| name | String | Service name. |\n| price | Integer | Service price in cents. |\n| attachments | Array of strings | Array containing information on attachments. |\n| priceTags | Array of objects | Array of price tags, each of which, modifies the price in some way, like discounts or rates that apply to the item in the context of the order. |\n| name | String | Price tag name. |\n| value | Integer | Price tag value. |\n| rawValue | Integer | Price tag raw value. |\n| isPercentual | Boolean | Indicates whether price tag value is applied through a percentage. |\n| identifier | String | Price tag identifier. |\n| owner | String | Identification of the responsible for the price tag. |\n| availability | String | SKU availability. The values are: available, withoutStockand cannotBeDelivered. Only SKUs with available value can be sold and delivered. |\n| measurementUnit | String | Measurement unit. |\n| unitMultiplier | String | Unit multiplier. |\n| manufacturerCode | String | Manufacturer code. |\n| priceDefinition | Object | Price information for all units of a specific item. |\n| calculatedSellingPrice | Integer | Item's calculated unitary selling price in cents. |\n| total | Integer | Total value for all units of the item in cents. |\n| sellingPrices | Array of objects | Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total. |\n| value | Integer | Value in cents for that specific rounding. |\n| quantity | Integer | Rounding quantity, meaning how many items are rounded to this value. |\n\n> If you use integrations that consume price data, such as checkout or order integrations, note that the field `sellingPrice` may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead.\n\n#### items\\[\\].priceDefinition\n\n`1\n\n{ \n\n2\n\n \"items\": [ \n\n3\n\n { \n\n4\n\n \"id\": \"1001669\", \n\n5\n\n \"price\": 199, \n\n6\n\n \"quantity\": 3, \n\n7\n\n \"unitMultiplier\": 0.3, \n\n8\n\n \"measurementUnit\": \"kg\", \n\n9\n\n \"sellingPrice\": 59, \n\n10\n\n \"priceDefinition\": { \n\n11\n\n \"calculatedSellingPrice\": 59, \n\n12\n\n \"total\": 179, \n\n13\n\n \"sellingPrices\": [ \n\n14\n\n { \n\n15\n\n \"value\": 60, \n\n16\n\n \"quantity\": 2 \n\n17\n\n }, \n\n18\n\n { \n\n19\n\n \"value\": 59, \n\n20\n\n \"quantity\": 1 \n\n21\n\n } \n\n22\n\n ] \n\n23\n\n } \n\n24\n\n } \n\n25\n\n ] \n\n26\n\n} \n\n`\n\n| **Atribute** | **Type** | **Description** |\n| ------------------------------------------------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| items\\[\\].priceDefinition | Object | Price information for all units of a specific item. |\n| items\\[\\].priceDefinition.total | Integer | Total value for all units of the item in cents. |\n| items\\[\\].priceDefinition.calculatedSellingPrice | Integer | Item's calculated unitary selling price in cents. |\n| items\\[\\].priceDefinition.sellingPrices | Array | Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total. |\n\n### invoiceData\n\nThis is an object containing information pertinent to the order's invoice.\n\n`1\n\n{ \n\n2\n\n \"address\": { \n\n3\n\n \"postalCode\": \"******000\", \n\n4\n\n \"city\": \"Rio ** *******\", \n\n5\n\n \"state\": \"RJ\", \n\n6\n\n \"country\": \"BRA\", \n\n7\n\n \"street\": \"Rua *** *****nte\", \n\n8\n\n \"number\": \"***\", \n\n9\n\n \"neighborhood\": \"Bot*****\", \n\n10\n\n \"complement\": \"*** ** *\", \n\n11\n\n \"reference\": null \n\n12\n\n }, \n\n13\n\n \"settleInvoices\":[] \n\n14\n\n} \n\n`\n\n| Field | Type | Description |\n| -------------- | ------ | ------------------------------------------------- |\n| address | Object | Address information. |\n| settleInvoices | String | List of strings corresponding to invoice numbers. |\n\n### itemsOrdination\n\nThis is an object containing information about the ordering of items within the orderForm.\n\n**Example:**\n\n`1\n\n{ \n\n2\n\n \"criteria\": \"NAME\", \n\n3\n\n \"ascending\": true \n\n4\n\n} \n\n`\n\n| Field | Type | Description |\n| --------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| criteria | String | Criteria adopted to order the items in the list. The values are: NAME, ADD\\_TIME (date information), and GIFT (non-gift items are mentioned before gift items). |\n| ascending | String | Indicates whether the ordering is ascending. |\n\n### marketingData\n\nThis object contains promotion data such as coupon tracking information and internal or external UTMs.\n\n**Example:**\n\n`1\n\n{ \n\n2\n\n \"attachmentId\": \"marketingData\", \n\n3\n\n \"coupon\": null, \n\n4\n\n \"marketingTags\": [], \n\n5\n\n \"utmCampaign\": \"christmas\", \n\n6\n\n \"utmMedium\": null, \n\n7\n\n \"utmSource\": \"fb\", \n\n8\n\n \"utmiCampaign\": \"\", \n\n9\n\n \"utmiPart\": \"\", \n\n10\n\n \"utmipage\": \"\" \n\n11\n\n} \n\n`\n\n| Field | Type | Description |\n| ------------- | ------ | ---------------------------------------------------------------------------------------------------------------------- |\n| attachmentId | String | Attachment ID. |\n| coupon | String | Coupon code information. |\n| marketingTags | Array | Marketing tags information. This field can be used to register campaign data or informative tags regarding promotions. |\n| utmCampaign | String | Value of the utm\\_campaign parameter of the URL that led to the request. |\n| utmMedium | String | Value of the utm\\_medium parameter of the URL that led to the request. |\n| utmSource | String | Value of the utm\\_source parameter of the URL that led to the request. |\n| utmiCampaign | String | Internal UTM value utmi\\_cp. |\n| utmiPart | String | Internal UTM value utmi\\_pc. |\n| utmipage | String | Internal UTM value utmi\\_p. |\n\n### messages\n\nThis array contains an object for each message generated by our servers while processing the request.\n\n**Example:**\n\n`1\n\n[ \n\n2\n\n { \n\n3\n\n \"code\": null, \n\n4\n\n \"status\": \"error\", \n\n5\n\n \"text\": \"Voucher code AAAA-BBBB-CCCC-DDDD was not found in the system\" \n\n6\n\n } \n\n7\n\n] \n\n`\n\n### openTextField\n\nOptional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Add and handle custom information in the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order).\n\n`1\n\n{ \n\n2\n\n \"value\": \"{\\\"Phones\\\":[\\\"55555555\\\"]}\" \n\n3\n\n} \n\n`\n\n| Field | Type | Description |\n| ----- | ------ | --------------------------------------- |\n| value | String | Additional information about the order. |\n\n### paymentData\n\nThis object contains all payment information inserted for this purchase.\n\n**Example:**\n\n`1\n\n{ \n\n2\n\n \"giftCards\": [ \n\n3\n\n { \n\n4\n\n \"redemptionCode\": \"HYUO-TEZZ-QFFT-HTFR\", \n\n5\n\n \"value\": 500, \n\n6\n\n \"balance\": 500, \n\n7\n\n \"name\": null, \n\n8\n\n \"id\": \"-1390324156495k195pmab4rall3di\", \n\n9\n\n \"inUse\": true, \n\n10\n\n \"isSpecialCard\": false \n\n11\n\n }, { \n\n12\n\n \"redemptionCode\": \"MTHU-WNTD-VXJW-TIDC\", \n\n13\n\n \"value\": 0, \n\n14\n\n \"balance\": 700000, \n\n15\n\n \"name\": \"loyalty-program\", \n\n16\n\n \"id\": \"122\", \n\n17\n\n \"inUse\": false, \n\n18\n\n \"isSpecialCard\": true \n\n19\n\n } \n\n20\n\n ], \n\n21\n\n \"giftCardMessages\": [], \n\n22\n\n \"availableAccounts\": [ \n\n23\n\n { \n\n24\n\n \"accountId\": \"71F2775D46BF44B1BF217F828F4E6131\", \n\n25\n\n \"paymentSystem\": \"2\", \n\n26\n\n \"paymentSystemName\": \"Visa\", \n\n27\n\n \"cardNumber\": \"************1111\", \n\n28\n\n \"availableAddresses\": [\"-1363804954758\", \"-1366200971560\"] \n\n29\n\n } \n\n30\n\n ], \n\n31\n\n \"availableTokens\": [], \n\n32\n\n \"installmentOptions\": [ \n\n33\n\n { \n\n34\n\n \"paymentSystem\": \"2\", \n\n35\n\n \"value\": 16175, \n\n36\n\n \"installments\": [ \n\n37\n\n { \n\n38\n\n \"count\": 1, \n\n39\n\n \"hasInterestRate\": false, \n\n40\n\n \"interestRate\": 0, \n\n41\n\n \"value\": 16175, \n\n42\n\n \"total\": 16175 \n\n43\n\n }, { \n\n44\n\n \"count\": 2, \n\n45\n\n \"hasInterestRate\": false, \n\n46\n\n \"interestRate\": 132, \n\n47\n\n \"value\": 4178, \n\n48\n\n \"total\": 16712 \n\n49\n\n } \n\n50\n\n ] \n\n51\n\n } \n\n52\n\n ], \n\n53\n\n \"paymentSystems\": [ \n\n54\n\n { \n\n55\n\n \"id\": 2, \n\n56\n\n \"name\": \"Visa\", \n\n57\n\n \"groupName\": \"creditCardPaymentGroup\", \n\n58\n\n \"validator\": { \n\n59\n\n \"regex\": \"^4\", \n\n60\n\n \"mask\": \"9999 9999 9999 9999\", \n\n61\n\n \"cardCodeRegex\": \"[^0-9]\", \n\n62\n\n \"cardCodeMask\": \"999\", \n\n63\n\n \"weights\": [2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2] \n\n64\n\n }, \n\n65\n\n \"stringId\": null, \n\n66\n\n \"template\": \"creditCardPaymentGroup-template\", \n\n67\n\n \"requiresDocument\": false, \n\n68\n\n \"selected\": false, \n\n69\n\n \"isCustom\": false, \n\n70\n\n \"description\": null \n\n71\n\n } \n\n72\n\n ], \n\n73\n\n \"payments\": [ \n\n74\n\n { \n\n75\n\n \"accountId\": null, \n\n76\n\n \"bin\": null, \n\n77\n\n \"installments\": 2, \n\n78\n\n \"paymentSystem\": \"12\", \n\n79\n\n \"referenceValue\": 16175, \n\n80\n\n \"value\": 16175 \n\n81\n\n } \n\n82\n\n ] \n\n83\n\n} \n\n`\n\n| Field | Type | Description |\n| ------------------ | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| giftCards | Array | Gift cards information. |\n| giftCardMessages | Array | Gift cards message information. |\n| availableAccounts | Array | Available accounts information. |\n| availableTokens | Array | Available tokes information. |\n| installmentOptions | Array | For accurate information on installment options and values, we recommend using the [Cart installments endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pub/orderForm/-orderFormId-/installments), instead of this field's data. |\n| paymentSystems | Array | Payment systems information. |\n| payments | Array | Payments information. |\n| updateStatus | String | Checkout can not be concluded if value is \"outdated\". |\n\n> This guide is currently being written and published as content becomes available.\n\n### ratesAndBenefitsData\n\nInformation on rates and benefits that apply to the order.\n\n**Example:**\n\n`1\n\n{ \n\n2\n\n \"rateAndBenefitsIdentifiers\": [ \n\n3\n\n { \n\n4\n\n \"items\": {} \n\n5\n\n } \n\n6\n\n ], \n\n7\n\n \"teaser\":[ \n\n8\n\n { \n\n9\n\n \"items\": {} \n\n10\n\n } \n\n11\n\n ] \n\n12\n\n} \n\n`\n\n| Field | Type | Description |\n| -------------------------- | ------ | --------------------------------------------- |\n| rateAndBenefitsIdentifiers | Array | List with rates and benefits identifiers. |\n| items | Object | Object that contains identifiers information. |\n| teaser | Array | List with rates and benefits teasers. |\n| items | Object | Object that contains teasers information. |\n\n### selectableGifts\n\nArray containing the data of the item selected as a gift.\n\n`1\n\n [ \n\n2\n\n { \n\n3\n\n \"id\": null, \n\n4\n\n \"availableQuantity\": \"3\", \n\n5\n\n \"availableGifts\": { \n\n6\n\n \"items\": [ \n\n7\n\n {}, \n\n8\n\n \"isSelected\": true \n\n9\n\n ] \n\n10\n\n } \n\n11\n\n } \n\n12\n\n ] \n\n`\n\n| Field | Type | Description |\n| ----------------- | ------- | ------------------------------------------------------------------------------- |\n| id | String | Identification of the selectable gifts list. |\n| availableQuantity | Integer | Number of items available. |\n| items | Integer | Array containing an object describing each item that can be selected as a gift. |\n| isSelected | Boolean | Indication if the item was selected as a gift. |\n\n### sellers\n\nAn array containing an object for each seller being used in the order.\n\n**Example:**\n\n`1\n\n[ \n\n2\n\n { \n\n3\n\n \"id\": \"1\", \n\n4\n\n \"name\": \"meuamigopet\", \n\n5\n\n \"logo\": \"http://portal.vtexcommerce.com.br/arquivos/logo.jpg\" \n\n6\n\n } \n\n7\n\n] \n\n`\n\n| Field | Type | Description |\n| ----- | ------ | ------------------------------------------ |\n| id | String | ID of the seller. |\n| name | String | Name of the seller. |\n| logo | String | URL pointing to where the image is hosted. |\n\n### shippingData\n\nThis object contains shipping information for the order.\n\n**Example:**\n\n`1\n\n{ \n\n2\n\n \"attachmentId\": \"shippingData\", \n\n3\n\n \"address\": { \n\n4\n\n \"addressType\": \"residential\", \n\n5\n\n \"receiverName\": \"Gui***rme\", \n\n6\n\n \"addressId\": \"-1368194386810\", \n\n7\n\n \"postalCode\": \"******000\", \n\n8\n\n \"city\": \"Rio ** *******\", \n\n9\n\n \"state\": \"RJ\", \n\n10\n\n \"country\": \"BRA\", \n\n11\n\n \"street\": \"Rua *** *****nte\", \n\n12\n\n \"number\": \"***\", \n\n13\n\n \"neighborhood\": \"Bot*****\", \n\n14\n\n \"complement\": \"*** ** *\", \n\n15\n\n \"reference\": null \n\n16\n\n }, \n\n17\n\n \"availableAddresses\": [ \n\n18\n\n { \n\n19\n\n \"addressType\": \"residential\", \n\n20\n\n \"receiverName\": \"Gui***rme\", \n\n21\n\n \"addressId\": \"-1368194386810\", \n\n22\n\n \"postalCode\": \"******000\", \n\n23\n\n \"city\": \"Rio ** *******\", \n\n24\n\n \"state\": \"RJ\", \n\n25\n\n \"country\": \"BRA\", \n\n26\n\n \"street\": \"Rua *** *****nte\", \n\n27\n\n \"number\": \"***\", \n\n28\n\n \"neighborhood\": \"Bot*****\", \n\n29\n\n \"complement\": \"*** ** *\", \n\n30\n\n \"reference\": null \n\n31\n\n } \n\n32\n\n ], \n\n33\n\n \"logisticsInfo\": [ \n\n34\n\n { \n\n35\n\n \"itemIndex\": 0, \n\n36\n\n \"selectedSla\": \".Transportadora\", \n\n37\n\n \"selectedDeliveryChannel\": \"delivery\", \n\n38\n\n \"addressId\": \"teste\", \n\n39\n\n \"slas\": [ \n\n40\n\n { \n\n41\n\n \"id\": \".Transportadora\", \n\n42\n\n \"deliveryChannel\": \"delivery\", \n\n43\n\n \"name\": \".Transportadora\", \n\n44\n\n \"deliveryIds\": [ \n\n45\n\n { \n\n46\n\n \"courierId\": \"67\", \n\n47\n\n \"warehouseId\": \"1_1\", \n\n48\n\n \"dockId\": \"1_1_1\", \n\n49\n\n \"courierName\": \"Transportadora\", \n\n50\n\n \"quantity\": 1 \n\n51\n\n } \n\n52\n\n ], \n\n53\n\n \"shippingEstimate\": \"3d\", \n\n54\n\n \"shippingEstimateDate\": null, \n\n55\n\n \"lockTTL\": null, \n\n56\n\n \"availableDeliveryWindows\": [], \n\n57\n\n \"deliveryWindow\": null, \n\n58\n\n \"price\": 956, \n\n59\n\n \"tax\": 0 \n\n60\n\n }, { \n\n61\n\n \"id\": \"Agendada\", \n\n62\n\n \"name\": \"Agendada\", \n\n63\n\n \"deliveryIds\": [ \n\n64\n\n { \n\n65\n\n \"courierId\": \"FA02F72F-FEBD-41A0-AF70-83A77E8C77A0\", \n\n66\n\n \"warehouseId\": \"1_1\", \n\n67\n\n \"dockId\": \"1_1_1\", \n\n68\n\n \"courierName\": \"Entrega agendada\", \n\n69\n\n \"quantity\": 1 \n\n70\n\n } \n\n71\n\n ], \n\n72\n\n \"shippingEstimate\": \"90d\", \n\n73\n\n \"shippingEstimateDate\": null, \n\n74\n\n \"lockTTL\": null, \n\n75\n\n \"availableDeliveryWindows\": [ \n\n76\n\n { \n\n77\n\n \"startDateUtc\": \"2014-04-21T09:00:00+00:00\", \n\n78\n\n \"endDateUtc\": \"2014-04-21T12:00:00+00:00\", \n\n79\n\n \"listprice\": 1000, \n\n80\n\n \"tax\": 0 \n\n81\n\n }, { \n\n82\n\n \"startDateUtc\": \"2014-04-21T13:00:00+00:00\", \n\n83\n\n \"endDateUtc\": \"2014-04-21T17:00:00+00:00\", \n\n84\n\n \"listprice\": 1000, \n\n85\n\n \"tax\": 0 \n\n86\n\n } \n\n87\n\n ], \n\n88\n\n \"deliveryWindow \": [ \n\n89\n\n { \n\n90\n\n \"startDateUtc\": \"2014-04-21T09:00:00+00:00\", \n\n91\n\n \"endDateUtc\": \"2014-04-21T12:00:00+00:00\", \n\n92\n\n \"listprice\": 1000, \n\n93\n\n \"tax\": 0 \n\n94\n\n }, { \n\n95\n\n \"startDateUtc\": \"2014-04-21T13:00:00+00:00\", \n\n96\n\n \"endDateUtc\": \"2014-04-21T17:00:00+00:00\", \n\n97\n\n \"listprice\": 1000, \n\n98\n\n \"tax\": 0 \n\n99\n\n } \n\n100\n\n ], \n\n101\n\n \"price\": 1220, \n\n102\n\n \"tax\": 0, \n\n103\n\n \"pickupStoreInfo\": { \n\n104\n\n \"isPickupStore\": false, \n\n105\n\n \"friendlyName\": null, \n\n106\n\n \"address\": null, \n\n107\n\n \"additionalInfo\": null, \n\n108\n\n \"dockId\": null \n\n109\n\n }, \n\n110\n\n \"pickupPointId\": null, \n\n111\n\n \"pickupDistance\": 0, \n\n112\n\n \"polygonName\": null, \n\n113\n\n \"transitTime\": \"3bd\" \n\n114\n\n } \n\n115\n\n ], \n\n116\n\n \"shipsTo\": [ \n\n117\n\n \"BRA\", \n\n118\n\n \"COL\", \n\n119\n\n \"USA\" \n\n120\n\n ], \n\n121\n\n \"itemId\": \"2\", \n\n122\n\n \"deliveryChannels\": [ \n\n123\n\n { \n\n124\n\n \"id\": \"delivery\" \n\n125\n\n }, \n\n126\n\n { \n\n127\n\n \"id\": \"pickup-in-point\" \n\n128\n\n } \n\n129\n\n ] \n\n130\n\n } \n\n131\n\n ], \n\n132\n\n \"selectedAddresses\": [] \n\n133\n\n} \n\n`\n\n| Field | Type | Description |\n| ------------------------ | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| attachmentId | String | Attachment ID. |\n| address | Object | Address information. |\n| availableAddresses | Array | Information about available shipping addresses. |\n| logisticsInfo | Array | Logistics information. |\n| itemIndex | Integer | Index corresponding to the position of the object in the items array. |\n| selectedSla | String | SLA selected by the customer. |\n| selectedDeliveryChannel | String | Delivery channel selected by the customer. |\n| addressId | String | Address ID. |\n| slas | Array | Information on available SLAs. |\n| id | String | SLA ID. |\n| deliveryChannel | String | Delivery channel. |\n| name | String | SLA name. |\n| deliveryIds | Array | Information on each delivery ID. |\n| courierId | String | Courier ID. |\n| warehouseId | String | Warehouse ID. |\n| dockId | String | Dock ID. |\n| courierName | String | Courier name. |\n| quantity | Integer | Quantity. |\n| shippingEstimate | String | Total shipping estimate time, represented by a number followed by a time unit. For instance, three business days is represented as 3bd. The time unit can be one of the following: m (minutes)h (hours)bd (business days)d (days) |\n| shippingEstimateDate | String | Shipping estimate date. |\n| lockTTL | String | Estimate date of delivery. |\n| availableDeliveryWindows | String | Available shipping date. |\n| startDateUtc | String | Available delivery window start date in UTC. |\n| endDateUtc | String | Available delivery window end date in UTC. |\n| deliveryWindow | Object | Scheduled delivery window information, in case it applies to the item. |\n| startDateUtc | String | Scheduled delivery window start date in UTC. |\n| endDateUtc | String | Scheduled delivery window end date in UTC. |\n| listPrice | Integer | Scheduled delivery window list price. |\n| price | Integer | Price in cents. |\n| tax | Integer | Tax in cents. |\n| pickupStoreInfo | Object | Information on the pickup store. |\n| isPickupStore | Boolean | Indicates whether it is the pickup store. |\n| friendlyName | String | Friendly name. |\n| address | Object | Address information. |\n| additionalInfo | String | Additional information. |\n| dockId | String | Corresponding dock ID. |\n| pickupPointId | String | Pickup point ID. |\n| pickupDistance | Integer | Pickup point distance. |\n| polygonName | String | Polygon name. |\n| transitTime | String | Transit time. For instance, \"three business days\" is represented 3bd. |\n| shipsTo | Array | List of countries that the item may be shipped to. |\n| itemId | String | Item ID. |\n| deliveryChannels | String | List of available delivery channels. |\n| id | String | elivery channel ID. |\n| selectedAddresses | Array | Selected addresses information. |\n\n### storeId\n\nIt is a string containing the store ID.\n\n**Example:**\n\n`1\n\n{ \n\n2\n\n \"storeId\": \"2\" \n\n3\n\n} \n\n`\n\n| Field | Type | Description |\n| ------- | ------- | ---------------------------- |\n| storeId | integer | Identification of the store. |\n\n### storePreferencesData\n\nThis object contains data from the store's configuration.\n\n**Example:**\n\n`1\n\n{ \n\n2\n\n \"countryCode\": \"BRA\", \n\n3\n\n \"saveUserData\": true, \n\n4\n\n \"templateOptions\": { \n\n5\n\n \"toggleCorporate\": false \n\n6\n\n }, \n\n7\n\n \"timeZone\": \"E. South America Standard Time\", \n\n8\n\n \"currencyCode\": \"BRL\", \n\n9\n\n \"currencyLocale\": 0, \n\n10\n\n \"currencySymbol\": \"R$\", \n\n11\n\n \"currencyFormatInfo\": { \n\n12\n\n \"currencyDecimalDigits\": 2, \n\n13\n\n \"currencyDecimalSeparator\": \",\", \n\n14\n\n \"currencyGroupSeparator\": \".\", \n\n15\n\n \"currencyGroupSize\": 3, \n\n16\n\n \"startsWithCurrencySymbol\": true \n\n17\n\n } \n\n18\n\n} \n\n`\n\n### totalizers\n\nThis array contains an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\n\n**Example:**\n\n`1\n\n[ \n\n2\n\n { \n\n3\n\n \"id\": \"Items\", \n\n4\n\n \"name\": \"Total items\", \n\n5\n\n \"value\": 35620 \n\n6\n\n }, \n\n7\n\n { \n\n8\n\n \"id\": \"Shipping\", \n\n9\n\n \"name\": \"Total freight\", \n\n10\n\n \"value\": 399 \n\n11\n\n } \n\n12\n\n] \n\n`\n\nContributors\n\n4\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/geisecosta)\n\n[](https://github.com/ricardoaerobr)\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/Checkout/orderform-fields.md)\n\nContributors\n\n4\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/geisecosta)\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/Isabella-Veloso)\n\nON THIS PAGE\n\n[OrderForm Sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23orderform-sections)\n\n[clientPreferencesData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23clientpreferencesdata)[clientProfileData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23clientprofiledata)[commercialConditionData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23commercialconditiondata)[customData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23customdata)[giftRegistryData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23giftregistrydata)[hooksData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23hooksdata)[items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23items)[invoiceData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23invoicedata)[itemsOrdination](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23itemsordination)[marketingData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23marketingdata)[messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23messages)[openTextField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23opentextfield)[paymentData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23paymentdata)[ratesAndBenefitsData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23ratesandbenefitsdata)[selectableGifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23selectablegifts)[sellers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23sellers)[shippingData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23shippingdata)[storeId](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23storeid)[storePreferencesData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23storepreferencesdata)[totalizers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23totalizers)\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/orderform-fields.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[OrderForm Sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23orderform-sections)\n\n[clientPreferencesData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23clientpreferencesdata)[clientProfileData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23clientprofiledata)[commercialConditionData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23commercialconditiondata)[customData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23customdata)[giftRegistryData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23giftregistrydata)[hooksData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23hooksdata)[items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23items)[invoiceData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23invoicedata)[itemsOrdination](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23itemsordination)[marketingData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23marketingdata)[messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23messages)[openTextField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23opentextfield)[paymentData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23paymentdata)[ratesAndBenefitsData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23ratesandbenefitsdata)[selectableGifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23selectablegifts)[sellers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23sellers)[shippingData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23shippingdata)[storeId](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23storeid)[storePreferencesData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23storepreferencesdata)[totalizers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields/docs/guides/orderform-fields%23totalizers)\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_9c28a08b
|
[
{
"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 Newsletter 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/Newsletter/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/Newsletter/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/Newsletter/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/Newsletter/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/Newsletter/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/Newsletter/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/Newsletter/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/Newsletter/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/Newsletter/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/Newsletter/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/Newsletter/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/Newsletter/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/Newsletter/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/Newsletter/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/Newsletter/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/Newsletter/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/Newsletter/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/Newsletter/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/Newsletter/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/Newsletter/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/Newsletter/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/Newsletter/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/Newsletter/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/Newsletter/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/Newsletter/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/Newsletter/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/Newsletter/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/Newsletter/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/Newsletter/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/Newsletter/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/Newsletter/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/Newsletter/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/Newsletter/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/Newsletter/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/Newsletter/docs/vtex-io-apps)\n\nNewsletter\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\n\n> Warning\n> \n> **The Newsletter block has been deprecated in favor of the [Newsletter app](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-store-newsletter/).** Although support for this block is still granted, we strongly recommend you to update your store theme with the Product Specification's blocks in order to keep up with the component's evolution.\n\nThe `newsletter` block displays a newsletter form.\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 `newsletter` block to any template of your choice. For example:\n\n`1\n\n \"store.home\": { \n\n2\n\n \"children\": [ \n\n3\n\n+ \"newsletter\", \n\n4\n\n ] \n\n5\n\n }, \n\n`\n\n1. Then, declare the `newsletter` block using the props stated in the [Props](#props) table.\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| ----------- | ------- | ---------------------------------------- | --------------------------------------------- |\n| hideLabel | Boolean | Hide label. | false |\n| label | String | Label of the form used by the component. | Subscribe to our newsletter (translated text) |\n| placeholder | String | Placeholder of the email input. | Enter your email address (translated text) |\n| submit | String | Label of the submit button. | Sign up (translated text) |\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| buttonContainer |\n| confirmation |\n| confirmationText |\n| confirmationTitle |\n| container |\n| error |\n| form |\n| inputGroup |\n| label |\n| newsletter |\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/Newsletter/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/Newsletter/docs/apps/vtex.store-components@3.178.5/Newsletter%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/Newsletter/docs/apps/vtex.store-components@3.178.5/Newsletter%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/Newsletter/docs/apps/vtex.store-components@3.178.5/Newsletter%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_9aa47447
|
[
{
"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 summary 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-summary/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-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/apps/vtex.checkout-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/apps/vtex.checkout-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/apps/vtex.checkout-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/apps/vtex.checkout-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/apps/vtex.checkout-summary/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-summary/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-summary/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-summary/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-summary/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-summary/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-summary/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-summary/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-summary/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-summary/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-summary/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-summary/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-summary/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-summary/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-summary/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-summary/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-summary/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-summary/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-summary/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-summary/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-summary/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-summary/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-summary/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-summary/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-summary/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-summary/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-summary/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-summary/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-summary/docs/vtex-io-apps)\n\nSummary\n\nOfficial extension\n\nVersion: 0.23.0\n\nLatest version: 0.23.0\n\n[](#contributors-)\n\nThe Summary block displays the order totalizers and allows the user to add coupon codes. Currently, the Summary block only works out of the box within the [Minicart](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/minicart) and the [Checkout Cart](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/checkout-cart).\n\n\n\nCompact version:\n\n\n\n## Configuration\n\n1. Add the Summary app to your theme's dependencies in `manifest.json`. For example:\n\n`1\n\n{ \n\n2\n\n \"dependencies\": { \n\n3\n\n \"vtex.checkout-summary\": \"0.x\" \n\n4\n\n } \n\n5\n\n} \n\n`\n\n1. Add the `checkout-summary.compact` block to the `minicart-summary` block of the Minicart or the `checkout-summary` block to the `summary-wrapper` block of the Checkout Cart. For example:\n\n`1\n\n{ \n\n2\n\n \"minicart-summary#example\": { \n\n3\n\n \"blocks\": [\"checkout-summary.compact\"] \n\n4\n\n } \n\n5\n\n} \n\n`\n\n### Advanced Customization\n\nThe `checkout-summary` block is made up of other smaller blocks. Currently, its default implementation is as follows:\n\n`1\n\n{ \n\n2\n\n \"checkout-summary\": { \n\n3\n\n \"children\": [\"flex-layout.row#summary-coupon\", \"summary-totalizers\"] \n\n4\n\n }, \n\n5\n\n \"flex-layout.row#summary-coupon\": { \n\n6\n\n \"children\": [\"summary-coupon\"], \n\n7\n\n \"props\": { \n\n8\n\n \"marginBottom\": 6 \n\n9\n\n } \n\n10\n\n }, \n\n11\n\n \"summary-coupon\": { \n\n12\n\n \"blocks\": [\"coupon\"] \n\n13\n\n } \n\n14\n\n} \n\n`\n\nBy default implementation we mean that whenever you use `checkout-summary` in your store you're actually using the `json` above behind the scenes.\n\nTherefore, in order to customize the Checkout Summary configuration, you can simply use the default implementation in your code and change it as you wish. For more information on which props you need to pass to the Summary component, [see below](#components).\n\nThis app exports all of the following blocks. You can see more detailed information of the`checkout-summary`, `checkout-summary.compact`, and `summary-totalizers` blocks in the [Components](#components) section.\n\n`1\n\n{ \n\n2\n\n \"checkout-summary\": { \n\n3\n\n \"props\": { \n\n4\n\n \"title\": \"Order Summary\" \n\n5\n\n } \n\n6\n\n }, \n\n7\n\n \"checkout-summary.compact\": { \n\n8\n\n \"props\": { \n\n9\n\n \"totalizersToShow\": [\"Items\"] \n\n10\n\n } \n\n11\n\n }, \n\n12\n\n \"summary-totalizers\": { \n\n13\n\n \"props\": { \n\n14\n\n \"showTotal\": true, \n\n15\n\n \"showDeliveryTotal\": true, \n\n16\n\n \"showOriginalTotal\": false \n\n17\n\n } \n\n18\n\n }, \n\n19\n\n \"summary-coupon\": { \n\n20\n\n // this block doesn't have any props \n\n21\n\n }, \n\n22\n\n \"summary-installments\": { \n\n23\n\n \"props\": { \n\n24\n\n \"message\": \"Up to {installmentsNumber}x {installmentValue}\", \n\n25\n\n \"markers\": [] \n\n26\n\n } \n\n27\n\n } \n\n28\n\n} \n\n`\n\nAdditionally, you can also include a [Drawer](https://read.calvincode.net/reader?url=https://vtex.io/docs/components/content-blocks/vtex.store-drawer) inside the `checkout-summary`.\n\nNotice the following: the block declared as children of the `drawer-trigger` block will appear alongside the Summary title.\n\n`1\n\n{ \n\n2\n\n \"checkout-summary\": { \n\n3\n\n \"blocks\": [\"drawer#my-drawer\"], \n\n4\n\n \"children\": [\"flex-layout.row#summary-coupon\", \"summary-totalizers\"] \n\n5\n\n }, \n\n6\n\n \"drawer#my-drawer\": { \n\n7\n\n \"blocks\": [\"drawer-trigger#my-trigger\"] \n\n8\n\n }, \n\n9\n\n \"drawer-trigger#my-trigger\": { \n\n10\n\n \"children\": [ \n\n11\n\n // whatever you put inside here will \n\n12\n\n // appear alongside the summary title \n\n13\n\n ] \n\n14\n\n } \n\n15\n\n} \n\n`\n\n## Components\n\n### SummaryTotalizers\n\nThe component rendered when the `summary-totalizers` block is used.\n\n#### Props\n\n| Prop name | Type | Default | Description |\n| ----------------- | ------- | ------- | ------------------------------------------------------------------------------------------------ |\n| showTotal | boolean | true | Whether to display the overall order total |\n| showDeliveryTotal | boolean | true | Whether to display the shipping/delivery total |\n| showOriginalTotal | boolean | false | Whether to display the original items value (sum of item list prices) next to the items subtotal |\n\n### SummarySmall\n\nThe component rendered when used the `checkout-summary.compact` block.\n\n#### Props\n\n| Prop name | Type | Default |\n| -------------------------------------------------- | ------ | ----------------- |\n| [totalizers](#summarysmall-totalizers) | array | undefined |\n| [totalizersToShow](#summarysmall-totalizersToShow) | array | \\['Items'\\] |\n| [total](#summarysmall-total) | number | undefined |\n| [totalCalculation](#summarysmall-totalCalculation) | enum | visibleTotalizers |\n\n##### SummarySmall totalizers\n\n`Array<{ id: string; value: number | null; name: string }>`\n\nSame as the [Summary totalizers](#summary-totalizers) prop.\n\n##### SummarySmall total\n\nSame as the [Summary total](#summary-total) prop.\n\n##### SummarySmall totalCalculation\n\nControls how the `Total` shown in the bottom of the summary is calculated. Possible values are: `visibleTotalizers`, which means that the `Total` shown will only take into account visible totalizers (the ones included in the `totalizersToShow` array), and `allTotalizers`, which will take into account all totalizers from `orderForm`, even if they're not being displayed.\n\n##### SummarySmall totalizersToShow\n\n`string[]`\n\nId of the totalizers that should be displayed inside this component, e.g.:\n\n`1\n\n;[ \n\n2\n\n // Value of the subtotal \n\n3\n\n 'Items', \n\n4\n\n // Delivery value \n\n5\n\n 'Shipping', \n\n6\n\n] \n\n`\n\n### SummaryInstallments\n\nThe component rendered when used the `summary-installments` block. Renders the product installments. If more than one option is available, the one with the biggest number of installments will be displayed.\n\n#### Props\n\n| Prop name | Type | Description | Default value |\n| ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |\n| markers | \\[string\\] | IDs of your choosing to identify the block's rendered message and customize it using the admin's Site Editor. Learn how to use them accessing the documentation on [Using the Markers prop to customize a block's message](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/style/using-the-markers-prop-to-customize-a-blocks-message). Notice the following: a block's message can also be customized in the Store Theme source code using the message prop. | \\[\\] |\n| blockClass | string | Block ID of your choosing to be used in [CSS customization](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization%23using-the-blockclass-property). | undefined |\n| message | string | Defines the block's default text i.e. the block message. You can also define which text message a block will render on the UI using the admin's Site Editor. | undefined |\n\n#### Message variables\n\n| Message variables | Type | Description |\n| ---------------------- | ------- | ------------------------------------------------------------- |\n| installmentsNumber | string | Number of installments. |\n| installmentValue | string | Value of each installment. |\n| installmentsTotalValue | string | Total value of installments. |\n| interestRate | string | Interest rate. |\n| paymentSystemName | string | Payment System of the installments. |\n| hasInterest | boolean | Whether the installments have interest (true) or not (false). |\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| installments |\n| installmentsNumber |\n| installmentValue |\n| installmentsTotalValue |\n| interestRate |\n| paymentSystemName |\n| summaryTitle |\n| summaryContent |\n| summarySmallContent |\n| summarySmallDisclaimer |\n| summaryItemContainer |\n| summaryItemLabel |\n| summaryItemPrice |\n| summaryItemOriginalPrice |\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.checkout-summary/docs/apps/vtex.checkout-summary%23configuration)\n\n[Advanced Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-summary/docs/apps/vtex.checkout-summary%23advanced-customization)\n\n[Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-summary/docs/apps/vtex.checkout-summary%23components)\n\n[SummaryTotalizers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-summary/docs/apps/vtex.checkout-summary%23summarytotalizers)[SummarySmall](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-summary/docs/apps/vtex.checkout-summary%23summarysmall)[SummaryInstallments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-summary/docs/apps/vtex.checkout-summary%23summaryinstallments)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-summary/docs/apps/vtex.checkout-summary%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_70cb5d98
|
[
{
"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 getoverriddensection function 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-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/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-getoverriddensection-function/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/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-getoverriddensection-function/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/docs/guides/faststore/overrides-section-styles)\n\n[\\`getOverriddenSection\\` function](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/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-getoverriddensection-function/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/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-getoverriddensection-function/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/docs/guides/faststore/overrides-section-styles)\n\n[\\`getOverriddenSection\\` function](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/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-getoverriddensection-function/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/docs/guides/faststore)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/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-getoverriddensection-function/docs/guides/faststore/overrides-overview)\n\ngetOverriddenSection function\n\nThe `getOverriddenSection` function lets you customize sections in your FastStore project without altering its core components and behavior. Instead, it returns a new React component representing the customized section.\n\nThis allows the creation of multiple overrides based on native components, enabling precise adjustments to specific parts of a section without affecting the rest.\n\n## Usage example\n\nImagine an Alert section with an icon. You want to make the icon bolder without changing anything else. `getOverriddenSection` allows you to target just the Icon component.\n\n`1\n\nimport { getOverriddenSection } from '@faststore/core'; \n\n2\n\nimport { AlertSection } from '@faststore/core'; \n\n3\n\nimport styles from './simple-alert.module.scss' \n\n4\n\n \n5\n\nconst SimpleAlert = getOverriddenSection({ \n\n6\n\n// Specify the original section to be overridden \n\n7\n\nSection: AlertSection, \n\n8\n\n// Add a class for potential styling (optional) \n\n9\n\nclassName: styles.simpleAlert, \n\n10\n\n// Define components to override within the section \n\n11\n\ncomponents: { \n\n12\n\n // Override the \"Icon\" component \n\n13\n\n Icon: { \n\n14\n\n // Change only the \"props\" of the Icon \n\n15\n\n props: { \n\n16\n\n // Set the \"weight\" prop to \"bold\" \n\n17\n\n weight: \"bold\" \n\n18\n\n } \n\n19\n\n } \n\n20\n\n} \n\n21\n\n}); \n\n22\n\n \n23\n\nexport default SimpleAlert; \n\n`\n\n## Instructions\n\nHere's how you can use `getOverriddenSection` to customize sections within your FastStore project:\n\n1. Import the `getOverriddenSection` from the `@faststore/core` package.\n2. Import the native section from `@faststore/core`. In this example, we considered the `AlertSection`.\n3. Define a new component using the `getOverriddenSection` function (e.g., `SimpleAlert`).\n4. In the `Section` parameter of the `getOverriddenSection` function, specify the original section. Note that the `getOverriddenSection` uses the original `AlertSection` as the base for customization.\n5. (Optional) Add a `className` for styling the section.\n6. In the `components` parameter of the `getOverriddenSection` function, declare the components you wish to override (e.g., `Icon`).\n7. Set the new props for the specified component. In this example, we overrode the weight prop to `bold` within the Icon's props.\n\n> Additional props can be applied to the overridden section. 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 available props for each component.\n\n## Parameters\n\n### `override`\n\nDefine how to override the native section. This parameter can have the following properties:\n\n| Properties | Description |\n| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Section | React component representing the overridden section. |\n| components | An object containing overrides for specific components within the section. The keys of this object should match the component names used in the section, and the values should be objects defining overrides for those components. For more details on overrides, refer to [Overriding components props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props) and [Overriding a component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-native-component). |\n| className | Property that behaves similarly to [React's className](https://read.calvincode.net/reader?url=https://react.dev/reference/react-dom/components/common%23applying-css-styles). |\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/getoverriddensection-function.mdx)\n\n[Overriding section styles« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/docs/guides/faststore/overrides-section-styles)[Syncing components with the Headless CMSNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Usage example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/docs/guides/faststore/overrides-getoverriddensection-function%23usage-example)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/docs/guides/faststore/overrides-getoverriddensection-function%23instructions)\n\n[Parameters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/docs/guides/faststore/overrides-getoverriddensection-function%23parameters)\n\n[override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/docs/guides/faststore/overrides-getoverriddensection-function%23override)\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/getoverriddensection-function.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Usage example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/docs/guides/faststore/overrides-getoverriddensection-function%23usage-example)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/docs/guides/faststore/overrides-getoverriddensection-function%23instructions)\n\n[Parameters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/docs/guides/faststore/overrides-getoverriddensection-function%23parameters)\n\n[override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function/docs/guides/faststore/overrides-getoverriddensection-function%23override)\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_0d9797f7
|
[
{
"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 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/vtex-io-documentation-cms/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-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-cms/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-cms/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-cms/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-cms/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-cms/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-cms/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-cms/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-cms/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-cms/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-cms/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-cms/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-cms/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-cms/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-cms/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-cms/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-cms/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-cms/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-cms/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-cms/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-cms/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-cms/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-cms/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-cms/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-cms/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-cms/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-cms/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-cms/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-cms/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-cms/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-cms/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-cms/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-cms/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-cms/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-cms/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-cms/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-cms/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-cms/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-cms/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-cms/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-cms/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-cms/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-cms/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-cms/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-cms/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-cms/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-cms/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-cms/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-cms/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-cms/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-cms/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-cms/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-cms/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-cms/docs/guides/store-framework-working-with-site-editor)\n\nWorking with Site Editor\n\nDiscover how Site Editor simplifies the customization of your Store Framework storefront.\n\n[Site Editor](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/site-editor-overview) works as a Content Management System (CMS) designed for stores developed with [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-store-framework), reflecting the blocks defined in the [Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme) of the VTEX account.\n\nBased on the source code, the Site Editor displays an editable version of the website's storefront, enabling non-technical users to manage content as desired and modify components and their behavior through a friendly interface.\n\nIn your VTEX Admin, go to **Storefront > Site Editor** to see the main available tools.\n\n\n\nChanges made in Site Editor are immediately reflected in the store, and every storefront block can have its properties changed there. For example, you can change the content of a rich text block and shelf properties, such as which collection is being shown, among other changes.\n\n> Developers are responsible for creating components, defining the structure of the [Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme), and ensuring seamless integration with Site Editor. This integration allows non-technical users to manage and update components easily, empowering store administrators to make changes to their storefronts without modifying the codebase.\n\nLearn more in [Site Editor - Overview](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/site-editor-overview--299Dbeb9mFczUTyNQ9xPe1).\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, you must have at least the `vtex.builder-hub@0.293.4` version installed in your account. Also, you need to specify them in the app’s `manifest.json` file. Learn more at [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### Create the store pages\n\nDevelop your store pages following the [Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages) guides.\n\n### Configure your components\n\nSet up your components following the [Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components) guides.\n\n## Essential concepts\n\nIt is important to understand the concept of a Content Management System (CMS) to learn how to work with Site Editor.\n\nA Content Management System (CMS) is a tool for creating, managing, and modifying website content. VTEX offers different CMS options based on the storefront technology used to develop your site. Store Framework uses Site Editor, Legacy CMS Portal uses [Layout](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/1oN446gRGcR2s70RvBCAmj), and FastStore leverages [VTEX Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview).\n\nOn VTEX, these tools allow you to manage the pages that make up your store website with the autonomy to create, organize, edit, and define the entire structure of folders, files, and components to create the storefront you want.\n\nTo learn more, see [CMS - Overview](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/6OCY6S9tqBXPD5mgpbBInC).\n\n## Guides in this section\n\nIn this section, you will find the following guides.\n\n[Integrating a frontend app with Site EditorDiscover how to integrate a frontend app with Site Editor.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor)[Making a custom component available in Site EditorAllow component customization directly in Site Editor.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-a-custom-component-available-in-site-editor)[Site Editor schema examplesExplore practical schema examples for configuring custom components in Site Editor.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-site-editor-schema-examples)\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/Storefront-Guides/store-framework-working-with-site-editor.md)\n\n[Using Flex Layout« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-cms//docs/guides/vtex-io-documentation-using-flex-layout)[Integrating a frontend app with Site EditorNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-cms//docs/guides/vtex-io-documentation-integrating-frontend-app-with-site-editor)\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-cms/docs/guides/store-framework-working-with-site-editor%23before-you-begin)\n\n[Develop your Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-cms/docs/guides/store-framework-working-with-site-editor%23develop-your-store-theme)[Check the builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-cms/docs/guides/store-framework-working-with-site-editor%23check-the-builders)[Create the store pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-cms/docs/guides/store-framework-working-with-site-editor%23create-the-store-pages)[Configure your components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-cms/docs/guides/store-framework-working-with-site-editor%23configure-your-components)\n\n[Essential concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-cms/docs/guides/store-framework-working-with-site-editor%23essential-concepts)\n\n[Guides in this section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-cms/docs/guides/store-framework-working-with-site-editor%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-working-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-cms/docs/guides/store-framework-working-with-site-editor%23before-you-begin)\n\n[Develop your Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-cms/docs/guides/store-framework-working-with-site-editor%23develop-your-store-theme)[Check the builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-cms/docs/guides/store-framework-working-with-site-editor%23check-the-builders)[Create the store pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-cms/docs/guides/store-framework-working-with-site-editor%23create-the-store-pages)[Configure your components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-cms/docs/guides/store-framework-working-with-site-editor%23configure-your-components)\n\n[Essential concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-cms/docs/guides/store-framework-working-with-site-editor%23essential-concepts)\n\n[Guides in this section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-cms/docs/guides/store-framework-working-with-site-editor%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_92ea0b12
|
[
{
"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 giftcard provider protocol 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/giftcard-provider-protocol/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/docs/api-reference/giftcard-provider-protocol/)\n\nGift cards\n\nTransactions\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/docs/api-reference/giftcard-provider-protocol/)\n\nGift cards\n\nTransactions\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/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/giftcard-provider-protocol/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[GeList All GiftCard Transactions Settlements« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol/docs/api-reference/giftcard-api%23get-/giftcards/-giftCardId-/transactions/-transactionId-/settlements)[PoCreate GiftCardNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol/docs/api-reference/giftcard-provider-protocol%23post-/giftcards)\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_b112eafa
|
[
{
"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 use the page title 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/how-to-use-the-page-title-control/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-use-the-page-title-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/how-to-use-the-page-title-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/how-to-use-the-page-title-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/how-to-use-the-page-title-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/how-to-use-the-page-title-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/how-to-use-the-page-title-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/how-to-use-the-page-title-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/how-to-use-the-page-title-control/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-the-page-title-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/how-to-use-the-page-title-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/how-to-use-the-page-title-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/how-to-use-the-page-title-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/how-to-use-the-page-title-control/docs/guides/setting-up-the-zoom)\n\n[Creating gift lists](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-the-page-title-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/how-to-use-the-page-title-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/how-to-use-the-page-title-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/how-to-use-the-page-title-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/how-to-use-the-page-title-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/how-to-use-the-page-title-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/how-to-use-the-page-title-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/how-to-use-the-page-title-control/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-the-page-title-control/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-the-page-title-control/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-the-page-title-control/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-the-page-title-control/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-the-page-title-control/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-the-page-title-control/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-the-page-title-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/how-to-use-the-page-title-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/how-to-use-the-page-title-control/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-the-page-title-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/how-to-use-the-page-title-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/how-to-use-the-page-title-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/how-to-use-the-page-title-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/how-to-use-the-page-title-control/docs/guides/setting-up-the-zoom)\n\n[Creating gift lists](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-the-page-title-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/how-to-use-the-page-title-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/how-to-use-the-page-title-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/how-to-use-the-page-title-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/how-to-use-the-page-title-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/how-to-use-the-page-title-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/how-to-use-the-page-title-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/how-to-use-the-page-title-control/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-the-page-title-control/docs/storefront-development)\n\n(Legacy) CMS Portal\n\n[How to use the page title control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-the-page-title-control/docs/guides/how-to-use-the-page-title-control)\n\nHow to use the page title control\n\nThe `<vtex.cmc:searchTitle />` control displays the title of the following pages:\n\n* Department\n* Category\n* Search\n\nThat is, it displays the information entered in the category page registration screen, in the **Name** field.\n\nThe HTML code rendered by the Search Title control has the following pattern:\n\n`<h2 class=\"titulo-sessao\">Category</h2>`\n\nThat is, it renders a heading of level `<h2>`, with the `titulo-sessao` class.\n\nBy default, VTEX stores are already created with this control inserted into department and category templates.\n\nContributors\n\n1\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/how-to-use-the-page-title-control.md)\n\n[Validating a layout before moving it to production« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-the-page-title-control//docs/guides/validating-a-layout-before-moving-it-to-production)[How product name control worksNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-the-page-title-control//docs/guides/how-product-name-control-works)\n\nContributors\n\n1\n\n[](https://github.com/jumeyermattosarruda)\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/how-to-use-the-page-title-control.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_82f67242
|
[
{
"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 contextual price per shopper 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/contextual-price-per-shopper/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/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/contextual-price-per-shopper/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/contextual-price-per-shopper/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/contextual-price-per-shopper/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/contextual-price-per-shopper/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/contextual-price-per-shopper/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/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/contextual-price-per-shopper/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/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[Scheduling prices for a range of hours](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/guides/scheduling-prices-for-a-range-of-hours)\n\n[Contextual price per shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/guides/contextual-price-per-shopper)\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/contextual-price-per-shopper/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/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/contextual-price-per-shopper/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/contextual-price-per-shopper/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/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/contextual-price-per-shopper/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/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[Scheduling prices for a range of hours](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/guides/scheduling-prices-for-a-range-of-hours)\n\n[Contextual price per shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/guides/contextual-price-per-shopper)\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/contextual-price-per-shopper/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/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/contextual-price-per-shopper/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/contextual-price-per-shopper/docs/guides)\n\nPricing\n\n[Contextual price per shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/guides/contextual-price-per-shopper)\n\nContextual price per shopper\n\nContextual price allows you to define different prices for a product based on the sale context. These contexts can include criteria such as the marketplace, the seller offering the product, the buyer's geolocation, or active promotions.\n\nThis feature is ideal for scenarios where multiple sellers sell the same SKU on a marketplace but want to apply specific pricing strategies for customers or regions. Thus, the final price of the SKU can vary depending on the seller and the context of the sale.\n\n## Configuring custom prices in B2B marketplaces\n\nTo apply contextual pricing per seller in a B2B marketplace scenario, it is necessary to use the Audience Manager and Price Table Mapper APIs. These APIs enable sellers to configure custom price tables for each customer, using email addresses as a reference.\n\n### Marketplace configuration\n\nFollow the steps below to ensure that all the prerequisites are met:\n\n1. **Activate Audience Manager:** Contact [VTEX support](https://read.calvincode.net/reader?url=https://help.vtex.com/support?/cultureInfo=pt-br) and request the activation of the Audience Manager feature toggle for the Checkout module for the marketplace and seller accounts.\n2. **Allow email sharing:** Set the `trustPolicy` field to `AllowEmailSharing` and include the corresponding policy in the `policies` field when creating or updating a seller using the [POST Create Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog%5Fsystem/pvt/seller) or [PUT Update Seller endpoints](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog%5Fsystem/pvt/seller). Updating only the `trustPolicy` field is not enough both fields must be configured for email sharing to be applied correctly.\n\n### Seller configuration\n\nSellers must configure price lists associated with customer email addresses using the [Fetch audience](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/audience-api%23post-/api/audience-manager/pvt/audience?endpoint=post-/api/audience-manager/pvt/audience) endpoint of the **Audience Manager** API. This API generates a unique `audienceId` (UUID) based on the content of a JSON payload, which can be used to save price tables via the **Price Table Mapper** API.\n\nThis operation requires the buyer email as an input parameter. See the example below:\n\n#### POST - Fetch audience\n\n`https://{accountName}.{environment}.com.br/api/audience-manager/pvt/audience`\n\nRequest body\n\n`1\n\n{ \n\n2\n\n \"email\": \"email-do-comprador@email.com\" \n\n3\n\n} \n\n`\n\nIf the request is successful (**status 200 OK**), the endpoint will return an array with the ID of one or more audiences associated with the provided email, which will be used in the following steps to configure the pricing table.\n\nResponse body\n\n`1\n\n[ \n\n2\n\n \"f8cb4d62-b43a-599c-89cc-027fadaa4b18\" \n\n3\n\n] \n\n`\n\n> Any change to the payload will generate a new UUID, representing an audience created based on the updated content of the payload.\n\n## Configuring price tables\n\nWith the audience ID obtained, configure the price table using the [Set price table mapping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/audience-api%23put-/api/price-table-mapper/pvt/mapping/-audienceId-) endpoint of the **Price Table Mapper** API, where you can associate price table IDs with customer group IDs (audiences).\n\nSee the example below:\n\n### PUT - Set price table mapping\n\n`https://{accountName}.{environment}.com.br/api/price-table-mapper/pvt/mapping/{audienceId}`\n\nRequest body\n\n`1\n\n[ \n\n2\n\n \"gold-price-table\" \n\n3\n\n] \n\n`\n\nIn `{audienceId}`, use the desired audience ID. The endpoint will associate the `gold-price-table` with the `{audienceId}` and return the **status 204 No Content** indicating that the operation was successfully completed.\n\n> If there are no price tables configured for a specific customer (audienceId), the system will automatically apply the base price. Besides, the pricing strategy defined for the account, such as \"Lowest price,\" \"Highest price,\" or \"First price list,\" will influence the final price applied.\n\n## Removing a price table configuration\n\nTo remove the configuration of a price table for a specific audience, use the endpoint [Delete price table mapping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/audience-api%23delete-/api/price-table-mapper/pvt/mapping/-audienceId-).\n\n### DELETE - Delete price table mapping\n\n`https://{accountName}.{environment}.com.br/api/price-table-mapper/pvt/mapping/{audienceId}`\n\nReplace `{audienceId}` with the ID of the audience from which you want to remove the price table. After the call, the endpoint will return the **status 204 No Content**, confirming that the price table has been removed from the audience.\n\n## Recovering the price table mapping\n\nTo query the price table mapping of a specific audience, use the [GET price table mapping endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/audience-api%23get-/api/price-table-mapper/pvt/mapping/-audienceId-?endpoint=get-/api/price-table-mapper/pvt/mapping/-audienceId-).\n\n### GET - Get price table mapping\n\n`https://{accountName}.{environment}.com.br/api/price-table-mapper/pvt/mapping/{audienceId}`\n\nReplace `{audienceId}` with the ID of the audience you want to query. If the request is successful, the API will return an array containing the name of the pricing table associated with the audience ID. See the example below:\n\nResponse body\n\n`1\n\n[ \n\n2\n\n \"gold-price-table\" \n\n3\n\n] \n\n`\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/geisecosta)\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/Pricing/contextual-price-per-shopper.md)\n\n[Scheduling prices for a range of hours« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper//docs/guides/scheduling-prices-for-a-range-of-hours)[Creating and managing coupons with Promotions APINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper//docs/guides/creating-and-managing-coupons-with-promotions-api)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/geisecosta)\n\nON THIS PAGE\n\n[Configuring custom prices in B2B marketplaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/guides/contextual-price-per-shopper%23configuring-custom-prices-in-b2b-marketplaces)\n\n[Marketplace configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/guides/contextual-price-per-shopper%23marketplace-configuration)[Seller configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/guides/contextual-price-per-shopper%23seller-configuration)\n\n[Configuring price tables](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/guides/contextual-price-per-shopper%23configuring-price-tables)\n\n[PUT - Set price table mapping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/guides/contextual-price-per-shopper%23put-set-price-table-mapping)\n\n[Removing a price table configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/guides/contextual-price-per-shopper%23removing-a-price-table-configuration)\n\n[DELETE - Delete price table mapping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/guides/contextual-price-per-shopper%23delete-delete-price-table-mapping)\n\n[Recovering the price table mapping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/guides/contextual-price-per-shopper%23recovering-the-price-table-mapping)\n\n[GET - Get price table mapping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/guides/contextual-price-per-shopper%23get-get-price-table-mapping)\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/Pricing/contextual-price-per-shopper.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Configuring custom prices in B2B marketplaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/guides/contextual-price-per-shopper%23configuring-custom-prices-in-b2b-marketplaces)\n\n[Marketplace configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/guides/contextual-price-per-shopper%23marketplace-configuration)[Seller configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/guides/contextual-price-per-shopper%23seller-configuration)\n\n[Configuring price tables](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/guides/contextual-price-per-shopper%23configuring-price-tables)\n\n[PUT - Set price table mapping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/guides/contextual-price-per-shopper%23put-set-price-table-mapping)\n\n[Removing a price table configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/guides/contextual-price-per-shopper%23removing-a-price-table-configuration)\n\n[DELETE - Delete price table mapping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/guides/contextual-price-per-shopper%23delete-delete-price-table-mapping)\n\n[Recovering the price table mapping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/guides/contextual-price-per-shopper%23recovering-the-price-table-mapping)\n\n[GET - Get price table mapping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/contextual-price-per-shopper/docs/guides/contextual-price-per-shopper%23get-get-price-table-mapping)\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_2862858b
|
[
{
"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 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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/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/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/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/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/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/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/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/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/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/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/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/docs/vtex-io-apps)\n\nVTEX Store Components\n\nOfficial extension\n\nVersion: 3.178.5\n\nLatest version: 3.178.5\n\n[](#contributors-)\n\nVTEX Store Components is a collection of components that can be used to create/extend others VTEX apps.\n\n* [VTEX Store Components](#vtex-store-components) \n * [Usage](#usage) \n * [Styles API](#styles-api) \n * [Components](#components) \n * [Creating a new component](#creating-a-new-component) \n * [Project structure](#project-structure) \n * [Troubleshooting](#troubleshooting) \n * [Contributing](#contributing) \n * [Tests](#tests) \n * [Travis CI](#travis-ci) \n * [Contributors](#contributors)\n\n## Usage\n\nThe Store Components collection uses the `store` builder with the blocks architecture. Please refer to our [Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-builders) documentation to learn more about the `store` builder.\n\nTo use this app, you must import it as dependency of your project in the `manifest.json` file.\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.store-components\": \"3.x\" \n\n3\n\n } \n\n`\n\nThen, you can start adding components to your store theme app.\n\n## Styles API\n\nThe Store Components collection 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\": \"2.x\" \n\n3\n\n } \n\n`\n\n1. Create a file called `vtex.store-components.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## Components\n\nFor more information, check the documentation of all components of the Store Components collection.\n\n* [Availability Subscriber](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-store-components-availabilitysubscriber)\n* [Back To Top Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-store-components-backtotopbutton)\n* [Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-store-components-buybutton)\n* [Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-store-components-image)\n* [InfoCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-store-components-infocard)\n* [Logo](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-store-components-logo)\n* [Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-store-components-newsletter)\n* [Product Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-store-components-productbrand)\n* [Product Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-store-components-productdescription)\n* [Product Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-store-components-productimages)\n* [Product Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-store-components-productname)\n* [Product SKU Attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-store-components-productskuattributes)\n* [Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-store-components-productprice)\n* [Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-store-components-productspecifications)\n* [SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-store-components-skuselector)\n* [Search Bar](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-store-components-searchbar)\n* [Share](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-store-components-share)\n* [Shipping Simulator](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-store-components-shippingsimulator)\n* [Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-store-components-notification)\n\n> Warning\n> \n> **The following blocks have been deprecated:** `Animation`, `Categories Highlights`, `Collection Badges`, `Container`, `Discount Badge`, `Gradient Collapse`, `Greeting`, `Slider`. Despite this, support for them is still granted.\n\n## Creating a new component\n\nTo start your development, create a new folder on react/components. That's where your source code will be stored. Also create a new js file on /react, this file should be used to expose your component, like:\n\n### Project structure\n\nInside your `react/components/<component_name>` you should have:\n\n* index.js\n* README.md\n* \\[Optional\\] components/\n* \\[Optional\\] constants/\n* \\[Optional\\] utils/\n* \\[Optional\\] queries/\n* \\[Optional\\] mutations/\n* \\[Optional\\] styles.css\n\nNext, inside of `react/` folder you need to export your component, such as:\n\n`1\n\nimport ProductPrice from './components/ProductPrice/index' \n\n2\n\n \n3\n\nexport default ProductPrice \n\n`\n\nAlso, all dependencies needed should be inserted inside the react/package.json.\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/store-components/issues). Also feel free to [open issues](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-components/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[An error occurred while loading the image https://api.travis-ci.org/vtex-apps/store-components.svg?branch=master](https://read.calvincode.net/reader?url=https://travis-ci.org/vtex-apps/store-components)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)[BackToTopButtonVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/apps/vtex.store-components@3.178.5/BackToTopButton)[SKUSelectorVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/apps/vtex.store-components@3.178.5/SKUSelector)[ProductDescriptionVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/apps/vtex.store-components@3.178.5/ProductDescription)[ImageVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/apps/vtex.store-components@3.178.5/Image)[NewsletterVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/apps/vtex.store-components@3.178.5/Newsletter)[ShippingSimulatorVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/apps/vtex.store-components@3.178.5/ShippingSimulator)[InfoCardVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/apps/vtex.store-components@3.178.5/InfoCard)[ProductPriceVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/apps/vtex.store-components@3.178.5/ProductPrice)[AutocompleteResultsVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/apps/vtex.store-components@3.178.5/AutocompleteResults)[BuyButtonVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/apps/vtex.store-components@3.178.5/BuyButton)[ProductNameVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/apps/vtex.store-components@3.178.5/ProductName)[ProductHighlightsVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/apps/vtex.store-components@3.178.5/ProductHighlights)[SearchBarVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/apps/vtex.store-components@3.178.5/SearchBar)[ProductImagesVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/apps/vtex.store-components@3.178.5/ProductImages)[ProductSKUAttributesVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/apps/vtex.store-components@3.178.5/ProductSKUAttributes)[LogoVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/apps/vtex.store-components@3.178.5/Logo)[ProductBrandVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/apps/vtex.store-components@3.178.5/ProductBrand)[NotificationVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/apps/vtex.store-components@3.178.5/Notification)[ProductSpecificationsVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/apps/vtex.store-components@3.178.5/ProductSpecifications)[AvailabilitySubscriberVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/apps/vtex.store-components@3.178.5/AvailabilitySubscriber)[ShareVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/apps/vtex.store-components@3.178.5/Share)\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/apps/vtex.store-components%23usage)\n\n[Styles API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/apps/vtex.store-components%23styles-api)\n\n[Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/apps/vtex.store-components%23components)\n\n[Creating a new component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/apps/vtex.store-components%23creating-a-new-component)\n\n[Project structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/apps/vtex.store-components%23project-structure)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/apps/vtex.store-components%23troubleshooting)\n\n[Contributing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/apps/vtex.store-components%23contributing)\n\n[Tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/apps/vtex.store-components%23tests)\n\n[Travis CI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/docs/apps/vtex.store-components%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_64cc55cd
|
[
{
"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 vtex seller setup 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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/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-vtex-seller-setup/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/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-vtex-seller-setup/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/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-vtex-seller-setup/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/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-vtex-seller-setup/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/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-vtex-seller-setup/docs/guides)\n\nIntegration Guides\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/external-marketplace-integration-guide)\n\n[Store setup for VTEX Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/external-marketplace-integration-vtex-seller-setup)\n\nStore setup for VTEX Seller\n\nFor a VTEX store to act as a seller, it has to do the following for each external marketplace:\n\n* [Define channel settings](#define-channel-settings)\n* [Set up catalog notifications](#set-up-catalog-notifications)\n* [Set up API authentication credentials](#set-up-api-authentication-credentials)\n\nThis article explains what must be done to complete each of these configuration steps.\n\n---\n\n## Define channel settings\n\n[Trade policies](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-a-trade-policy--563tbcL0TYKEKeOY4IAgAE) are used in VTEX to group catalog, pricing, promotions, inventory, shipping and payments settings for different sales channels. The sections that follow describe where you can use trade policies in each of these modules.\n\nOnce all the channel settings that should be applied to the marketplace are grouped under a single trade policy, take note of the trade policy ID before you move on to the next step.\n\n> Multiple sales channels can share the same settings by using the same trade policy. [Request a new trade policy](https://read.calvincode.net/reader?url=https://help.vtex.com/en/faq/how-to-configure-a-new-trade-policy--frequentlyAskedQuestions%5F700) to be able to differentiate settings per sales channel.\n\n### Catalog\n\nWhen [adding products to your catalog](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/1ROhz3Y7mfSMmCO1I1GxEL), you may restrict their availability to certain trade policies. If no restriction is made, the product will be available in all sales channels.\n\n\n\nIn the example above, the product will be available only to the sales channels using the **B2C - USA** and **Marketplace - USA** trade policies. \n\n### Pricing\n\nWhen setting prices for your products, keep in mind that each trade policy is created with its own [price table](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/prices-101--6f8pwCns3PJHqMvQSugNfP/1wAm5m3IUfIj6maBdaRJt8). To differentiate prices between your sales channels, you may use:\n\n* [Price rules](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/prices-101--6f8pwCns3PJHqMvQSugNfP/2rBirbpB7wLnei4dQ9KGMW) to set a different markup for specific categories / brands\n* [Fixed prices](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/prices-101--6f8pwCns3PJHqMvQSugNfP/3HxF2u5VwidqnUGnFoKdDy) to set a different price for specific products \n \nIn the example above, a price rule applied an additional 10% markup to the **B2C - USA** trade policy and a fixed price of $ 500.00 was set in the **Marketplace - USA** trade policy for SKU 14.\n\n> Read about our [pricing system architecture](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/prices-101--6f8pwCns3PJHqMvQSugNfP/7GptzvlPDVM11ojEjywIQx) if these concepts are unfamiliar to you.\n\n### Promotions\n\nWhen creating promotions as a seller, you may restrict their availability to certain trade policies. If no trade policy is selected, the promotion will be available in all sales channels. The origin must be set as **Fulfillment / Delivered by me** in all promotions you offer as a seller.\n\n\n\nIn the example above, the promotion will be applied only to **Marketplace - USA** orders where the store is acting as a seller. The promotion will _not_ be available in the VTEX storefront.\n\n### Inventory\n\nWhen defining your shipping strategy, you may restrict the [logistics routes](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/logistics-101--13TFDwDttPl9ki9OXQhyjx/1xo0jmMDcnAUU5ZOavdQ7M) available to certain trade policies through loading docks. Each loading dock linked to a trade policy makes inventory available through the warehouses connected to it.\n\n\n\nIn the example above, a warehouse is connected to the **Main Warehouse Dock**. This makes its inventory available to all trade policies linked to that loading dock. \n\n### Shipping\n\nWhen defining your shipping strategy, you may restrict the [logistics routes](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/logistics-101--13TFDwDttPl9ki9OXQhyjx/1xo0jmMDcnAUU5ZOavdQ7M) available to certain trade policies through loading docks. Each loading dock linked to a trade policy makes carriers and pick-up points available through the shipping policies connected to it.\n\n\n\nIn the example above, the loading dock is linked to **B2C - USA** and **Marketplace - USA**. This makes its associated shipping policies available to those trade policies. \n\n### Payment\n\nWhen [creating a payment condition](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/payments--6GAS7ZzGAm7AGoEAwDbwJG/6bzGxlz4inf8sKmvZ1c7i3), you may restrict its availability to certain trade policies through [special conditions](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/special-conditions--tutorials%5F456). If no restriction is made, it will be available in all sales channels.\n\n\n\nIn the example above, the payment condition is linked to **Marketplace - USA**. This makes it available only to the sales channels associated with this trade policy. \n\n## Set up catalog notifications\n\nAffiliates are used in VTEX to broadcast catalog notifications to marketplaces and other external services. These include changes in product information, price and quantity in stock.\n\nTo create an affiliate for an external marketplace, go to the _Orders > Orders management > Settings_ section of your Admin, select the _Affiliates_ tab and click on the _New affiliate_ button. Then fill out the form according to the table below:\n\n| Field | Description |\n| ------------------------ | ---------------------------------------------------------------------------- |\n| Name | Marketplace display name in orders management |\n| ID | 3-consonant identifier for marketplace orders |\n| Trade Policy | ID of the trade policy [defining channel settings](#define-channel-settings) |\n| E-mail for notifications | E-mail address that will receive error notifications |\n| Search Endpoint | URL of the marketplace endpoint that will receive catalog notifications |\n\nOnce the affiliate is created, take note of the affiliate ID before you move on to the next step.\n\n> If the external marketplace connector is still under development, you may postpone filling out the _Search Endpoint_ field until its [catalog notification endpoint](#) is available.\n\n## Set up API authentication credentials\n\nTo allow the external marketplace connector to authenticate and interact with your account through API calls, you will need to [create an appKey / appToken](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication%23creating-the-appkey-and-apptoken) with the **IntegrationProfile - Fulfillment Gateway Oms** [role](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/access-profiles--7HKK5Uau2H6wxE1rH5oRbc%23integrationprofile-fulfillment-gateway-oms) or equivalent.\n\nOnce the authentication credentials are created, take note of the appKey / appToken pair so you can share it with the external marketplace.\n\n> For a matter of safety, the appToken is only shown once after you create it. Copy this token, save it in a safe place and share it only with the external marketplace.\n\n## Wrapping up\n\nIf you have done things correctly, you should be able to provide the following [seller registration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/external-marketplace-integration-connector%23seller-registration) details to the external marketplace connector:\n\n* Account Name\n* Affiliate ID\n* API Credentials\n* Trade Policy ID\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-vtex-seller-setup.md)\n\n[Marketplace / Seller architecture« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup//docs/guides/external-marketplace-integration-architecture)[Creating an integration app from a TemplateNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup//docs/guides/external-marketplace-integration-app-template)\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[Define channel settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/external-marketplace-integration-vtex-seller-setup%23define-channel-settings)\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/external-marketplace-integration-vtex-seller-setup%23catalog)[Pricing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/external-marketplace-integration-vtex-seller-setup%23pricing)[Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/external-marketplace-integration-vtex-seller-setup%23promotions)[Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/external-marketplace-integration-vtex-seller-setup%23inventory)[Shipping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/external-marketplace-integration-vtex-seller-setup%23shipping)[Payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/external-marketplace-integration-vtex-seller-setup%23payment)\n\n[Set up catalog notifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/external-marketplace-integration-vtex-seller-setup%23set-up-catalog-notifications)\n\n[Set up API authentication credentials](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/external-marketplace-integration-vtex-seller-setup%23set-up-api-authentication-credentials)\n\n[Wrapping up](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/external-marketplace-integration-vtex-seller-setup%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/external-marketplace-integration-guide/external-marketplace-integration-vtex-seller-setup.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Define channel settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/external-marketplace-integration-vtex-seller-setup%23define-channel-settings)\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/external-marketplace-integration-vtex-seller-setup%23catalog)[Pricing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/external-marketplace-integration-vtex-seller-setup%23pricing)[Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/external-marketplace-integration-vtex-seller-setup%23promotions)[Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/external-marketplace-integration-vtex-seller-setup%23inventory)[Shipping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/external-marketplace-integration-vtex-seller-setup%23shipping)[Payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/external-marketplace-integration-vtex-seller-setup%23payment)\n\n[Set up catalog notifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/external-marketplace-integration-vtex-seller-setup%23set-up-catalog-notifications)\n\n[Set up API authentication credentials](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/external-marketplace-integration-vtex-seller-setup%23set-up-api-authentication-credentials)\n\n[Wrapping up](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-vtex-seller-setup/docs/guides/external-marketplace-integration-vtex-seller-setup%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_1d531cf7
|
[
{
"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 select 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-select/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-select/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-select/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-select/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-select/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-select/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-select/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-select/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-select/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/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-select/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/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-select/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-overview)\n\n[Badge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-badge)\n\n[Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-button)\n\n[Checkbox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-checkbox)\n\n[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-icon)\n\n[Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-input)\n\n[Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-label)\n\n[Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-link)\n\n[List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-list)\n\n[Loader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-loader)\n\n[Overlay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-overlay)\n\n[Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-price)\n\n[Radio](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-radio)\n\n[Select](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-select)\n\n[SROnly](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-sr-only)\n\n[Skeleton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-skeleton)\n\n[Slider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-slider)\n\n[Textarea](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-textarea)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/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-select/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-select/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-select/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-select/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/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-select/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-select/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/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-select/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-select/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/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-select/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/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-select/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-overview)\n\n[Badge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-badge)\n\n[Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-button)\n\n[Checkbox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-checkbox)\n\n[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-icon)\n\n[Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-input)\n\n[Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-label)\n\n[Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-link)\n\n[List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-list)\n\n[Loader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-loader)\n\n[Overlay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-overlay)\n\n[Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-price)\n\n[Radio](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-radio)\n\n[Select](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-select)\n\n[SROnly](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-sr-only)\n\n[Skeleton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-skeleton)\n\n[Slider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-slider)\n\n[Textarea](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-textarea)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/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-select/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-select/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-select/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-select/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/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-select/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-select/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-select/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-overview)\n\nSelect\n\nSelects allow users to pick an option from a predefined list.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/atoms/Select)\n\nSelect components allow users to pick an option from a predefined list. The Select component should be used when there are more than five options available. Otherwise, consider using the [RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group) component.\n\nTypical use cases include:\n\n* Filtering product listings (e.g., sorting by price, name, or popularity).\n* Choosing shipping methods or delivery options.\n* Selecting product variants (e.g., size, color, or quantity).\n\nExample\n\nCode\n\nGreatOkBad\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { Select } 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/Select/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### Variants\n\n#### Disabled\n\nExample\n\nCode\n\nGreatOkBad\n\n---\n\n## Design tokens\n\n| Local token | Default value/Global token linked |\n| -------------------------------- | ------------------------------------------------------------------------------- |\n| \\--fs-select-height | var(--fs-spacing-6) |\n| \\--fs-select-min-height | var(--fs-control-tap-size) |\n| \\--fs-select-padding | var(--fs-spacing-1) var(--fs-spacing-5) var(--fs-spacing-1) var(--fs-spacing-2) |\n| \\--fs-select-text-color | var(--fs-color-link) |\n| \\--fs-select-border-radius | var(--fs-border-radius) |\n| \\--fs-select-bkg | transparent |\n| \\--fs-select-bkg-color-focus | var(--fs-color-primary-bkg-light) |\n| \\--fs-select-bkg-color-hover | var(--fs-select-bkg-color-focus) |\n| \\--fs-select-transition-timing | var(--fs-transition-timing) |\n| \\--fs-select-transition-property | var(--fs-transition-property) |\n| \\--fs-select-transition-function | var(--fs-transition-function) |\n\n### Design tokens: Icon\n\nThe Select component includes a dropdown icon to indicate the interactive nature of the field and to provide a visual cue for user interaction.\n\n| Local token | Default value/Global token linked |\n| -------------------------------- | --------------------------------- |\n| \\--fs-select-icon-color | var(--fs-color-link) |\n| \\--fs-select-icon-position-right | var(--fs-spacing-2) |\n| \\--fs-select-icon-width | var(--fs-spacing-3) |\n| \\--fs-select-icon-height | var(--fs-select-icon-width) |\n\n### Design tokens: Disabled\n\nDisabled selects use reduced opacity and alternative text colors to communicate that the field is not currently interactive.\n\n| Local token | Default value/Global token linked |\n| ---------------------------------- | --------------------------------- |\n| \\--fs-select-disabled-text-color | var(--fs-color-disabled-text) |\n| \\--fs-select-disabled-text-opacity | 1 |\n\n---\n\n## Data attributes\n\nYou can target and override `Select` styles using the following data attributes:\n\n`data-fs-select`\n\n`data-fs-select-icon`\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-select |\n| **id\\*** | string | Assigns an identifier to link the UISelect component and its label. | |\n| **options\\*** | Record<string, string> | Defines the options available in the select. The SelectOptions object keys are the property names, while the values correspond to the text that will be displayed in the UI. | |\n\n---\n\n## Best Practices\n\n### ✅ Do's\n\n* Consider using a [RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group) when few options are available. Doing so will prevent users from opening a dropdown box just to scan how many and which options are available.\n* Consider using an open text [Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input) when several options are available and if the entries don’t need to be validated. Doing so will prevent users from having to read and understand all options before making a choice.\n* Consider using an autocomplete field when multiple options are available and if the inputs need to be validated.\n* Opt to grey out unavailable items instead of removing them completely.\n\n---\n\n## Related components\n\n* Order by: \nName, A-ZName, Z-ATop Sales \nSelectField \nSelectField wraps a Select input and its corresponding Label. It allows users to select one option from a set. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/molecules-select-field)\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/atoms/select.mdx)\n\n[Radio« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-radio)[SROnlyNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-sr-only)\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/atoms-select/docs/guides/faststore/atoms-select%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-select%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-select%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-select%23examples)\n\n[Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-select%23variants)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-select%23design-tokens)\n\n[Design tokens: Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-select%23design-tokens-icon)[Design tokens: Disabled](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-select%23design-tokens-disabled)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-select%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-select%23props)\n\n[Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-select%23best-practices)\n\n[✅ Do's](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-select%23-dos)\n\n[Related components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-select%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/select.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-select/docs/guides/faststore/atoms-select%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-select%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-select%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-select%23examples)\n\n[Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-select%23variants)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-select%23design-tokens)\n\n[Design tokens: Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-select%23design-tokens-icon)[Design tokens: Disabled](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-select%23design-tokens-disabled)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-select%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-select%23props)\n\n[Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-select%23best-practices)\n\n[✅ Do's](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-select%23-dos)\n\n[Related components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-select/docs/guides/faststore/atoms-select%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=)"
}
] |
doc_201d26e2
|
[
{
"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 buy 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-buy-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-buy-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-buy-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-buy-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-buy-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-buy-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-buy-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-buy-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-buy-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-buy-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-buy-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-buy-button/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-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-buy-button/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-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-buy-button/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-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-buy-button/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-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-buy-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-buy-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-buy-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-buy-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-buy-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-buy-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-buy-button/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-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-buy-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-buy-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-buy-button/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-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-buy-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-buy-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-buy-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-buy-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-buy-button/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-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-buy-button/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-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-buy-button/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-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-buy-button/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-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-buy-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-buy-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-buy-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-buy-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-buy-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-buy-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-buy-button/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-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-buy-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-buy-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-buy-button/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/components-index)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-overview)\n\nBuyButton\n\nSends the user to the checkout/cart step directly.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/BuyButton)\n\nThe `BuyButton` component intends to send the user to the checkout/cart step directly.\n\nExample\n\nCode\n\nBuy Now\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { BuyButton } 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/BuyButton/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-buy-button-text-color | var(--fs-color-action-text) |\n| \\--fs-buy-button-text-color-hover | var(--fs-color-action-text) |\n| \\--fs-buy-button-text-color-active | var(--fs-color-action-text) |\n| \\--fs-buy-button-bkg-color | var(--fs-color-action-bkg) |\n| \\--fs-buy-button-bkg-color-hover | var(--fs-color-action-bkg-hover) |\n| \\--fs-buy-button-bkg-color-active | var(--fs-color-action-bkg-active) |\n| \\--fs-buy-button-border-color | var(--fs-color-action-bkg) |\n| \\--fs-buy-button-border-color-hover | var(--fs-color-action-bkg-hover) |\n| \\--fs-buy-button-border-color-active | var(--fs-color-action-bkg-active) |\n| \\--fs-buy-button-shadow-hover | var(--fs-button-shadow-hover) |\n\n---\n\n## Data attributes\n\nYou can target and override `BuyButton` styles using the following data attributes:\n\n`data-fs-buy-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-buy-button | | | | | | |\n| **variant** | \"primary\" \\| \"secondary\" | \"tertiary\" | Specifies the component color variant. | | | | | | |\n| **size** | \"small\" \\| \"regular\" | Specifies the size variant. | | | | | | | |\n| **inverse** | false \\| true | Defines the use of inverted colors. | | | | | | | |\n| **disabled** | false \\| true | Specifies that this button should be disabled. | | | | | | | |\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| **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 this special Button only to send the user to the checkout/cart step directly. For general purposes, use the standard [Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button).\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/buy-button.mdx)\n\n[Breadcrumb« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-breadcrumb)[CardNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-card)\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-buy-button/docs/guides/faststore/molecules-buy-button%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-buy-button%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-buy-button%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-buy-button%23design-tokens)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-buy-button%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-buy-button%23props)\n\n[Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-buy-button%23best-practices)\n\n[✅ Do's](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-buy-button%23-dos)\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/buy-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-buy-button/docs/guides/faststore/molecules-buy-button%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-buy-button%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-buy-button%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-buy-button%23design-tokens)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-buy-button%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-buy-button%23props)\n\n[Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-buy-button%23best-practices)\n\n[✅ Do's](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button/docs/guides/faststore/molecules-buy-button%23-dos)\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_83439edd
|
[
{
"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 customizing your stores icons 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-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/docs/guides/store-framework-styling)\n\n[Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization)\n\n[Contributing with new CSS Handles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/guides/vtex-io-documentation-contributing-with-new-css-handles)\n\n[Customizing your store's icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/guides/vtex-io-documentation-customizing-your-stores-icons)\n\n[Customizing your store’s typography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/guides/vtex-io-documentation-customizing-your-stores-typography)\n\n[Interactively inspecting storefront blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store)\n\n[Using the Markers prop to customize a block's message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/docs/guides/store-framework-styling)\n\n[Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization)\n\n[Contributing with new CSS Handles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/guides/vtex-io-documentation-contributing-with-new-css-handles)\n\n[Customizing your store's icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/guides/vtex-io-documentation-customizing-your-stores-icons)\n\n[Customizing your store’s typography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/guides/vtex-io-documentation-customizing-your-stores-typography)\n\n[Interactively inspecting storefront blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store)\n\n[Using the Markers prop to customize a block's message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/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-customizing-your-stores-icons/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/guides/store-framework)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/guides/store-framework-styling)\n\n[Customizing your store's icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/guides/vtex-io-documentation-customizing-your-stores-icons)\n\nCustomizing your store's icons\n\nThe [VTEX Styleguide](https://read.calvincode.net/reader?url=https://styleguide.vtex.com) provides a [default iconography](https://read.calvincode.net/reader?url=https://styleguide.vtex.com/%23/Icons) used across all Store Framework components, which is implemented via the [Store Icons](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons) app.\n\nWhile these icons are suitable for most stores, you can customize them to better align with your store's branding. Follow the steps below to override the default icons.\n\n## Before you begin\n\nEnsure that your Store Theme is using the [styles builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-styles-builder) at version 1.8.1 or higher.\n\n## Instructions\n\n### Step 1 - Creating an icon pack\n\n1. In your Store Theme, create a new folder named `iconpacks` within the `styles` folder.\n2. Inside the `iconpacks` folder, create a file named `iconpack.svg`.\n3. Copy the content of the [iconpack.svg](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/master/styles/iconpacks/iconpack.svg?short%5Fpath=62ebf4b) file and paste it into your `iconpack.svg` file.\n\n### Step 2 - Customizing icons\n\nThe `iconpack.svg` file contains all the store's icons, with each icon having a unique `id` and grouped inside a `<g>` tag. These `id`s allow you to reference and modify individual icons.\n\nEach icon is identified by an `id` within its `<g>` tag (e.g., `hpa-cart` for the cart icon). You can reference and modify a specific icon in the store’s code using its fragment identifierl, like `#hpa-cart`.\n\nTo customize an icon, find its corresponding `<g>` tag by `id` in the `iconpack.svg` file and adjust its content (shapes, paths, etc.). You don't need to recreate the entire icon — just modify the parts you want to change.\n\nFor example, to customize the cart icon (`hpa-cart`), you only need to modify the elements within its `<g>` tag:\n\nstyles/iconpacks/iconpack.svg\n\n`1\n\n<g id=\"hpa-cart\"> \n\n2\n\n <path d=\"M15.0503 3.0002H4.92647C4.81221 3.00072 4.7012 2.96234 4.6118 2.89142C4.52239 2.8205 4.45996 2.72129 4.43483 2.6102L4.01342 0.800203C3.96651 0.570928 3.84041 0.365306 3.65708 0.219131C3.47375 0.0729566 3.24479 -0.00451449 3.01006 0.000203439H0.501677C0.368624 0.000203439 0.241021 0.0528819 0.146938 0.14665C0.0528551 0.240418 0 0.367595 0 0.500203L0 1.5002C0 1.63281 0.0528551 1.75999 0.146938 1.85376C0.241021 1.94753 0.368624 2.0002 0.501677 2.0002H1.80604C1.92077 1.9978 2.03274 2.03548 2.12253 2.10671C2.21232 2.17794 2.27429 2.27823 2.29768 2.3902L4.01342 10.2002C4.06032 10.4295 4.18642 10.6351 4.36975 10.7813C4.55308 10.9274 4.78204 11.0049 5.01677 11.0002H13.0436C13.2478 10.9891 13.4436 10.9161 13.605 10.791C13.7664 10.6659 13.8856 10.4947 13.9466 10.3002L15.9533 4.3002C15.9995 4.15468 16.0116 4.00057 15.9888 3.84965C15.9659 3.69874 15.9088 3.55504 15.8216 3.42956C15.7344 3.30408 15.6196 3.20015 15.4859 3.12573C15.3522 3.0513 15.2032 3.00837 15.0503 3.0002Z\" fill=\"currentColor\"/> \n\n3\n\n <path d=\"M5.02682 16.0002C6.13509 16.0002 7.03353 15.1048 7.03353 14.0002C7.03353 12.8956 6.13509 12.0002 5.02682 12.0002C3.91855 12.0002 3.02011 12.8956 3.02011 14.0002C3.02011 15.1048 3.91855 16.0002 5.02682 16.0002Z\" fill=\"currentColor\"/> \n\n4\n\n <path d=\"M13.0737 16.0002C14.182 16.0002 15.0804 15.1048 15.0804 14.0002C15.0804 12.8956 14.182 12.0002 13.0737 12.0002C11.9655 12.0002 11.067 12.8956 11.067 14.0002C11.067 15.1048 11.9655 16.0002 13.0737 16.0002Z\" fill=\"currentColor\"/> \n\n5\n\n</g> \n\n`\n\n> To find each icon’s unique `id`, refer to the [Icon Pack list](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-icons/blob/cbbb1b82bfca247a811d146b1e2cafb642db1928/docs/ICONPACK.md) This allows you to customize individual icons without affecting the entire icon set.\n\n### Step 3 - Applying your changes\n\nOnce you've made the desired changes, [link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app) your app to see the updated icons reflected in the store.\n\n\n\n> If the changes don't appear after linking, ensure the `styles` builder version is 1.8.1 or higher.\n\n## Best practices\n\n* Icons should not exceed `20x20` pixels.\n* Each [workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace) can only have one app installed that includes `iconpack` customizations.\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/styling-your-store/vtex-io-documentation-customizing-your-stores-icons.md)\n\n[Contributing with new CSS Handles« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons//docs/guides/vtex-io-documentation-contributing-with-new-css-handles)[Customizing your store’s typographyNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons//docs/guides/vtex-io-documentation-customizing-your-stores-typography)\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-customizing-your-stores-icons/docs/guides/vtex-io-documentation-customizing-your-stores-icons%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/guides/vtex-io-documentation-customizing-your-stores-icons%23instructions)\n\n[Step 1 - Creating an icon pack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/guides/vtex-io-documentation-customizing-your-stores-icons%23step-1-creating-an-icon-pack)[Step 2 - Customizing icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/guides/vtex-io-documentation-customizing-your-stores-icons%23step-2-customizing-icons)[Step 3 - Applying your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/guides/vtex-io-documentation-customizing-your-stores-icons%23step-3-applying-your-changes)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/guides/vtex-io-documentation-customizing-your-stores-icons%23best-practices)\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/styling-your-store/vtex-io-documentation-customizing-your-stores-icons.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-customizing-your-stores-icons/docs/guides/vtex-io-documentation-customizing-your-stores-icons%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/guides/vtex-io-documentation-customizing-your-stores-icons%23instructions)\n\n[Step 1 - Creating an icon pack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/guides/vtex-io-documentation-customizing-your-stores-icons%23step-1-creating-an-icon-pack)[Step 2 - Customizing icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/guides/vtex-io-documentation-customizing-your-stores-icons%23step-2-customizing-icons)[Step 3 - Applying your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/guides/vtex-io-documentation-customizing-your-stores-icons%23step-3-applying-your-changes)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons/docs/guides/vtex-io-documentation-customizing-your-stores-icons%23best-practices)\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_61fcf350
|
[
{
"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 update order status 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-update-order-status/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-update-order-status/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-update-order-status/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-update-order-status/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-update-order-status/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-update-order-status/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-update-order-status/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/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-update-order-status/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/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-update-order-status/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/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-update-order-status/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-update-order-status/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-update-order-status/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-update-order-status/docs/guides/external-marketplace-integration-catalog)\n\n[Catalog logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/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-update-order-status/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-update-order-status/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-update-order-status/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-update-order-status/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-update-order-status/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-update-order-status/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-update-order-status/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/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-update-order-status/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-update-order-status/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-update-order-status/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-update-order-status/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-update-order-status/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-update-order-status/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/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-update-order-status/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-update-order-status/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/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-update-order-status/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-update-order-status/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/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-update-order-status/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/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-update-order-status/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/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-update-order-status/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-update-order-status/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-update-order-status/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-update-order-status/docs/guides/external-marketplace-integration-catalog)\n\n[Catalog logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/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-update-order-status/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-update-order-status/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-update-order-status/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-update-order-status/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-update-order-status/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-update-order-status/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-update-order-status/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/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-update-order-status/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-update-order-status/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-update-order-status/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-update-order-status/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-update-order-status/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-update-order-status/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/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-update-order-status/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-update-order-status/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/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-update-order-status/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-update-order-status/docs/guides)\n\nIntegration Guides\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/external-marketplace-integration-guide)\n\n[Update Order Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/external-marketplace-update-order-status)\n\nUpdate Order Status\n\n> If you used our previous method for integrating orders, you can still find their documentation in [Order Logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-order-logs) and [How to collect orders from sales channels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels). The previous method, however, will not be maintained. If you are integrating orders for the first time, we recommend you use the instructions in this article.\n\nThe order flow describes the status, possibilities, and actions throughout the life cycle of an order. With the flow, retailers can also track the mapped order status on the platform. Learn more in [Order flow and status](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials%5F196%23order-status-details).\n\nIt’s important to note that when sending a request to update the order status, if the order is not currently in the correct status at VTEX to advance to the requested one, an error will be returned. That means that the connector has to manage when a status should be updated or not. For example:\n\n* If the order is in the `waiting-for-manual-authorization` status at VTEX, that means the order has a price divergence, and we need to wait for the seller to either reject this order (cancel) or authorize it. Sending an order approval while the order is in this status will fail (with a code `EOI011`) since the seller hasn’t authorized the integration of the order yet.\n* In this case, it’s recommended for the connector to try to approve the order at a later time, after receiving the error from Channel Order API, and keep trying until the seller takes action and the status change.\n* Another option is to use [Order hooks and feeds](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-feed) from our OMS VTEX module. That way the connector can know when the order status was updated and the approval can be sent.\n\n## API Reference: Update order status\n\nUse the request example below to update the status of an order. The description and requirement of each of the fields present in the request body are found in our [Update Order Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders%23put-/api/order-integration/orders/status) API Reference.\n\n### Request body\n\n`1\n\n{ \n\n2\n\n \"marketplaceOrderId\": string, \n\n3\n\n \"connectorName\": string, \n\n4\n\n \"connectorEndpoint\": string, \n\n5\n\n \"marketplaceOrderStatus\": string \n\n6\n\n} \n\n`\n\n### Order Notification Results\n\n* **Error** \n * EOI000 - Unknown error \n * EOI001 - Unmapped error \n * EOI008 - Cannot approve an order that is not integrated yet \n * EOI009 - Order out of valid status to approve\n* **Success** \n * SOI002 - Order approved\n\n### Response\n\n`1\n\n{ \n\n2\n\n \"marketplaceOrderId\": \"123456789\", \n\n3\n\n \"accountName\": null, \n\n4\n\n \"code\": \"SOI003\", \n\n5\n\n \"flow\": \"ApproveOrder\", \n\n6\n\n \"success\": true, \n\n7\n\n \"operationId\": null, \n\n8\n\n \"errors\": null, \n\n9\n\n \"fields\": null, \n\n10\n\n \"message\": \"Order successfully enqueued\" \n\n11\n\n} \n\n`\n\n### Notification\n\n`1\n\n{ \n\n2\n\n \"marketplaceOrderId\": \"123456789\", \n\n3\n\n \"accountName\": \"connections\", \n\n4\n\n \"code\": \"SOI002\", \n\n5\n\n \"flow\": \"ApproveOrder\", \n\n6\n\n \"success\": true, \n\n7\n\n \"operationId\": \"ca254d31-c547-4693-9532-72e060264a88\", \n\n8\n\n \"errors\": null, \n\n9\n\n \"fields\": { \n\n10\n\n \"mainOrderId\": \"MKP-123456789\", \n\n11\n\n \"franchiseOrderId\": null \n\n12\n\n }, \n\n13\n\n \"message\": \"Order approved successfully\" \n\n14\n\n} \n\n`\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\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-update-order-status.md)\n\n[New Order Integration« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status//docs/guides/external-marketplace-integration-collect-orders)[How to validate if items are available for deliveryNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status//docs/guides/external-marketplace-integration-delivery-validation)\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[API Reference: Update order status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/external-marketplace-update-order-status%23api-reference-update-order-status)\n\n[Request body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/external-marketplace-update-order-status%23request-body)[Order Notification Results](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/external-marketplace-update-order-status%23order-notification-results)[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/external-marketplace-update-order-status%23response)[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/external-marketplace-update-order-status%23notification)\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-update-order-status.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[API Reference: Update order status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/external-marketplace-update-order-status%23api-reference-update-order-status)\n\n[Request body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/external-marketplace-update-order-status%23request-body)[Order Notification Results](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/external-marketplace-update-order-status%23order-notification-results)[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/external-marketplace-update-order-status%23response)[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status/docs/guides/external-marketplace-update-order-status%23notification)\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_5694fb42
|
[
{
"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 vtex ads 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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-api/docs/api-reference/vtex-ads-api/)\n\nCatalog synchronization\n\nAds events notification\n\nAds\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-ads-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-ads-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-ads-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-ads-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-ads-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-api/docs/api-reference/vtex-ads-api/)\n\nCatalog synchronization\n\nAds events notification\n\nAds\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-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/vtex-ads-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[PoEdit Subscriptions settings« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-ads-api/docs/api-reference/subscriptions-api-v3%23post-/api/rns/settings)[PoSynchronize product informationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-ads-api/docs/api-reference/vtex-ads-api%23post-/product/bulk/products)\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_9311af93
|
[
{
"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 summary 2.91.0 ProductSummarySpecificationBadges 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-summary@2.91.0/ProductSummarySpecificationBadges/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-summary@2.91.0/ProductSummarySpecificationBadges/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-summary@2.91.0/ProductSummarySpecificationBadges/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-summary@2.91.0/ProductSummarySpecificationBadges/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-summary@2.91.0/ProductSummarySpecificationBadges/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-summary@2.91.0/ProductSummarySpecificationBadges/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-summary@2.91.0/ProductSummarySpecificationBadges/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-summary@2.91.0/ProductSummarySpecificationBadges/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySpecificationBadges/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySpecificationBadges/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySpecificationBadges/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySpecificationBadges/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-summary@2.91.0/ProductSummarySpecificationBadges/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySpecificationBadges/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySpecificationBadges/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-summary@2.91.0/ProductSummarySpecificationBadges/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-summary@2.91.0/ProductSummarySpecificationBadges/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-summary@2.91.0/ProductSummarySpecificationBadges/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySpecificationBadges/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySpecificationBadges/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySpecificationBadges/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySpecificationBadges/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySpecificationBadges/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySpecificationBadges/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-summary@2.91.0/ProductSummarySpecificationBadges/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySpecificationBadges/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySpecificationBadges/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySpecificationBadges/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySpecificationBadges/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-summary@2.91.0/ProductSummarySpecificationBadges/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySpecificationBadges/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySpecificationBadges/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-summary@2.91.0/ProductSummarySpecificationBadges/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-summary@2.91.0/ProductSummarySpecificationBadges/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-summary@2.91.0/ProductSummarySpecificationBadges/docs/vtex-io-apps)\n\nProduct Specification Badges\n\n[vtex.product-summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary)\n\nVersion: 2.91.0\n\nLatest version: 2.91.0\n\n\n\n> The Product Specification Badges block has been deprecated in favor of the [Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-product-specifications) app. Although support for this block is still available, we strongly recommend that you update your store theme with the Product Specifications app to stay up with the component's evolution.\n\nUse this component to show badges based on your product specifications inside your product page.\n\n### Configuration\n\nThis component must be configured to be able to display the specifications properly. Its props can be configured via `blocks.json` and they are:\n\n| Prop name | Type | Description | Default value |\n| ---------------------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| specificationGroupName | String | The name of the specification group in which the desired specifications are | \"\" |\n| specificationName | String | Pass the name of the specification you want to target. If left empy, will target all of the group | \"\" |\n| visibleWhen | String | Pass this if you want the specification to be displayed only if it has this exact value. If left empty, the badge will be showed regardless of the specification value. | \"\" |\n| displayValue | SPECIFICATION\\_NAME or SPECIFICATION\\_VALUE or string | Choose the value that will appear if the specification condition is met and the badge will be showed. Pass SPECIFICATION\\_NAME if you want to display the specification name. Pass SPECIFICATION\\_VALUE if you want to display its value. Pass any other custom string to display it. | null |\n| specificationsOptions | Array<Option> | Pass this if you want to control the conditions to show certain specifications. Each value of the array should be a valid object of the Option format. | null |\n| orientation | vertical or horizontal | Determines if the group of specifications are showed horizontally or vertically | vertical |\n| blockClass | string | Allows to pass a custom name to be added to component css classes | null |\n\n`Option` type:\n\n| Prop name | Type | Description | Default value |\n| ----------------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| specificationName | String | Pass the name of the specification you want to target. If empty, option will not be checked. | \"\" |\n| visibleWhen | string | Pass this if you want this option to be applied when the specification has the exactly same value as specified in visibleWhen. If left empty, the badge will be showed regardless of the specification value. | null |\n| displayValue | SPECIFICATION\\_NAME or SPECIFICATION\\_VALUE or string | Choose the value that will appear if the option condition is met and the badge will be showed. Pass SPECIFICATION\\_NAME if you want to show the specification name. Pass SPECIFICATION\\_VALUE if you want to show its value. Pass any other custom string to show it. | null |\n\nImportant note: All products come with a default `allSpecifications` group, that is a group that combines all specifications in your product. If you manually create another group and add a specification in it, this specification will also appear in the `allSpecifications` group. So, if you want to apply your conditions to all specification, regardless of group, you must pass the value `allSpecifications`.\n\n### Example 1\n\nLet's say your product has this specification groups:\n\n`1\n\n// specificationGroups array \n\n2\n\n[ \n\n3\n\n { \n\n4\n\n name: 'Group', \n\n5\n\n specifications: [ \n\n6\n\n { \n\n7\n\n name: 'On Sale', \n\n8\n\n values: ['True'], \n\n9\n\n }, \n\n10\n\n ], \n\n11\n\n }, \n\n12\n\n { \n\n13\n\n name: 'Group 2', \n\n14\n\n specifications: [ \n\n15\n\n { \n\n16\n\n name: 'Demo', \n\n17\n\n values: ['True'], \n\n18\n\n }, \n\n19\n\n { \n\n20\n\n name: 'PromoExclusion', \n\n21\n\n values: ['1'], \n\n22\n\n } \n\n23\n\n ], \n\n24\n\n }, \n\n25\n\n { \n\n26\n\n name: 'allSpecifications', \n\n27\n\n specifications: [ \n\n28\n\n { \n\n29\n\n name: 'On Sale', \n\n30\n\n values: ['True'], \n\n31\n\n }, \n\n32\n\n { \n\n33\n\n name: 'Demo', \n\n34\n\n values: ['True'], \n\n35\n\n }, \n\n36\n\n { \n\n37\n\n name: 'PromoExclusion', \n\n38\n\n values: ['1'], \n\n39\n\n }, \n\n40\n\n ], \n\n41\n\n }, \n\n42\n\n ] \n\n`\n\nIf you want to display all specifications with the value `True`, you could then pass:\n\n`1\n\n\"product-specification-badges\": { \n\n2\n\n \"props\": { \n\n3\n\n \"specificationGroupName\": \"allSpecifications\", \n\n4\n\n \"displayValue\": \"SPECIFICATION_NAME\", \n\n5\n\n \"visibleWhen\": \"True\" \n\n6\n\n } \n\n7\n\n }, \n\n`\n\nIn this case, it will appear the `On Sale` and `Demo` badges (because you passed the `SPECIFICATION_NAME` in `displayValue`).\n\n### Example 2\n\nUsing the specification groups from example 1, we can get the same result with the specificationOptions prop:\n\n`1\n\n \"product-specification-badges\": { \n\n2\n\n \"props\": { \n\n3\n\n \"specificationGroupName\": \"allSpecifications\", \n\n4\n\n \"specificationsOptions\": [{ \n\n5\n\n \"specificationName\": \"On Sale\", \n\n6\n\n \"displayValue\": \"SPECIFICATION_NAME\", \n\n7\n\n \"visibleWhen\": \"True\" \n\n8\n\n }, \n\n9\n\n { \n\n10\n\n \"specificationName\": \"Demo\", \n\n11\n\n \"displayValue\": \"SPECIFICATION_NAME\", \n\n12\n\n \"visibleWhen\": \"True\" \n\n13\n\n }] \n\n14\n\n } \n\n15\n\n }, \n\n`\n\n### Example 3\n\n`1\n\n// specificationGroups array \n\n2\n\n[ \n\n3\n\n { \n\n4\n\n name: 'Group', \n\n5\n\n specifications: [ \n\n6\n\n { \n\n7\n\n name: 'On Sale', \n\n8\n\n values: ['True'], \n\n9\n\n }, \n\n10\n\n ], \n\n11\n\n }, \n\n12\n\n { \n\n13\n\n name: 'Group 2', \n\n14\n\n specifications: [ \n\n15\n\n { \n\n16\n\n name: 'Demo', \n\n17\n\n values: ['True'], \n\n18\n\n }, \n\n19\n\n { \n\n20\n\n name: 'PromoExclusion', \n\n21\n\n values: ['1'], \n\n22\n\n } \n\n23\n\n ], \n\n24\n\n }, \n\n25\n\n { \n\n26\n\n name: 'allSpecifications', \n\n27\n\n specifications: [ \n\n28\n\n { \n\n29\n\n name: 'On Sale', \n\n30\n\n values: ['True'], \n\n31\n\n }, \n\n32\n\n { \n\n33\n\n name: 'Demo', \n\n34\n\n values: ['My Cool Value'], \n\n35\n\n }, \n\n36\n\n { \n\n37\n\n name: 'PromoExclusion', \n\n38\n\n values: ['1'], \n\n39\n\n }, \n\n40\n\n ], \n\n41\n\n }, \n\n42\n\n ] \n\n`\n\nIf you want to show the value for the `Demo`\u001d specification, you could pass:\n\n`1\n\n \"product-specification-badges\": { \n\n2\n\n \"props\": { \n\n3\n\n \"specificationGroupName\": \"allSpecifications\", \n\n4\n\n \"specificationsOptions\": [{ \n\n5\n\n \"specificationName\": \"On Sale\", \n\n6\n\n \"displayValue\": \"SPECIFICATION_NAME\", \n\n7\n\n \"visibleWhen\": \"True\" \n\n8\n\n }, \n\n9\n\n { \n\n10\n\n \"specificationName\": \"Demo\", \n\n11\n\n \"displayValue\": \"SPECIFICATION_VALUE\", \n\n12\n\n }] \n\n13\n\n } \n\n14\n\n }, \n\n`\n\nFinal result: will appear the `On Sale` badge and a badge with `My Cool Value`.\n\nNote the use of `SPECIFICATION_VALUE` in `displayValue` and the lack of `visibleWhen` in `Demo`.\n\n### Example 4\n\nUsing the example given in example 3.\n\nTo show a custom string you could do:\n\n`1\n\n \"product-specification-badges\": { \n\n2\n\n \"props\": { \n\n3\n\n \"specificationGroupName\": \"allSpecifications\", \n\n4\n\n \"specificationsOptions\": [{ \n\n5\n\n \"specificationName\": \"On Sale\", \n\n6\n\n \"displayValue\": \"SPECIFICATION_NAME\", \n\n7\n\n \"visibleWhen\": \"True\" \n\n8\n\n }, \n\n9\n\n { \n\n10\n\n \"specificationName\": \"Demo\", \n\n11\n\n \"displayValue\": \"SPECIFICATION_VALUE\", \n\n12\n\n }, \n\n13\n\n { \n\n14\n\n \"specificationName\": \"PromoExclusion\", \n\n15\n\n \"displayValue\": \"Cool Promo\", \n\n16\n\n }] \n\n17\n\n } \n\n18\n\n }, \n\n`\n\nFinal result: will appear the `On Sale` badge, a badge with `My Cool Value` and a badge with the string `Cool Promo`.\n\nNote the usage of a custom value in the `displayValue` config.\n\n### Usage tip\n\nYou can use our `stack-layout` to show the badges over your product image for example.\n\n`1\n\n \"stack-layout\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"product-images\", \n\n4\n\n \"product-specification-badges\" \n\n5\n\n ] \n\n6\n\n }, \n\n7\n\n \n8\n\n \"product-specification-badges\": { \n\n9\n\n \"props\": { \n\n10\n\n \"specificationGroupName\": \"allSpecifications\", \n\n11\n\n \"displayValue\": \"SPECIFICATION_NAME\", \n\n12\n\n \"specificationName: \"On Sale\", \n\n13\n\n \"visibleWhen\": \"True\" \n\n14\n\n } \n\n15\n\n }, \n\n16\n\n \"flex-layout.row#product-image\": { \n\n17\n\n \"children\": [\"product-images\"] \n\n18\n\n }, \n\n`\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| groupContainer |\n| badgeContainer |\n| badgeText |\n\nNote: each badge also receives a class `badgeContainer` with its specification name slug appended to it. Example: on specification `On Sale` the badge will also have the class `badgeContainer--on-sale`.\n\nSee also\n\n[Vtex.product SummaryVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySpecificationBadges/docs/apps/vtex.product-summary)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySpecificationBadges/docs/apps/vtex.product-summary@2.91.0/ProductSummarySpecificationBadges%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_511760fb
|
[
{
"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 add customer preferences to the cart 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/add-customer-preferences-to-the-cart/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/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/add-customer-preferences-to-the-cart/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/add-customer-preferences-to-the-cart/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/add-customer-preferences-to-the-cart/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/add-customer-preferences-to-the-cart/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/add-customer-preferences-to-the-cart/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/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/add-customer-preferences-to-the-cart/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Getting a customer profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/getting-a-customer-profile-by-email)\n\n[Adding customer profile information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/add-customer-profile-information-to-the-cart)\n\n[Add shipping address and select delivery option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/add-shipping-address-and-delivery-option-to-the-cart)\n\n[Adding customer preferences to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/add-customer-preferences-to-the-cart)\n\n[Adding marketing information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/add-marketing-information-to-the-cart)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/add-cart-items)\n\n[Adding payment information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/adding-payment-information-to-the-cart)\n\n[Adding merchant context information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/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/add-customer-preferences-to-the-cart/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/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/add-customer-preferences-to-the-cart/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/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/add-customer-preferences-to-the-cart/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/add-customer-preferences-to-the-cart/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/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/add-customer-preferences-to-the-cart/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Getting a customer profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/getting-a-customer-profile-by-email)\n\n[Adding customer profile information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/add-customer-profile-information-to-the-cart)\n\n[Add shipping address and select delivery option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/add-shipping-address-and-delivery-option-to-the-cart)\n\n[Adding customer preferences to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/add-customer-preferences-to-the-cart)\n\n[Adding marketing information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/add-marketing-information-to-the-cart)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/add-cart-items)\n\n[Adding payment information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/adding-payment-information-to-the-cart)\n\n[Adding merchant context information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/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/add-customer-preferences-to-the-cart/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/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/add-customer-preferences-to-the-cart/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/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/add-customer-preferences-to-the-cart/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/add-customer-preferences-to-the-cart/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/checkout-api-overview)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Adding customer preferences to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/add-customer-preferences-to-the-cart)\n\nAdding customer preferences to the cart\n\nThe shopping cart gathers information on the products the customer chooses while browsing a store, such as prices, shipping costs, payment methods, delivery methods, etc. This data may include item prices, shipping value, payment, and delivery methods, among others.\n\nThis guide will describe how to add customer preferences information (website locale and newsletter options) to the shopping cart via API.\n\n## Getting shopping cart information\n\nThe first step is to get the `orderFormId` of the shopping cart to which you want to add the customer preferences information. For more information, read the [Getting cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id) guide.\n\n## Adding customer preferences to the shopping cart\n\nTo add customer preferences information to the shopping cart, use the [Add client preferences](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForm/-orderFormId-/attachments/clientPreferencesData) endpoint. In this request, you must send the `orderFormId` through the URL address, as shown in the example below:\n\n`https://{accountName}.{environment.com.br}/api/checkout/pub/orderForm/ede846222cd44046ba6c638442c3505a/attachments/clientPreferencesData`\n\nAdditionally, you need to send the request body containing the following customer preferences information:\n\n* `locale`: Defines the website language chosen by the customer (e.g. PT, EN, ES).\n* `optinNewsLetter`: Indicates if the customer subscribed to the store newsletter.\n\nSee a request body example below:\n\n`1\n\n{ \n\n2\n\n \"locale\": \"EN\", \n\n3\n\n \"optinNewsLetter\": true \n\n4\n\n} \n\n`\n\nAfter sending the request, the endpoint will return the response body containing the client preferences information in the shopping cart, as in the example below:\n\n`1\n\n... \n\n2\n\n\"clientPreferencesData\": { \n\n3\n\n \"locale\": \"EN\", \n\n4\n\n \"optinNewsLetter\": true \n\n5\n\n } \n\n6\n\n... \n\n`\n\n> ️ For more information on each field available in the shopping cart, see the [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) overview.\n\n## Error code\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\": \"5d9f54e6-7db4-46d6-bca9-deeb278b8b98\" \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 if the URL 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\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/GeorgeLimaDev)\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/cart-attachments-section-quick-start-guides/add-customer-preferences-to-the-cart.md)\n\n[Add shipping address and select delivery option« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart//docs/guides/add-shipping-address-and-delivery-option-to-the-cart)[Adding marketing information to the cartNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart//docs/guides/add-marketing-information-to-the-cart)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/GeorgeLimaDev)\n\nON THIS PAGE\n\n[Getting shopping cart information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/add-customer-preferences-to-the-cart%23getting-shopping-cart-information)\n\n[Adding customer preferences to the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/add-customer-preferences-to-the-cart%23adding-customer-preferences-to-the-shopping-cart)\n\n[Error code](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/add-customer-preferences-to-the-cart%23error-code)\n\n[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/add-customer-preferences-to-the-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/add-customer-preferences-to-the-cart%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/cart-attachments-section-quick-start-guides/add-customer-preferences-to-the-cart.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/add-customer-preferences-to-the-cart/docs/guides/add-customer-preferences-to-the-cart%23getting-shopping-cart-information)\n\n[Adding customer preferences to the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/add-customer-preferences-to-the-cart%23adding-customer-preferences-to-the-shopping-cart)\n\n[Error code](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/add-customer-preferences-to-the-cart%23error-code)\n\n[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/add-customer-preferences-to-the-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-customer-preferences-to-the-cart/docs/guides/add-customer-preferences-to-the-cart%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_d24eceb6
|
[
{
"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 master data api v2 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/master-data-api-v2/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-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/api-reference/master-data-api-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/api-reference/master-data-api-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/api-reference/master-data-api-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/api-reference/master-data-api-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/api-reference/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/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/master-data-api-v2/docs/api-reference/master-data-api-v2/)\n\nDocuments\n\nSearch\n\nScroll\n\nSchemas\n\nIndices\n\nClusters\n\nVersions\n\nShopper data\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/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/master-data-api-v2/docs/api-reference/master-data-api-v2/)\n\nDocuments\n\nSearch\n\nScroll\n\nSchemas\n\nIndices\n\nClusters\n\nVersions\n\nShopper data\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/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/master-data-api-v2/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[PoFulfillment simulation - External Marketplace« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/docs/api-reference/marketplace-protocol-external-marketplace-orders%23post-/api/checkout/pub/orderForms/simulation)[PoCreate new documentNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2/docs/api-reference/master-data-api-v2%23post-/api/dataentities/-dataEntityName-/documents)\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_fc1e3c2e
|
[
{
"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 badges 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.badges/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/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.badges/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.badges/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.badges/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.badges/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.badges/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.checkout-ui-custom)\n\n[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.messages)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/guides/affiliates-program-app)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/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.badges/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.badges/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.checkout-ui-custom)\n\n[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.messages)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/guides/affiliates-program-app)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/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.badges/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.badges/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.badges/docs/vtex-io-apps)\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/guides/functional-apps)\n\nBadges\n\nOfficial extension\n\nVersion: 3.10.3\n\nLatest version: 3.10.3\n\n> This app is no longer maintained by VTEX. This means it will not be updated, and support and maintenance are no longer provided.\n\nThis app allows you to add content badges to an ecommerce. In the Admin panel, you can create, edit, and remove badges. There is also a storefront component that allows these badges to be added to your store theme.\n\n## Configuration\n\nIn order to set up the Badges app in your store, follow these steps:\n\n1. Install the app. You can do this by going to the [Badges app page](https://read.calvincode.net/reader?url=https://apps.vtex.com/vtex-badges/p) in the VTEX app store or by running this command in your terminal:\n\n`1\n\n vtex install vtex.badges@3.x \n\n`\n\n1. Add **Badges** to the `peerDependencies` in your `manifest.json` file:\n\n`1\n\n\"peerDependencies\": { \n\n2\n\n \"vtex.badges\": \"3.x\" \n\n3\n\n} \n\n`\n\nWith this, you should be able to start using the app.\n\n## Managing badges\n\nAfter installing the app, you will be able to access it by going to the `OTHER` section of the Admin panel and clicking `Badge Management`.\n\n\n\n### Creating badges\n\nThe `Add badges` tab allows you to create new badges by following these steps:\n\n1. Fill in the name of the badge.\n2. Select the badge type, which can be `IMAGE`, `TEXT`, or `HTML`.\n3. Insert the badge content according to the selected type.\n4. Select the badge priority level, where `1` is the maximum priority and `5` is the minimum.\n5. Set up the activation rule, which is composed of one or more conditions.\n6. Click `SAVE`.\n\nSee below a badge creation example.\n\n\n\n> Note that each badge must contain at least one activation rule condition with the verb `is`. The app will not work properly if all activation rules conditions use `is not`.\n\n### Editing badges\n\nTo edit an existing badge, go to the `Edit badges` tab and follow these steps:\n\n1. Click the menu icon in the row corresponding to the badge you wish to edit.\n2. Click `Edit`.\n3. Edit the badge attributes.\n4. Click `EDIT`.\n\n\n\n### Deleting badges\n\nIf you wish to delete an existing badge from your store, go to the `Edit badges` tab and follow these steps:\n\n1. Click the menu icon in the row corresponding to the badge you wish to edit.\n2. Click `Delete`.\n3. In the prompt that will be displayed, click `DELETE`.\n\n### Filtering badges\n\nTo improve the search for badges, it is possible to select which fields you want the search for them to be filtered. This makes searching the Database simpler and more efficient when returning badges to your website. To configure it, just enter the My Applications area. Then choose **App Badges** and select which fields you want the search to be related to.\n\n\n\nRemember that by default, all fields are used as a filter.\n\n## Displaying badges in your store\n\nIn order to display the created badges in your store, you must add the `store-badges` component to a product page (`store.product`) or a `product-summary`. See an example of how to add badges to a product page below.\n\n`1\n\n \"store.product\": { \n\n2\n\n \"children\": [ \n\n3\n\n+ \"store-badges\", \n\n4\n\n \"stack-layout\", \n\n5\n\n \"breadcrumb\", \n\n6\n\n \"flex-layout.row#main\", \n\n7\n\n \"condition-layout.product\" \n\n8\n\n ] \n\n9\n\n }, \n\n10\n\n \n11\n\n+ \"store-badges\":{ \n\n12\n\n+ \"props\": { \n\n13\n\n+ \"numberOfBadges\": 1, \n\n14\n\n+ \"text\":{ \n\n15\n\n+ \"font\": \"t-heading-5\", \n\n16\n\n+ \"textColor\": \"blue\", \n\n17\n\n+ \"textAlignment\": \"CENTER\", \n\n18\n\n+ \"textPosition\": \"CENTER\", \n\n19\n\n+ \"htmlId\": \"teste1\" \n\n20\n\n+ }, \n\n21\n\n+ \"image\":{ \n\n22\n\n+ \"blockClass\": \"container\", \n\n23\n\n+ \"height\": 500, \n\n24\n\n+ \"width\": 500, \n\n25\n\n+ \"minWidth\": 25, \n\n26\n\n+ \"minHeight\": 25, \n\n27\n\n+ \"alt\": \"teste\", \n\n28\n\n+ \"title\": \"title\", \n\n29\n\n+ \"preload\": true \n\n30\n\n+ } \n\n31\n\n+ } \n\n32\n\n+ } \n\n`\n\n### Component props\n\nThese are the props available for customization of the badge component.\n\n| Prop name | Type | Description |\n| -------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| numberOfBadges | number | Number of badges that will be rendered. |\n| text | array | Defines values that will be used when rendering a badge. To learn more about this prop, see [Rich text](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/rich-text). |\n| image | array | Defines values that will be used when rendering image badges. To learn more about this prop, see [Store image](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-image) |\n\n## Final result\n\nAfter finishing all the steps, you can check the result in your store. The order of the badges is set according to the priority defined when creating them. See the image below that corresponds to the badge setup in this tutorial's examples.\n\n\n\n[Abandoned Cart Service« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.abandoned-cart-service)[BroadcasterNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.broadcaster)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)[README\\_ptVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.badges@3.10.3/README%5Fpt)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.badges%23configuration)\n\n[Managing badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.badges%23managing-badges)\n\n[Creating badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.badges%23creating-badges)[Editing badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.badges%23editing-badges)[Deleting badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.badges%23deleting-badges)[Filtering badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.badges%23filtering-badges)\n\n[Displaying badges in your store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.badges%23displaying-badges-in-your-store)\n\n[Component props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.badges%23component-props)\n\n[Final result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges/docs/apps/vtex.badges%23final-result)\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_ce205e96
|
[
{
"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 faststore versions and support levels 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-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/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-faststore-versions-and-support-levels/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore)\n\nFastStore versions and support levels\n\nUnderstand FastStore versions, support levels, and guidance for upgrading.\n\nFastStore has two main versions: FastStore v1 and FastStore v2+. This document outlines the key differences between these versions, their support levels, and guidelines for upgrading.\n\n## FastStore v1\n\n[FastStore v1](https://read.calvincode.net/reader?url=https://v1.faststore.dev/docs) was the first version of the framework. While it served as the foundation for FastStore, it's no longer actively maintained. New projects must use the latest version of FastStore.\n\n## FastStore v2+\n\nFastStore v2+ is the latest and most advanced version of the storefront solution. It encompasses all versions starting from v2 and introduces major improvements over FastStore v1, such as:\n\n* **Simplified updates:** Stores are monitored for version updates with minimal friction, including automatic non-critical updates and a more efficient integration process.\n* **Separation of VTEX-managed code and store customizations:** Clear segmentation between VTEX and custom code to help in the debug process.\n* **CMS-first approach:** Headless CMS manages content updates (texts, images, links) while behavioral and UI component changes remain code-based, ensuring a structured workflow.\n* **Optimized performance and quality monitoring:** Ongoing performance tracking with proactive safeguards to prevent deployments that don’t meet Lighthouse and quality standards.\n* **Semantic versioning:** FastStore v2+ uses [Semantic Versioning](https://read.calvincode.net/reader?url=https://semver.org/) for managing releases: \n * **Majors:** Introduce breaking changes, including incompatible API updates. \n * **Minors:** Introduce backward-compatible features. \n * **Patches:** Include backward-compatible bug fixes.\n\n## Key differences between FastStore versions\n\nOne of the main changes from FastStore v1 to FastStore v2+ is the separation between VTEX code and store-specific customizations. This separation introduced the [core](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-overview%23packagejson) package for VTEX code and reserved the `/src` folder for store-specific customizations. Below are the key differences between the versions:\n\n### Packages\n\n| Package name | FastStore v1 | FastStore v2 | FastStore v3 |\n| ------------- | ------------ | ------------ | ------------ |\n| api | ✅ | ✅ | ✅ |\n| cli | ✅ | ✅ | ✅ |\n| components | ✅ | ✅ | ✅ |\n| core | ❌ | ✅ | ✅ |\n| graphql-utils | ✅ | ✅ | ✅ |\n| lighthouse | ✅ | ✅ | ✅ |\n| sdk | ✅ | ✅ | ✅ |\n| styles | ✅ | ❌ | ❌ |\n| ui | ✅ | ✅ | ✅ |\n\n### Other aspects\n\n| **Aspect** | **FastStore v1** | **FastStore v2** | **FastStore v3** |\n| ------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |\n| **Documentation** | [FastStore v1 Portal](https://read.calvincode.net/reader?url=https://v1.faststore.dev/) | [Developers Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore) | [Developers Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore) |\n| **Project onboarding** | [Cloning the FastStore starter repository](https://read.calvincode.net/reader?url=https://v1.faststore.dev/quickstart). | Onboarding app | [WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project) |\n| **Development framework** | [Gatsby](https://read.calvincode.net/reader?url=https://www.gatsbyjs.com/docs/) / [Next.js](https://read.calvincode.net/reader?url=https://nextjs.org/docs) | [Next.js](https://read.calvincode.net/reader?url=https://nextjs.org/docs) | [Next.js](https://read.calvincode.net/reader?url=https://nextjs.org/docs) |\n\n## Support levels\n\nDifferent levels of support are available depending on the FastStore version. The following table details the status, support availability, and recommendations for each version of new projects.\n\n| **Criteria** | **FastStore v1** | **FastStore v2+** |\n| ---------------- | ----------------------------------------------------------------------------------------- | --------------------------------------------------- |\n| **Status** | No longer updated. | Actively maintained. |\n| **Support** | Limited support. Only bugs and vulnerabilities related to public VTEX APIs are addressed. | Full support. |\n| **New Projects** | Not supported. Only FastStore v2+ is available for new projects. | Recommended for all new storefront implementations. |\n\nIf you have any questions about the level of support provided for different FastStore versions, [open a ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support) with the VTEX Support team.\n\n## Upgrade between FastStore versions\n\nBefore upgrading to a new FastStore version, contact VTEX to ensure compatibility and a smooth transition. For assistance, [open a ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support) with the VTEX Support team.\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\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/faststore/docs/getting-started/faststore-versions-and-support-levels.mdx)\n\n[FastStore« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore)[Getting StartedNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/getting-started-overview)\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[FastStore v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/getting-started-faststore-versions-and-support-levels%23faststore-v1)\n\n[FastStore v2+](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/getting-started-faststore-versions-and-support-levels%23faststore-v2)\n\n[Key differences between FastStore versions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/getting-started-faststore-versions-and-support-levels%23key-differences-between-faststore-versions)\n\n[Packages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/getting-started-faststore-versions-and-support-levels%23packages)[Other aspects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/getting-started-faststore-versions-and-support-levels%23other-aspects)\n\n[Support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/getting-started-faststore-versions-and-support-levels%23support-levels)\n\n[Upgrade between FastStore versions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/getting-started-faststore-versions-and-support-levels%23upgrade-between-faststore-versions)\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/faststore-versions-and-support-levels.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[FastStore v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/getting-started-faststore-versions-and-support-levels%23faststore-v1)\n\n[FastStore v2+](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/getting-started-faststore-versions-and-support-levels%23faststore-v2)\n\n[Key differences between FastStore versions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/getting-started-faststore-versions-and-support-levels%23key-differences-between-faststore-versions)\n\n[Packages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/getting-started-faststore-versions-and-support-levels%23packages)[Other aspects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/getting-started-faststore-versions-and-support-levels%23other-aspects)\n\n[Support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/getting-started-faststore-versions-and-support-levels%23support-levels)\n\n[Upgrade between FastStore versions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels/docs/guides/faststore/getting-started-faststore-versions-and-support-levels%23upgrade-between-faststore-versions)\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_c234bd95
|
[
{
"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 messages builder 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-messages-builder/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-messages-builder/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-messages-builder/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-messages-builder/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-messages-builder/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-messages-builder/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-messages-builder/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-messages-builder/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-messages-builder/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-messages-builder/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-messages-builder/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-messages-builder/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n[Manifest](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-manifest)\n\n[Billing Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-billing-options)\n\n[Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-builders)\n\n[Admin Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-admin-builder)\n\n[Assets Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-assets-builder)\n\n[Docs Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-docs-builder)\n\n[GraphQL Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-graphql-builder)\n\n[Messages Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-messages-builder)\n\n[Node Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-node-builder)\n\n[PaymentProvider Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-paymentprovider-builder)\n\n[Pixel Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-pixel-builder)\n\n[React Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-react-builder)\n\n[Store Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-store-builder)\n\n[Styles Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-styles-builder)\n\n[Dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-dependencies)\n\n[Peer Dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-peerdependencies)\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/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-messages-builder/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-messages-builder/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-messages-builder/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-messages-builder/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-messages-builder/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/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-messages-builder/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-messages-builder/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-messages-builder/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-messages-builder/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/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-messages-builder/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-messages-builder/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-messages-builder/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-messages-builder/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-messages-builder/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n[Manifest](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-manifest)\n\n[Billing Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-billing-options)\n\n[Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-builders)\n\n[Admin Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-admin-builder)\n\n[Assets Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-assets-builder)\n\n[Docs Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-docs-builder)\n\n[GraphQL Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-graphql-builder)\n\n[Messages Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-messages-builder)\n\n[Node Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-node-builder)\n\n[PaymentProvider Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-paymentprovider-builder)\n\n[Pixel Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-pixel-builder)\n\n[React Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-react-builder)\n\n[Store Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-store-builder)\n\n[Styles Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-styles-builder)\n\n[Dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-dependencies)\n\n[Peer Dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-peerdependencies)\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/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-messages-builder/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-messages-builder/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-messages-builder/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-messages-builder/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-messages-builder/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/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-messages-builder/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-messages-builder/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-messages-builder/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-messages-builder/docs/app-development)\n\nProject structure\n\n[Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-builders)\n\n[Messages Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-messages-builder)\n\nMessages builder\n\nLearn how to use the VTEX IO Messages builder.\n\nThe `messages` builder handles the internationalization (i18n) of strings in VTEX IO apps using [React](https://read.calvincode.net/reader?url=https://react.dev/). Instead of declaring static strings in frontend components, this builder allows you to use an ID for each message, which will be dynamically replaced with the corresponding string in the user's language.\n\nFor more information about creating apps that support multiple languages, see [7\\. Translating the component in the Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component) and [Internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores).\n\n## Folder structure\n\nThe `messages` builder uses a folder named `messages` located in the app's root folder. This folder contains one JSON file for each language used in the app. Each file is named using the corresponding two lowercase letters of the language's [ISO 639-1 code](https://read.calvincode.net/reader?url=https://www.loc.gov/standards/iso639-2/php/code%5Flist.php). For instance, English is represented by the code `en`, Spanish by `es`, and Portuguese by `pt`.\n\n`1\n\nmessages \n\n2\n\n┣ 📄en.json \n\n3\n\n┣ 📄es.json \n\n4\n\n┗ 📄pt.json \n\n`\n\n* `{language-code}.json`: JSON file of the language containing the message IDs with their corresponding strings. See file name examples below: \n * `en.json`: JSON file for English messages. \n * `es.json`: JSON file for Spanish messages. \n * `pt.json`: JSON file for Portuguese messages.\n\n## Usage\n\nTo develop an app using the `messages` builder, follow the steps below:\n\n1. **Start with a React app**: First, you need an app that uses the [react builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-react-builder). If you are starting from scratch, you can download the [React app boilerplate](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/react-app-template/tree/master/react).\n2. **Add the React i18n libraries**: Open a terminal in the `react` folder of your app and run the following command: `yarn add react-intl@3 && yarn add @types/react-intl@3 --dev`.\n3. **Configure the manifest**: Access the `manifest.json` file and add the `messages` builder to the builders list. \nmanifest.json \n`1 \n{ \n2 \n ... \n3 \n \"builders\": { \n4 \n \"react\": \"3.x\", \n5 \n \"docs\": \"0.x\", \n6 \n+ \"messages\": \"1.x\" \n7 \n }, \n8 \n ... \n9 \n} \n`\n4. **Add the message identifiers:** Use the string identifiers in your React code. In the example below, `store/my-app.hello` is a string identifier for the `<Formatted Message>` component. Keys that start with `store/` are used in the storefront, while keys that start with `admin/` are used in the Admin UI. If a string identifier is used in the code and does not have a corresponding key in the message JSON files, it will fallback to the [automatic translation service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores%23automatic-translations). \n`1 \nimport React from 'react' \n2 \nimport { FormattedMessage } from 'react-intl' \n3 \n \n4 \nconst HelloWorld = () => { \n5 \n return ( \n6 \n <div> \n7 \n <FormattedMessage id=\"store/my-app.hello\"/> \n8 \n </div> \n9 \n ) \n10 \n} \n11 \n \n12 \nexport default HelloWorld \n` \n> Use meaningful and descriptive keys for all strings. Maintain a consistent naming convention that reflects the context and location of the text. This practice helps developers and translators locate the keys, understand their meaning, and organize the strings.\n5. **Add the messages files with strings:** Create a separate JSON file for each language in the `messages` folder. In each file, define an object where the keys are the message IDs and the values are the corresponding strings in the target language. Each key must be present in every JSON file. See the examples below for English, Spanish, and Portuguese. \nen.json \n`1 \n{ \n2 \n \"store/my-app.hello\": \"Hello, world!\" \n3 \n} \n` \nes.json \n`1 \n{ \n2 \n \"store/my-app.hello\": \"¡Hola, mundo!\" \n3 \n} \n` \npt.json \n`1 \n{ \n2 \n \"store/my-app.hello\": \"Olá, mundo!\" \n3 \n} \n` \n> We recommend adding the keys to the JSON files in alphabetical order. This helps developers and translators to locate and work with the keys.\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/Reference/concepts/vtex-io-documentation-builders/vtex-io-documentation-messages-builder.md)\n\n[GraphQL Builder« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder//docs/guides/vtex-io-documentation-graphql-builder)[Node BuilderNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder//docs/guides/vtex-io-documentation-node-builder)\n\nContributors\n\n1\n\n[](https://github.com/henriquessb)\n\nON THIS PAGE\n\n[Folder structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-messages-builder%23folder-structure)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-messages-builder%23usage)\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-builders/vtex-io-documentation-messages-builder.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Folder structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-messages-builder%23folder-structure)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-messages-builder/docs/guides/vtex-io-documentation-messages-builder%23usage)\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_ffdba53a
|
[
{
"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 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/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/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/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/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/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/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/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/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/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/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/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/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/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/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/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/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/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/docs/guides/data-residency)\n\n[Profile System integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/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/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/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/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/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/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/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/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/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/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/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/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/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/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/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/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/docs/guides/data-residency)\n\n[Profile System integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/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/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/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/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/docs/guides)\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/data-protection-plus)\n\nData Protection Plus\n\n> **Closed beta:** [Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-protection-plus) is in closed beta and is 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), meaning _additional fees may apply._\n> \n> 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).\n> \n> 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\nThe VTEX platform allows stores to process shoppers' Personal Identifiable Information (PII) in compliance with data privacy regulations such as [GDPR and LGPD](https://read.calvincode.net/reader?url=https://vtex.com/us-en/privacy-and-agreements/vtex-commitment/).\n\nWhen using Data Protection Plus, accounts follow the PII data architecture, where all PII is stored in the [Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system). Other VTEX modules, such as **Order Management** and **Checkout**, store only pseudonymized data associated with a **Profile System** token. These modules may also access PII from the **Profile System**, as described in the [PII data architecture specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications).\n\n> See the [Trust Hub](https://read.calvincode.net/reader?url=https://vtex.com/us-en/trust/) to learn more about VTEX's vision regarding data privacy, including certifications, internal policies and commitments.\n\n## Solutions and implementation\n\nVTEX has established a comprehensive PII data architecture that incorporates a range of solutions and processes for PII. See the documentation below to learn more about how it works and how to implement it.\n\n* [PII Data Architecture specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture-specifications): Technical specifications of the PII data architecture, including the Profile System, data encryption and auditability, among other key features.\n* [Data residency](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-residency): How PII data residency works for VTEX stores using the PII data architecture.\n* [Data subject rights](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/data-subject-rights--6imchxTx09icupKMbzHVIM): Detailed instructions on how VTEX stores can apply data subject rights.\n* [Profile System integration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system): How to integrate with the Profile System API.\n* [Working with schemas in the Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system): How to interact with the structure of data stored in the Profile System.\n* [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): Adaptations in the default behavior of certain VTEX features to handle the PII data architecture.\n* [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): Current limitations that apply to stores using PII data architecture, in relation to certain VTEX features.\n* [Erasing customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erasing-customer-data): Process to erase customer data when using the PII data architecture.\n\n## Parties' responsibilities\n\nVTEX isolates and protects all fields classified as sensitive. However, it is important to acknowledge that there are scenarios beyond VTEX's control. In such cases, as a VTEX client, it is the store's responsibility to ensure the integrity of your integrations and prevent any data misuse. The main scenarios to consider include:\n\n* Sending PII in custom or text fields.\n* Adhering to IO apps that depend on or consume PII data.\n* Integrating with third-party systems that consume PII data, such as ERPs.\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/Integration-Guides/data-privacy/data-protection-plus.md)\n\n[Revoking SSL private certificates when using Mutual Transport Layer Security (mTLS)« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture//docs/guides/revoking-ssl-private-certificates-when-using-mtls)[PII Data Architecture specificationsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture//docs/guides/pii-data-architecture-specifications)\n\nSee also\n\n[PII Data Architecture specificationsGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/pii-data-architecture-specifications)[Data residencyGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/data-residency)[Changes in VTEX features behavior to handle PII dataGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data)[Profile System integrationGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/profile-system)[Erasing customer dataGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/erasing-customer-data)[Limitations of the PII data architecture during closed betaGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/limitations-of-the-pii-data-architecture-during-closed-beta)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Solutions and implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/data-protection-plus%23solutions-and-implementation)\n\n[Parties' responsibilities](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/data-protection-plus%23parties-responsibilities)\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/data-protection-plus.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Solutions and implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/data-protection-plus%23solutions-and-implementation)\n\n[Parties' responsibilities](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pii-data-architecture/docs/guides/data-protection-plus%23parties-responsibilities)\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_3b97356d
|
[
{
"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 add merchant context information to the cart 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/add-merchant-context-information-to-the-cart/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/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/add-merchant-context-information-to-the-cart/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/add-merchant-context-information-to-the-cart/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/add-merchant-context-information-to-the-cart/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/add-merchant-context-information-to-the-cart/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/add-merchant-context-information-to-the-cart/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/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/add-merchant-context-information-to-the-cart/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Getting a customer profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/getting-a-customer-profile-by-email)\n\n[Adding customer profile information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/add-customer-profile-information-to-the-cart)\n\n[Add shipping address and select delivery option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/add-shipping-address-and-delivery-option-to-the-cart)\n\n[Adding customer preferences to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/add-customer-preferences-to-the-cart)\n\n[Adding marketing information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/add-marketing-information-to-the-cart)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/add-cart-items)\n\n[Adding payment information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/adding-payment-information-to-the-cart)\n\n[Adding merchant context information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/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/add-merchant-context-information-to-the-cart/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/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/add-merchant-context-information-to-the-cart/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/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/add-merchant-context-information-to-the-cart/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/add-merchant-context-information-to-the-cart/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/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/add-merchant-context-information-to-the-cart/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Getting a customer profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/getting-a-customer-profile-by-email)\n\n[Adding customer profile information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/add-customer-profile-information-to-the-cart)\n\n[Add shipping address and select delivery option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/add-shipping-address-and-delivery-option-to-the-cart)\n\n[Adding customer preferences to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/add-customer-preferences-to-the-cart)\n\n[Adding marketing information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/add-marketing-information-to-the-cart)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/add-cart-items)\n\n[Adding payment information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/adding-payment-information-to-the-cart)\n\n[Adding merchant context information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/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/add-merchant-context-information-to-the-cart/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/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/add-merchant-context-information-to-the-cart/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/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/add-merchant-context-information-to-the-cart/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/add-merchant-context-information-to-the-cart/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/checkout-api-overview)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Adding merchant context information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart)\n\nAdding merchant context information to the cart\n\nThe shopping cart gathers information on the products the customer chooses while browsing a store, such as prices, shipping costs, payment methods, delivery methods, etc. This data may include item prices, shipping value, payment, and delivery methods, among others.\n\nThis guide will describe how to add relevant information related to a specific order to a shopping cart via API.\n\n## Getting shopping cart information\n\nThe first step is to get the `orderFormId` of the shopping cart to which you want to add the merchant context information. For more information, read the [Getting 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## Adding merchant context information to the shopping cart\n\nTo add merchant context information to the shopping cart, you need to use the [Add merchant context data](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/addmerchantcontextdata) endpoint. In this request, you must send the `orderFormId` through the URL address, as in the example below:\n\n`https://{accountName}.{environment.com.br}/api/checkout/pub/orderForm/ede846222cd44046ba6c638442c3505a/attachments/merchantContextData`\n\nAdditionally, you need to send the request with the merchant context information within the `salesAssociateData` object. See a request body example containing the vendor (seller) identification code:\n\n`1\n\n{ \n\n2\n\n \"salesAssociateData\": { \n\n3\n\n \"salesAssociateId\": \"seller123\" \n\n4\n\n } \n\n5\n\n} \n\n`\n\nAfter sending the request, the endpoint will return the response body containing the merchant context data in the shopping cart, as in the example below:\n\n`1\n\n... \n\n2\n\n\"merchantContextData\": { \n\n3\n\n \"salesAssociateData\": { \n\n4\n\n \"salesAssociateId\": \"seller123\" \n\n5\n\n } \n\n6\n\n } \n\n7\n\n... \n\n`\n\n> ️ For more information about the meaning of each field available in the shopping cart, see 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\": \"5d9f54e6-7db4-46d6-bca9-deeb278b8b98\" \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 if the URL 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\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/GeorgeLimaDev)\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/cart-attachments-section-quick-start-guides/add-merchant-context-information-to-the-cart.md)\n\n[Adding payment information to the cart« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart//docs/guides/adding-payment-information-to-the-cart)[ConfigurationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart//docs/guides/configuration-section-api-quick-start-guides)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/GeorgeLimaDev)\n\nON THIS PAGE\n\n[Getting shopping cart information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart%23getting-shopping-cart-information)\n\n[Adding merchant context information to the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart%23adding-merchant-context-information-to-the-shopping-cart)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart%23error-codes)\n\n[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart%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/cart-attachments-section-quick-start-guides/add-merchant-context-information-to-the-cart.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/add-merchant-context-information-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart%23getting-shopping-cart-information)\n\n[Adding merchant context information to the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart%23adding-merchant-context-information-to-the-shopping-cart)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart%23error-codes)\n\n[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-information-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart%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_d9923902
|
[
{
"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 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/molecules-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/molecules-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/molecules-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/molecules-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/molecules-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/molecules-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/molecules-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/molecules-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/molecules-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-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/molecules-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-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/molecules-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-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/molecules-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/molecules-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/molecules-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/molecules-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-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/molecules-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/molecules-overview/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-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/molecules-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/molecules-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-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/molecules-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-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/molecules-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-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/molecules-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/molecules-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/molecules-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/molecules-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-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/molecules-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/molecules-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/molecules-overview/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/components-index)\n\nMolecules\n\n* [ClothingShortsSweatshirtTank topsBagsBackpacksNecessaireSaleSmartphonesTVsAccordionDisplays an expandable/collapsible list of items.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-accordion)\n* [Alert message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-alert)[Link](#) \nAlert \nDisplays short messages related to the behavior of a system, feature or page.\n* [](https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-breadcrumb)[Echo Dot Smart Speaker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/echo-dot-smart-speaker-99988214/p)\n* Oculus VR Headset\n\n 1. [Technology](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/technology/)\n 2. [Echo Dot Smart Speaker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/echo-dot-smart-speaker-99988214/p)\n 3. Oculus VR Headset\n\nBreadcrumb\n\nIndicates the user's location in a website hierarchy.\n\n* [Buy NowBuyButtonIntends to send the user to the checkout/cart step directly.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-buy-button)\n* [Card with Icon Message CardA card with a header and body, ideal for displaying products, messages, or store information.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-card)\n* [](https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-carousel)Apple Magic Mouse \nOriginal price:$999Price:$950.04\n*  \n### 4k Philips Monitor 27” \nOriginal price:$490Price:$420\n*  \n### Echo Dot Smart Speaker \nOriginal price:$310Price:$280\n*  \n### Aedle VK-1 L Headphone \nOriginal price:$150Price:$130\n*  \n### Oculus VR Headset \nOriginal price:$344Price:$315\n*  \n### Apple AirPods Pro \nOriginal price:$249Price:$229\n*  \n### Anker SoundCore Liberty Air \nOriginal price:$643.71Price:$486.34\n*  \n### Fujifilm X-T1 Camera \nOriginal price:$495.97Price:$366.11\n*  \n### SANDMARC Fisheye Lens \nOriginal price:$946.73Price:$636.05\n*  \n### Apple AirTag \nOriginal price:$679.29Price:$426.14\n\nCarousel\n\nSlides through multiple elements using custom controls.\n\n* [Apple Magic MouseColor: BlackSize: MediumOriginal price:$999Price:$950.04CartItemUsed to present the summarized product information inside the Cart.](https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-cart-item)\n* [DefaultCheckboxFieldWraps a Checkbox input and its corresponding Label. It allows users to select one option from a set.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-checkbox-field)\n* [50% offDiscountBadgeA custom Badge that displays product's discounts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-discount-badge)\n* [DropdownDropdownDisplays a set of actions/items to the user, usually used to show a menu of options.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-dropdown)\n* [Get a Apple Magic MouseOriginal price:$999FreeGiftDisplays an additional item to purchase as a gift.](https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-gift)\n* [IconButtonicons that trigger some sort of action, such as adding an item to the cart.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-icon-button)\n* [Input w/ ActionApplyInputFieldWraps an Input and its corresponding Label.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-input-field)\n* [Link Button](#) \nLinkButton \nVisually replicates a `Button`, however acts as a link to navigate users between pages.\n* [Open ModalModalAre dialog windows that sit on top of an application's main view.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-modal)\n* [Set location](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-navbar-links)[Office](#)\n* [Home Appliances](#)\n* [Computer and Software](#)\n* [Technology](#)\n\nNavbarLinks\n\nUsed to display a set of navigation links that self adapts on mobile or desktop screens.\n\n* [Subtotal (3 products)$1,200Discount\\-$100Total$1,100OrderSummaryProvides a summary of the items in the cart, including the total price, related shipping tax, and discounts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-order-summary)\n* [Popover TriggerPopoverProvides contextual information related to a trigger element when a user interacts with it to open the container.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-popover)\n* [](https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-product-card)Mouse \nOriginal price:$999Price:$950.04 \nProductCard \nDisplays summarized information about a product.\n* [Original price:$999Price:$950.04ProductPriceDisplays the product's listing and spot price.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-product-price)\n* [Apple Magic Mouse10% offRef.: 99995945ProductTitleUsed on Product Details Page, wraps the product name, a product label and the rating.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-product-title)\n* [Quantity SelectorAllows customers to select the quantity of a given product to purchase.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-quantity-selector)\n* [CheckedRadio FieldWraps a Radio input and its corresponding Label. It allows users to select one option from a set.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-radio-field)\n* [FirstSecondThirdRadio GroupAllows users to select a single option from a list of two or more mutually exclusive options.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-radio-group)\n* [RatingDisplays the average rating of a product based on other shoppers' feedback and reviews.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-rating)\n* [Rate the product from 1 to 5 starsRatingFieldAllows users to submit ratings when submitting product reviews.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-rating-field)\n* [Set your locationRegion BarTrigger the RegionModal and is part of Regionalization feature.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-region-bar)\n* [](https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-search-auto-complete)[appl**e airpods**](#)\n* [appl**e tv**](#)\n\nSearch Auto Complete\n\nLists auto-completing suggestions based on searched terms. This component is part of the `Search` feature.\n\n* [](https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-search-dropdown)[appl**e**](#)\n* [appl**e magic mouse**](#)\n\nSuggested Products\n\n1. [Apple Magic MouseOriginal price:$999Price:$950.04](#)\n2. [Apple Magic MouseOriginal price:$999Price:$950.04](#)\n\nSearch Dropdown\n\nCombines all `Search` components to show all options in `SearchInput`. This component is part of the `Search` feature.\n\n* [HistoryClear History](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-search-history)[Headphone](#)\n* [Audio & Video](#)\n* [mh-7000](#)\n\nSearch History\n\nResponsible for showing the latest terms searched by a user. This component is part of the `Search` feature.\n\n* [Search Input FieldAn InputField with a search button. This component is part of the Search feature.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-search-input-field)\n* [Suggested Products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-search-products)[Apple Magic MouseOriginal price:$999Price:$950.04](#)\n* [Apple Magic MouseOriginal price:$999Price:$950.04](#)\n\nSearch Products\n\nShows details of the suggested products. This component is part of the `Search` feature.\n\n* [Top Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-search-top)[1Notebooks](#)\n* [2Laser Printer](#)\n* [3Bluetooth Keyboard](#)\n\nSearch Top\n\nDisplays the most searched terms by customers. This component is part of the `Search` feature.\n\n* [Select a Status:GreatOkBadSelect FieldWraps a Select input and its corresponding Label. It allows users to select one option from a set.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-select-field)\n* [Color: **Blue**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-sku-selector)[Color: Blue](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/tech-keyboard-99988216/p)\n* [Color: Yellow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/tech-keyboard-99988212/p)\n* [Color: Gray](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/tech-keyboard-99988210/p)\n\nSKU Selector\n\nUsed in Product Details Pages (PDPs) to display all the available variants for a given product.\n\n* [BorderedTotal1x$2002x$2003x$204TableDisplays information in a friendly way, allowing users to scan for details quickly.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-table)\n* [TagTagAn interactive Badge with a close button.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-tag)\n* [LabelTextareaFieldUsed to get long user inputs.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-textarea-field)\n* [Simple ToastToastUsed to display notifications.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-toast)\n* [ToggleA customized checkbox input styled to look like a switch button.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-toggle)\n* [LabelToggle FieldToggle Field wraps a Toggle input and its corresponding Label.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-toggle-field)\n* [TooltipProvides contextual information when users hover over or click an element.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-tooltip)\n\nContributors\n\n3\n\n[](https://github.com/barbara-celi)\n\n[](https://github.com/mariana-caetano)\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/faststore/components/molecules/overview.mdx)\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/overview.mdx)\n\n[Textarea« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/atoms-textarea)[AccordionNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-accordion)\n\nOn this page\n\nON THIS PAGE\n\n[Apple Magic Mouse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-overview%23)\n\n[4k Philips Monitor 27”](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-overview%23)[Echo Dot Smart Speaker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-overview%23)[Aedle VK-1 L Headphone](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-overview%23)[Oculus VR Headset](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-overview%23)[Apple AirPods Pro](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-overview%23)[Anker SoundCore Liberty Air](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-overview%23)[Fujifilm X-T1 Camera](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-overview%23)[SANDMARC Fisheye Lens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-overview%23)[Apple AirTag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-overview%23)[Get a Apple Magic Mouse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-overview%23)[Mouse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-overview/docs/guides/faststore/molecules-overview%23)\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_81710bd4
|
[
{
"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 customization 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/customization/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/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/customization/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/customization/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/customization/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/customization/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/customization/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/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/customization/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/customization)\n\n[Checkout customization guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/checkout-customization-guide)\n\n[Customize checkout confirmation pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/customize-checkout-confirmation-pages)\n\n[Change payment method names in Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/change-payment-method-names-in-checkout)\n\n[Enable an Observation field on the Checkout page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/enable-an-observation-field-on-the-checkout-page)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/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/customization/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/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/customization/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/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/customization/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/customization/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/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/customization/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/customization)\n\n[Checkout customization guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/checkout-customization-guide)\n\n[Customize checkout confirmation pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/customize-checkout-confirmation-pages)\n\n[Change payment method names in Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/change-payment-method-names-in-checkout)\n\n[Enable an Observation field on the Checkout page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/enable-an-observation-field-on-the-checkout-page)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/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/customization/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/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/customization/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/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/customization/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/customization/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/checkout-api-overview)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization/docs/guides/customization)\n\nCustomization\n\nThis section contains articles about customizations available on Checkout. Here you will find the following articles:\n\n* [Checkout customization guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide)\n* [Customize checkout confirmation pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customize-checkout-confirmation-pages)\n* [Change payment method names in Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-payment-method-names-in-checkout)\n* [Enable an Observation field on the Checkout page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page)\n* [Displaying SLA by item in Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/displaying-sla-by-item-in-checkout)\n\nContributors\n\n3\n\n[](https://github.com/karenkrieger)\n\n[](https://github.com/ricardoaerobr)\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/customization.md)\n\n[Add and handle custom information in the order« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization//docs/guides/add-and-handle-custom-information-in-the-order)[Checkout customization guideNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/customization//docs/guides/checkout-customization-guide)\n\nContributors\n\n3\n\n[](https://github.com/karenkrieger)\n\n[](https://github.com/ricardoaerobr)\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/Checkout/customization.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_80990f18
|
[
{
"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 troubleshooting error installing 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/troubleshooting-error-installing-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/troubleshooting-error-installing-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/troubleshooting-error-installing-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/troubleshooting-error-installing-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/troubleshooting-error-installing-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/troubleshooting-error-installing-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/troubleshooting-error-installing-headless-cms/updates/release-notes)\n\nTroubleshooting\n\nAPI\n\n---\n\nDevelopment\n\n[I am getting 500 errors in VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)\n\n[I am getting errors with my service configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)\n\n[Issues during extending the FastStore API schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)\n\n[I can’t access the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/unable-to-access-headless-cms)\n\n[I can’t install the Headless CMS plugins in my account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account)\n\n[I can't install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/i-cant-install-vtex-io-cli)\n\n[I can’t integrate my external Search Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/i-cant-integrate-my-external-search-provider)\n\n[My multi-language store is not functioning in the development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)\n\n[My store catalog does not display the price range filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter)\n\n[My pages are taking too long to be published on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)\n\n[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)\n\n[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)\n\n[The Price in the shelf or in the search results is different from the product page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)\n\n[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)\n\n[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)\n\n[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/i-cant-create-a-new-workspace)\n\n[I can't install an app with a major other than 0.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)\n\n[I don't see my Store Theme changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/i-dont-see-my-store-theme-changes)\n\n---\n\nStore performance\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/updates/release-notes)\n\nTroubleshooting\n\nAPI\n\n---\n\nDevelopment\n\n[I am getting 500 errors in VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)\n\n[I am getting errors with my service configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)\n\n[Issues during extending the FastStore API schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)\n\n[I can’t access the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/unable-to-access-headless-cms)\n\n[I can’t install the Headless CMS plugins in my account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account)\n\n[I can't install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/i-cant-install-vtex-io-cli)\n\n[I can’t integrate my external Search Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/i-cant-integrate-my-external-search-provider)\n\n[My multi-language store is not functioning in the development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)\n\n[My store catalog does not display the price range filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter)\n\n[My pages are taking too long to be published on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)\n\n[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)\n\n[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)\n\n[The Price in the shelf or in the search results is different from the product page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)\n\n[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)\n\n[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)\n\n[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/i-cant-create-a-new-workspace)\n\n[I can't install an app with a major other than 0.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)\n\n[I don't see my Store Theme changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/i-dont-see-my-store-theme-changes)\n\n---\n\nStore performance\n\n---\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting)\n\nDevelopment\n\nI can’t install the Headless CMS plugins in my account\n\nUsers may encounter errors related to symbolic links and node version incompatibility.\n\nFastStore users may encounter the following errors after [installing the Headless CMS plugin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account%23step-1-setting-up-the-command-line-environment).\n\n| Error message | Possible cause | Solution |\n| ------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Error: EPERM: operation not permitted, symlink | Your device isn’t enabled for development. | [Enable Developer Mode in your machine](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/error-installing-headless-cms-plugins-on-windows%23enable-developer-mode-in-your-machine) |\n| error @oclif/core@1.26.2: The engine \"node\" is incompatible with this module. Expected version \">=14.0.0\". Got \"12.12.0\" | The VTEX IO CLI’s node version isn’t updated. Expected version was \\>=14.0.0, but the current version is 12.12.0. | [Update VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/error-installing-headless-cms-plugins-on-windows%23update-vtex-io-cli) |\n\n## Solutions\n\nTo solve these issues, follow the instructions below:\n\n* [Enable Developer Mode on your machine](#enable-developer-mode-on-your-machine)\n* [Update VTEX IO CLI](#update-vtex-io-cli)\n\n### Enable Developer Mode on your machine\n\nWhile running the `vtex plugins install cms`, Windows users can get the following error:\n\n`1\n\nvtex plugins install cms \n\n2\n\nwarning \"@vtex/cli-plugin-cms > @vtex/api > apollo-server-core > apollo-graphql@0.9.5\" has incorrect peer dependency \"graphql@^14.2.1 || ^15.0.0\". \n\n3\n\nInstalling plugin @vtex/cli-plugin-cms... failed \n\n4\n\n Error: EPERM: operation not permitted, symlink \n\n5\n\n 'C:\\Users\\LukeSkywalker\\AppData\\Roaming\\npm\\node_modules\\vtex' -> \n\n6\n\n 'C:\\Users\\LukeSkywalker\\AppData\\Local\\vtex\\node_modules\\vtex' \n\n7\n\n Code: EPERM \n\n`\n\nFastStore projects rely on creating symbolic links (symlinks). To solve this error, you must enable [Developer Mode](https://read.calvincode.net/reader?url=https://learn.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development%23accessing-settings-for-developers) on your machine. Developer Mode grants the necessary permissions and privileges to use symlinks, which reduces the probability of encountering errors during development.\n\n> Running the FastStore project as an administrator isn't recommended.\n\nLearn how to enable Developer Mode in Microsoft's official guide [Enable your device for development](https://read.calvincode.net/reader?url=https://learn.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development%23accessing-settings-for-developers).\n\nAfter enabling Developer Mode, launch Windows Terminal and run `vtex cms`. This will allow the system to create the necessary symlinks for running commands from the Headless CMS plugin.\n\n### Update VTEX IO CLI\n\nIf you run the `vtex plugins install cms` command and get the error below, you need to update the VTEX IO CLI version you're using.\n\n`1\n\nvtex plugins install cms \n\n2\n\nerror @oclif/core@1.26.2: The engine \"node\" is incompatible with this module. Expected version \">=14.0.0\". Got \"12.12.0\" \n\n3\n\nerror Found incompatible module. \n\n4\n\nInstalling plugin @vtex/cli-plugin-cms... failed \n\n5\n\n Error: yarn add @vtex/cli-plugin-cms@latest --non-interactive --mutex=file:C:\\Users\\barbara.celi\\AppData\\Local\\vtex\\yarn.lock --preferred-cach \n\n`\n\nEven if you update the `node` version on your machine, you must also keep VTEX IO CLI updated to avoid errors.\n\nTo update VTEX IO CLI, open Windows Terminal and follow these instructions:\n\n1. Run the `vtex autoupdate` command in Windows Terminal.\n2. Run the `vtex -v` command to check if the VTEX IO CLI and `node` versions are updated.\n3. Run the `vtex plugins install cms` command to install the Headless CMS plugins.\n4. Check if the installation of Headless CMS plugins was successful by running `vtex cms`. You should see the following:\n\n`1\n\n$ vtex cms \n\n2\n\nSyncs CMS schemas with the current workspace in use. \n\n3\n\n \n4\n\nUSAGE \n\n5\n\n $ vtex cms COMMAND \n\n6\n\nCOMMANDS \n\n7\n\n cms sync Syncs CMS schemas with the current workspace in use. \n\n`\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/troubleshooting/development/i-cant-install-the-headless-cms-plugins-in-my-account.md)\n\n[I can’t access the Headless CMS« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/unable-to-access-headless-cms)[I can't install VTEX IO CLINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/i-cant-install-vtex-io-cli)\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[Solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account%23solutions)\n\n[Enable Developer Mode on your machine](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account%23enable-developer-mode-on-your-machine)[Update VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account%23update-vtex-io-cli)\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/troubleshooting/development/i-cant-install-the-headless-cms-plugins-in-my-account.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account%23solutions)\n\n[Enable Developer Mode on your machine](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account%23enable-developer-mode-on-your-machine)[Update VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-error-installing-headless-cms/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account%23update-vtex-io-cli)\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_0dd9ec99
|
[
{
"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 summary productsummaryattachmentlist 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-summary-productsummaryattachmentlist/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-summary-productsummaryattachmentlist/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-summary-productsummaryattachmentlist/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-summary-productsummaryattachmentlist/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-summary-productsummaryattachmentlist/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-summary-productsummaryattachmentlist/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-summary-productsummaryattachmentlist/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryattachmentlist/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryattachmentlist/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryattachmentlist/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryattachmentlist/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryattachmentlist/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryattachmentlist/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryattachmentlist/updates/release-notes)\n\nProduct Summary Attachment List\n\nProduct Summary Attachment is the block exported by the [Product Summary app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary) responsible for rendering the [attachment](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/o-que-e-um-anexo--aGICk0RVbqKg6GYmQcWUm) options available for a product.\n\n\n\n## Configuration\n\n1. Import the `vtex.product-summary` app to your theme's dependencies in the `manifest.json`:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.product-summary\": \"2.x\" \n\n3\n\n } \n\n`\n\n1. Add the `product-summary-attachment-list` block to a store template of your choice as a child of the `product-summary.shelf` block. For example:\n\n`1\n\n \"product-summary.shelf\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"product-summary-image\", \n\n4\n\n \"product-summary-name\", \n\n5\n\n \"product-summary-sku-name\", \n\n6\n\n+ \"product-summary-attachment-list\", \n\n7\n\n \"product-summary-space\", \n\n8\n\n \"product-summary-column#1\" \n\n9\n\n ] \n\n10\n\n }, \n\n`\n\nAfter adding the `product-summary-attachment-list` block to your store theme, use the VTEX Admin to add attachments to your products to display the component in your store correctly. For more information, please refer to [Adding an attachment](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/cadastrar-um-anexo--7zHMUpuoQE4cAskqEUWScU).\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| attachmentListContainer |\n| attachmentItemContainer |\n| attachmentItem |\n| attachmentItemProductText |\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-summary-productsummaryattachmentlist.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-summary-productsummaryattachmentlist/docs/guides/vtex-product-summary-productsummaryattachmentlist%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryattachmentlist/docs/guides/vtex-product-summary-productsummaryattachmentlist%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-summary-productsummaryattachmentlist.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-summary-productsummaryattachmentlist/docs/guides/vtex-product-summary-productsummaryattachmentlist%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryattachmentlist/docs/guides/vtex-product-summary-productsummaryattachmentlist%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_86ea2d9d
|
[
{
"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 list pickup points by location 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/list-pickup-points-by-location/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/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/list-pickup-points-by-location/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/list-pickup-points-by-location/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/list-pickup-points-by-location/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/list-pickup-points-by-location/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/list-pickup-points-by-location/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/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/list-pickup-points-by-location/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[List pickup points by location](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/list-pickup-points-by-location)\n\n[Get address by postal code](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/get-address-by-postal-code)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/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/list-pickup-points-by-location/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/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/list-pickup-points-by-location/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/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/list-pickup-points-by-location/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/list-pickup-points-by-location/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/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/list-pickup-points-by-location/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[List pickup points by location](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/list-pickup-points-by-location)\n\n[Get address by postal code](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/get-address-by-postal-code)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/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/list-pickup-points-by-location/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/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/list-pickup-points-by-location/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/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/list-pickup-points-by-location/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/list-pickup-points-by-location/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/checkout-api-overview)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[List pickup points by location](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/list-pickup-points-by-location)\n\nList pickup points by location\n\nPickup points are locations where customers pick up their orders. A store provides pickup points so that its customers have the option of choosing to receive their order at their address (delivery) or to pick it up at a specified location (pickup). For more information, access [pickup points](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).\n\nThis guide will describe how to retrieve information about collection points close to a certain location determined by geographic coordinates or postal and country codes.\n\n## Listing pickup points by location\n\nTo list all pickup points near a specific location, you need to use the [List pickup points by location](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pub/pickup-points) endpoint. There are two methods to retrieve pickup points using query parameters in the URL request.\n\nBase URL: `https://{accountName}.{environment}.com.br/api/checkout/pub/pickup-points`\n\n### 1\\. Geographic coordinates\n\nUse the geographic coordinates (first longitude, then latitude) of the location where you want to check for nearby pickup points. See a URL request example below:\n\n`https://{accountName}.{environment}.com.br/api/checkout/pub/pickup-points?geoCoordinates=-43.1974334;-22.9573465`\n\n### 2\\. Postal and Country Codes\n\nUse the postal and country codes of the location where you want to check for nearby pickup points. See a URL request example below:\n\n`https://{accountName}.{environment}.com.br/api/checkout/pub/pickup-points?postalCode=22250040&countryCode=BRA`\n\n> The search for pickup points must be done using only one of the two methods in the URL (geographical coordinates or postal and country codes). If you try to use both query parameters, the request will not return the list of collection points.\n\nAfter choosing one of the two described methods and sending the URL request, the terminal will return the body of the response containing the information of the registered pickup points closest to the informed location, as shown in the example below:\n\n`1\n\n... \n\n2\n\n \"items\": [ \n\n3\n\n { \n\n4\n\n \"distance\": 0.13299603760242462, \n\n5\n\n \"pickupPoint\": { \n\n6\n\n \"friendlyName\": \"Cantina\", \n\n7\n\n \"address\": { \n\n8\n\n \"addressType\": \"pickup\", \n\n9\n\n \"receiverName\": null, \n\n10\n\n \"addressId\": \"300\", \n\n11\n\n \"isDisposable\": true, \n\n12\n\n \"postalCode\": \"22250-040\", \n\n13\n\n \"city\": \"Rio de Janeiro\", \n\n14\n\n \"state\": \"RJ\", \n\n15\n\n \"country\": \"BRA\", \n\n16\n\n \"street\": \"Praia de Botafogo\", \n\n17\n\n \"number\": \"300\", \n\n18\n\n \"neighborhood\": \"Botafogo\", \n\n19\n\n \"complement\": \"\", \n\n20\n\n \"reference\": null, \n\n21\n\n \"geoCoordinates\": [ \n\n22\n\n -43.18259, \n\n23\n\n -22.94436 \n\n24\n\n ] \n\n25\n\n }, \n\n26\n\n \"additionalInfo\": null, \n\n27\n\n \"id\": \"1_300\", \n\n28\n\n \"businessHours\": [ \n\n29\n\n { \n\n30\n\n \"DayOfWeek\": 0, \n\n31\n\n \"OpeningTime\": \"08:00:00\", \n\n32\n\n \"ClosingTime\": \"08:00:00\" \n\n33\n\n }, \n\n34\n\n { \n\n35\n\n \"DayOfWeek\": 1, \n\n36\n\n \"OpeningTime\": \"08:00:00\", \n\n37\n\n \"ClosingTime\": \"08:00:00\" \n\n38\n\n }, \n\n39\n\n { \n\n40\n\n \"DayOfWeek\": 2, \n\n41\n\n \"OpeningTime\": \"08:00:00\", \n\n42\n\n \"ClosingTime\": \"08:00:00\" \n\n43\n\n }, \n\n44\n\n { \n\n45\n\n \"DayOfWeek\": 3, \n\n46\n\n \"OpeningTime\": \"08:00:00\", \n\n47\n\n \"ClosingTime\": \"08:00:00\" \n\n48\n\n }, \n\n49\n\n { \n\n50\n\n \"DayOfWeek\": 4, \n\n51\n\n \"OpeningTime\": \"08:00:00\", \n\n52\n\n \"ClosingTime\": \"08:00:00\" \n\n53\n\n }, \n\n54\n\n { \n\n55\n\n \"DayOfWeek\": 5, \n\n56\n\n \"OpeningTime\": \"08:00:00\", \n\n57\n\n \"ClosingTime\": \"08:00:00\" \n\n58\n\n }, \n\n59\n\n { \n\n60\n\n \"DayOfWeek\": 6, \n\n61\n\n \"OpeningTime\": \"08:00:00\", \n\n62\n\n \"ClosingTime\": \"08:00:00\" \n\n63\n\n } \n\n64\n\n ] \n\n65\n\n } \n\n66\n\n }, \n\n67\n\n... \n\n`\n\n> The pickup points returned are not necessarily all active. Make sure to validate the current availability information with the responsible for the pick up points on your account.\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 ORD001): \"Input string was not in the correct format\"`: this message will appear when the `geoCoordinates` value field is not set correctly in the URL request.\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"001\", \n\n5\n\n \"message\": \"Input string was not in a correct format.\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"2ff8e1f6-92f7-4921-be19-a5143a5b7a90\" \n\n9\n\n} \n\n`\n\n* `Message error example (code CHK0264): \"Pickup not found\"`: this message will appear when there are no pickup points near the location informed in this request.\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"CHK0264\", \n\n5\n\n \"message\": \"Pickup not found\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"ca010e5c-9943-4485-a575-e79bd0761fa1\" \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 if 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\n2\n\n[](https://github.com/karenkrieger)\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/Checkout/fulfillment-checkout-section-api-quick-start-guides/list-pickup-points-by-location.md)\n\n[Fulfillment« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location//docs/guides/fulfillment-checkout-section-api-quick-start-guides)[Get address by postal codeNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location//docs/guides/get-address-by-postal-code)\n\nContributors\n\n2\n\n[](https://github.com/karenkrieger)\n\n[](https://github.com/ricardoaerobr)\n\nON THIS PAGE\n\n[Listing pickup points by location](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/list-pickup-points-by-location%23listing-pickup-points-by-location)\n\n[1\\. Geographic coordinates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/list-pickup-points-by-location%231-geographic-coordinates)[2\\. Postal and Country Codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/list-pickup-points-by-location%232-postal-and-country-codes)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/list-pickup-points-by-location%23error-codes)\n\n[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/list-pickup-points-by-location%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/list-pickup-points-by-location%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/fulfillment-checkout-section-api-quick-start-guides/list-pickup-points-by-location.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Listing pickup points by location](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/list-pickup-points-by-location%23listing-pickup-points-by-location)\n\n[1\\. Geographic coordinates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/list-pickup-points-by-location%231-geographic-coordinates)[2\\. Postal and Country Codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/list-pickup-points-by-location%232-postal-and-country-codes)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/list-pickup-points-by-location%23error-codes)\n\n[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/list-pickup-points-by-location%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-pickup-points-by-location/docs/guides/list-pickup-points-by-location%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_7e382a38
|
[
{
"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 banner 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/banner/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/banner/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/banner/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/banner/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/banner/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/banner/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/banner/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/banner/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/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/banner/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/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/banner/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/banner/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/banner/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/banner/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/banner/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/banner/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/banner/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/banner/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/banner/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/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/banner/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/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/banner/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/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/banner/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/banner/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/banner/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/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/banner/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/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/banner/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/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/banner/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/banner/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/banner/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/banner/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/banner/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/banner/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/banner/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/banner/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/banner/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/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/banner/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/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/banner/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/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/banner/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/banner/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/banner/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/guides/basic-components)\n\nBanner\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\nBanner is the Intelligent Search feature that displays banners on the customer search results page, depending on the search context.\n\n## Before you begin\n\nMake sure you have added the `search` app to your theme dependencies within 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## Configuration\n\nThe banner entity is composed of the following fields:\n\n| Field | Description |\n| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |\n| Active | Indicates if the banner is active or not. |\n| Banner name | Unique identifier for the banner. |\n| Type banner | Specifies the type of banner, which can be either HTML or IMAGE. |\n| HTML / Image URL | HTML code or image to be inserted. |\n| Area | Indicates the section of the page where the banner will be displayed. It's important when multiple banners are present on the same page. |\n| Terms | List of terms for this banner. |\n| Period | The period that this banner will be active. |\n| Attributes | List of selected attributes for this banner. |\n\n## Usage\n\nAdd the `search-banner` block to `search-result-layout.desktop` or `search-result-layout.mobile`. For example:\n\n`1\n\n{ \n\n2\n\n \"search-result-layout.desktop\": { \n\n3\n\n \"children\": [ \n\n4\n\n \"flex-layout.row#banner-one\" \n\n5\n\n ] \n\n6\n\n }, \n\n7\n\n \"search-banner#one\": { \n\n8\n\n \"props\": { \n\n9\n\n \"area\": \"one\", \n\n10\n\n \"blockClass\": \"myBanner\", \n\n11\n\n \"horizontalAlignment\": \"center\" \n\n12\n\n } \n\n13\n\n }, \n\n14\n\n \"flex-layout.row#banner-one\": { \n\n15\n\n \"children\": [ \n\n16\n\n \"search-banner#one\" \n\n17\n\n ] \n\n18\n\n } \n\n19\n\n} \n\n`\n\n## Props\n\n| Prop name | Type | Description | Default value |\n| ------------------- | ------ | -------------------------------------------------------------------- | ------------- |\n| area | String | Indicates the area. It must match the area configured in the banner. | \\- |\n| blockClass | String | Defines a custom class to the banner div. | \\- |\n| horizontalAlignment | String | Defines the horizontal alignment for the banner. | \"center\" |\n\nThe possible values for `horizontalAlignment` are:\n\n| Values |\n| -------- |\n| \"left\" |\n| \"right\" |\n| \"center\" |\n\n## Customization\n\nTo apply CSS customizations to this and other blocks, follow the instructions in the guide [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| searchBanner |\n\n[Autocomplete« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.search/Autocomplete)[BreadcrumbNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.breadcrumb)\n\nSee also\n\n[Vtex.searchVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/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/banner/docs/apps/vtex.search/banner%23before-you-begin)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.search/banner%23configuration)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.search/banner%23usage)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.search/banner%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/banner/docs/apps/vtex.search/banner%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_b0fbe2fb
|
[
{
"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 2 starting the project 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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)\n\n[6\\. Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/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-2-starting-the-project/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)\n\n[6\\. Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/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-2-starting-the-project/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/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-2-starting-the-project/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-overview)\n\n2\\. Starting a new FastStore project\n\nCreate and set up your FastStore project with WebOps.\n\nIn this step, you'll use the [FastStore WebOps app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-dashboard) to create your FastStore project, connect it to GitHub, and deploy a live preview.\n\nThis establishes your project’s source of truth and CI/CD path — the foundation for all later steps in this track.\n\n## What you'll accomplish\n\nBy the end of this step, you will have:\n\n* Created your FastStore project with basic configuration (project name, SEO tags, GTM, catalog)\n* Connected your project to a GitHub repository for version control\n* Set up the Headless CMS integration for content management\n* Deployed your project and generated a live preview of your storefront\n\nYour project will be accessible at `https://{accountName}.vtex.app/` and ready for local development in the next step.\n\n## Getting to know the WebOps app\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-dashboard) is the **control plane** for FastStore projects. It manages every stage of your storefront’s lifecycle, from creation to deployment, and integrates with your GitHub repository and VTEX account to facilitate collaboration and automation.\n\n\n\nWebOps connects your storefront code (GitHub) with your VTEX infrastructure, enabling a branch-based workflow for development and production. Keep the following in mind:\n\n* **Environment requirement:** WebOps operates exclusively in the production environment. Install it only in your account’s `master` environment.\n* **Development workflow:** FastStore uses a [Git branching model](https://read.calvincode.net/reader?url=https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches) for development and testing: \n * The app is installed in the `master` environment of your VTEX account. \n * Development and testing occur on Git branches. \n * Approved changes are merged into the repository’s `main` branch and automatically deployed to production.\n\n> Unlike [VTEX IO workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace), FastStore uses a Git-based branching workflow.\n\n## Before you begin\n\n### Check permissions\n\nTo start a FastStore project, users must have the **Owner (Admin Super)** [role](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc%23roles).\n\n### Create your store catalog\n\nCreate a catalog to populate and test your store. It should include essential components such as product listing pages, search, product details, and checkout. Developing without a catalog may result in incomplete testing, data integration issues, and rework later.\n\nFor more information, refer to the [Catalog documentation](https://read.calvincode.net/reader?url=https://help.vtex.com/docs/tracks/catalog).\n\n### Have a GitHub account\n\nTo complete the FastStore WebOps onboarding, you’ll need a GitHub account to host your project. You can use either a [personal account](https://read.calvincode.net/reader?url=https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github) or a [GitHub organization](https://read.calvincode.net/reader?url=https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/about-organizations). \nIf you use a GitHub organization, ensure you have **admin access** to it.\n\n## Step 1: Setting up the project\n\n1. Open the VTEX Admin and access **Storefront > FastStore WebOps**.\n2. Click `Start Project`.\n3. In the **Setup & Create Project** page, configure the following options for your store:\n\n### Project\n\nChoose the option that best fits your project's purpose. This helps us understand what you're trying to achieve with FastStore and improve your experience.\n\n| Field | Description |\n| --------------------------------------------------------- | ------------------------------------------------------------ |\n| **Project name** | Enter your FastStore project's name, e.g., Marcio Car store. |\n| **Which option best describes the goal of your project?** | Choose the option that best fits your project’s purpose. |\n\n### SEO Tags\n\n| Field | Description |\n| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **Title Tag** | Enter a keyword-optimized title for your store. For example: Buy Online with the Best Game Store - GameStore. In this example, we used the length limit of around 50-60 characters to ensure it is fully displayed in search results without being truncated. |\n| **Description Tag** | Enter a brief description of your store, for example, Shop online at GameStore, the best game store for PC, Xbox, PS4 and Headphones. Explore our wide selection and buy your favorite games today! |\n| **Title Template** | Enter a page title that helps search engines and users better understand the content of your store. For example, The best game store - GameStore. |\n| **Site Author** | Enter the name of the agency or person responsible for the development of the storefront. |\n\n### Google Tag Manager\n\n| Field | Description |\n| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| **GTM ID** | Enter the Google Tag Manager ID (GTM ID) associated with the GTM container responsible for managing and organizing the tags of your store. |\n\n### Catalog\n\n| Field | Description |\n| ----------- | ------------------------------------------------------ |\n| **Catalog** | Choose which catalog your store should be linked with. |\n\n### Terms of use\n\nIf you already have content created in the [Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview), be aware that it will be automatically deleted during FastStore WebOps onboarding to avoid content duplication.\n\nTo proceed, please confirm that you understand by checking the Terms of use box.\n\nAfter setting up the basic configuration for your store and reviewing it, click `Continue` to proceed to the next page.\n\n## Step 2: Setting up integrations\n\nOn this page, you will set up the native Headless CMS integration and connect to a GitHub organization.\n\n### CMS Integration\n\nConfigure the native [Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview) integration and connect to GitHub.\n\n### Git Provider\n\nConnect with a GitHub personal account or organization of your choice to host the source code of your FastStore project.\n\n> If you choose to install the app in a GitHub organization, make sure you have admin access to an organization.\n\nTo connect to the FastStore WebOps app, follow these steps:\n\n1. Click `Connect with GitHub`. A new browser tab will open on the side for you to integrate the app with GitHub. \n> If you are not logged in to your GitHub account, in the new tab, you will be asked to log in. Then, you can continue to the next step.\n2. Once you are logged in to your GitHub account, choose the organization or your personal account you want to install the app. You will be redirected to the **Settings** page on GitHub. \n> Once you define the GitHub organization, you cannot change it later.\n3. In **Repository access**, choose one of the following options: **All repositories from the organization** or **Only select repositories**.\n4. Click `Install`.\n\nThe following successful message will appear on the page:\n\n`1\n\nSuccess! You can now close this page and proceed with the onboarding process. \n\n`\n\nAfter seeing the success message, close the browser tab and continue the onboarding process in the VTEX Admin.\n\n1. Now that the app is integrated with GitHub, select which repository you want to start the project: \n * **New repository:** Create a repository from scratch, in this option, you only need to type a name for the repository, and after clicking `Create`, it will create the repository for you. \n * **Existing repository:** Select an existing repository from the organization to start the project.\n2. Click `Create`. The deployment process will begin, and once it is complete, you will be redirected to the [Deploy Summary](#step-3--deploying-the-project) page.\n\n## Step 3: Deploying the project\n\nAfter completing the setup for your store, the deployment process will begin. This process involves creating a GitHub repository and a default domain for your project. Once the deployment process is complete, you should see the following:\n\n\n\n| Option | Description |\n| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **Your Repository** | Access the store's GitHub repository and start setting up and customizing your store. |\n| **Documentation** | Access the FastStore Portal Documentation. |\n| **Customization** | Access the documentation on how to customize your store. |\n| **View Dashboard** | Access the Dashboard with the current status of your store, including its domains, deployed versions, store preview, and Lighthouse scores. For more information, please refer to the [Dashboard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-dashboard) guide. |\n\n> If repository creation fails and no live preview is generated, click **Retry** to redeploy.\n\n## Next step\n\nNow that your store is up and running with a live preview, set up your local development environment: [3\\. Running the project locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project)\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\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/faststore/docs/getting-started/2-starting-the-project.mdx)\n\n[1\\. Setting up your environment« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-1-setting-up-your-environment)[3\\. Running the project locallyNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-3-running-the-project-locally)\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\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-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23what-youll-accomplish)\n\n[Getting to know the WebOps app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23getting-to-know-the-webops-app)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23before-you-begin)\n\n[Check permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23check-permissions)[Create your store catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23create-your-store-catalog)[Have a GitHub account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23have-a-github-account)\n\n[Step 1: Setting up the project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23step-1-setting-up-the-project)\n\n[Project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23project)[SEO Tags](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23seo-tags)[Google Tag Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23google-tag-manager)[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23catalog)[Terms of use](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23terms-of-use)\n\n[Step 2: Setting up integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23step-2-setting-up-integrations)\n\n[CMS Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23cms-integration)[Git Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23git-provider)\n\n[Step 3: Deploying the project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23step-3-deploying-the-project)\n\n[Next step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%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/2-starting-the-project.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-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23what-youll-accomplish)\n\n[Getting to know the WebOps app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23getting-to-know-the-webops-app)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23before-you-begin)\n\n[Check permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23check-permissions)[Create your store catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23create-your-store-catalog)[Have a GitHub account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23have-a-github-account)\n\n[Step 1: Setting up the project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23step-1-setting-up-the-project)\n\n[Project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23project)[SEO Tags](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23seo-tags)[Google Tag Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23google-tag-manager)[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23catalog)[Terms of use](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23terms-of-use)\n\n[Step 2: Setting up integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23step-2-setting-up-integrations)\n\n[CMS Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23cms-integration)[Git Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23git-provider)\n\n[Step 3: Deploying the project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23step-3-deploying-the-project)\n\n[Next step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%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_4826a386
|
[
{
"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 slider 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.slider-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.slider-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.slider-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.slider-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.slider-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.slider-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.slider-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.slider-layout/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-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.slider-layout/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/guides/layout-apps)\n\n[Condition Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/apps/vtex.condition-layout)\n\n[Disclosure Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/apps/vtex.disclosure-layout)\n\n[Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/apps/vtex.flex-layout)\n\n[Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/apps/vtex.modal-layout)\n\n[Overlay Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/apps/vtex.overlay-layout)\n\n[Responsive Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/apps/vtex.responsive-layout)\n\n[Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/apps/vtex.slider-layout)\n\n[Stack Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/apps/vtex.stack-layout)\n\n[Sticky Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/apps/vtex.sticky-layout)\n\n[Tab Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-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.slider-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.slider-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.slider-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.slider-layout/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-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.slider-layout/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-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.slider-layout/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/guides/layout-apps)\n\n[Condition Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/apps/vtex.condition-layout)\n\n[Disclosure Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/apps/vtex.disclosure-layout)\n\n[Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/apps/vtex.flex-layout)\n\n[Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/apps/vtex.modal-layout)\n\n[Overlay Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/apps/vtex.overlay-layout)\n\n[Responsive Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/apps/vtex.responsive-layout)\n\n[Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/apps/vtex.slider-layout)\n\n[Stack Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/apps/vtex.stack-layout)\n\n[Sticky Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/apps/vtex.sticky-layout)\n\n[Tab Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-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.slider-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.slider-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.slider-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.slider-layout/docs/vtex-io-apps)\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/guides/layout-apps)\n\nSlider Layout\n\nOfficial extension\n\nVersion: 0.24.8\n\nLatest version: 0.24.8\n\n[](#contributors-)\n\nSlider Layout is a flexible solution for building block sliders in VTEX Store Framework, such as a carousel component.\n\n\n\n> _To use the Slider layout as a substitute for the [Carousel app](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/carousel), read the [Building a Carousel through lists and Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-carousel-using-slider-layout) documentation._\n\n## Google Analytics 4 Integration\n\nSlider Layout enables you to integrate your component with [Google Analytics 4](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4). The integration happens through the [GA4 view\\_promotion](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23view%5Fpromotion) event, which is typically associated with the promotion banners carousel displayed by the Slider Layout.\n\nBy integrating with Google Analytics 4, you can set the `Product ID` and `Product Name`, and position of your promotion on [Site Editor](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/site-editor-overview--299Dbeb9mFczUTyNQ9xPe1) to be shown on a Google Analytics dashboard.\n\nTo set this up, go to the VTEX Admin, access **Storefront > Site Editor**, and open the image settings of the internal promotion you want to track. These settings are displayed on the right side of the page.\n\n\n\n> For more information about managing your page content, read [Managing page and template content](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/managing-page-and-template-content--3tMbx6HXy4Fy5r9EhboG37).\n\nAfter setup, Google Analytics can track your internal promotions and generate reports of their views, clicks, click-through rate, conversions, and revenue.\n\n## Configuration\n\n1. Add the `slider-layout` app to your theme dependencies in the `manifest.json` file:\n\n`1\n\n\"dependencies\": { \n\n2\n\n \"vtex.slider-layout\": \"0.x\" \n\n3\n\n} \n\n`\n\nNow, you can use all blocks exported by the `slider-layout` app. See the complete list below:\n\n| Block name | Description |\n| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| slider-layout |  Builds block sliders for your store through its children list blocks. |\n| slider-layout-group | Enables you to keep a group of slider-layout blocks synched with each other. For more information about this, see the Advanced configuration section below. |\n\n1. Add the `slider-layout` block to your template. For example:\n\n`1\n\n \"slider-layout#text-test\": { \n\n2\n\n \"props\": { \n\n3\n\n \"itemsPerPage\": { \n\n4\n\n \"desktop\": 1, \n\n5\n\n \"tablet\": 1, \n\n6\n\n \"phone\": 1 \n\n7\n\n }, \n\n8\n\n \"infinite\": true, \n\n9\n\n \"showNavigationArrows\": \"desktopOnly\", \n\n10\n\n \"blockClass\": \"carousel\" \n\n11\n\n }, \n\n12\n\n \"children\": [\"rich-text#1\", \"rich-text#2\", \"rich-text#3\"] \n\n13\n\n }, \n\n14\n\n \n15\n\n \"rich-text#1\": { \n\n16\n\n \"props\": { \n\n17\n\n \"text\": \"Test1\" \n\n18\n\n } \n\n19\n\n }, \n\n20\n\n \"rich-text#2\": { \n\n21\n\n \"props\": { \n\n22\n\n \"text\": \"Test2\" \n\n23\n\n } \n\n24\n\n }, \n\n25\n\n \"rich-text#3\": { \n\n26\n\n \"props\": { \n\n27\n\n \"text\": \"Test3\" \n\n28\n\n } \n\n29\n\n }, \n\n`\n\n| Prop name | Type | Description | Default value |\n| -------------------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |\n| label | string | aria-label attribute value to be used by the <Slider/> component when rendered. The aria-label value should explicitly tell users what the inspected HTML element does. | slider |\n| showNavigationArrows | enum | Indicates when navigation arrows should be rendered. Possible values are: mobileOnly, desktopOnly, always, or never. | always |\n| showPaginationDots | enum | Indicates when pagination dots should be rendered. Possible values are: mobileOnly, desktopOnly, always, or never. | always |\n| infinite | boolean | Determines whether the slider should be infinite (true) or not (false). When this prop is set as false, the slider will have an explicit end for users. | false |\n| usePagination | boolean | Determines whether the slider should use slide pages (true) or not (false). When this prop is set as false, the slider will use smooth scrolling for slide navigation instead of arrows. | true |\n| itemsPerPage | object | The number of slider items to be shown on each type of device. For more information about this, see the itemsPerPage object section below. | { desktop: 5, tablet: 3, phone: 1 } |\n| navigationStep | number / enum | The number of slider items that should be displayed when users click one of the slider arrows. It is also possible to set this prop value as page, meaning that the number of slider items to be displayed when one of the arrows is clicked is equal to the number of slider items set per page (in the itemsPerPage prop). | page |\n| slideTransition | object | Controls the transition animation between slides based on [CSS attributes](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/CSS/transition). For more information about this, see the slideTransition object section below. | { speed: 400, delay: 0, timing: '' } |\n| autoplay | object | Controls the autoplay feature behavior. For more information about this, see the autoplay object section below. | undefined |\n| fullWidth | boolean | Determines whether the slides should occupy the full page width, making the arrows appear on top of them (true) or not (false). | true |\n| arrowSize | number / object | Slider arrows size (height and width) in pixels. This is a responsive prop, which means you can pass to it an object with different values for each breakpoint (desktop, mobile, tablet, and phone). | 25 |\n| centerMode | enum / object | Defines positioning of the slider elements on the screen. Possible values are: center (elements are centered, allowing users to see a peek of the previous and next slides), to-the-left (aligns elements to the left side, allowing users to see a peek of the next slide, but not the previous one), and disabled (disables the feature, rendering elements on the whole screen without showing a peek of the previous and next slides). Note: This is a responsive prop, which means you can pass to it an object with different values for each breakpoint (desktop, mobile, tablet, and phone). | disabled |\n| centerModeSlidesGap | number | Number of pixels between slides when centerMode is set to center or to-the-left. | undefined |\n\n* **`itemsPerPage` object**\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | -------------------------------------------------------- | ------------- |\n| desktop | number | The number of slides to be displayed on desktop devices. | 5 |\n| tablet | number | The number of slides to be displayed on tablet devices. | 3 |\n| phone | number | The number of slides to be displayed on phone devices. | 1 |\n\n* **`slideTransition` object**\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | --------------------------------------- | ------------- |\n| speed | number | Transition speed (in ms). | 400 |\n| delay | number | Delay between slide transition (in ms). | 0 |\n| timing | string | Timing function. | '' |\n\n* **`autoplay` object**\n\n| Prop name | Type | Description | Default value |\n| ----------- | ------- | ---------------------------------------------------------------------------------------------------------- | ------------- |\n| timeout | number | Timeout (in ms) between each slide. | undefined |\n| stopOnHover | boolean | Determines whether the autoplay should stop when users are hovering over the slider (true) or not (false). | undefined |\n\n## Advanced configuration\n\nThe `slider-layout-group` block synchronizes the slides rendered by each `slider-layout` block declared in it.\n\nTherefore, the `slider-layout-group` does not render any specific component on the store UI. It is really a logical block that only expects to receive a `children` block list containing the desired `slider-layout` blocks that should be rendered. For example:\n\n`1\n\n{ \n\n2\n\n \"slider-layout-group#test\": { \n\n3\n\n \"children\": [\"slider-layout#1\", \"slider-layout#2\", \"slider-layout#3\"] \n\n4\n\n } \n\n5\n\n} \n\n`\n\nBelow, you can find a practical example using three `slider-layout` blocks inside of a `slider-layout-group`. Each `slider-layout` received three `rich-text` blocks as `children` to serve as individual slides:\n\n\n\n> **\\*All `slider-layout` blocks declared in the `slider-layout-group` must have the same configuration, meaning the same props and values**. Due to implementation rules, they can only differ in their `children` block list. Keep in mind that declaring `slider-layout` blocks with different configurations will result in unexpected behavior, leading to errors that are **not** supported by the VTEX Store Framework team.\\*\n\n## Customization\n\nTo apply CSS customizations to 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| paginationDot--isActive |\n| paginationDot |\n| paginationDotsContainer |\n| slide--firstVisible |\n| slide--hidden |\n| slide--lastVisible |\n| slide--visible |\n| slideChildrenContainer |\n| slide |\n| sliderArrows |\n| sliderLayoutContainer |\n| sliderLeftArrow |\n| sliderRightArrow |\n| sliderTrackContainer |\n| sliderTrack |\n\n[Responsive Layout« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/apps/vtex.responsive-layout)[Stack LayoutNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/apps/vtex.stack-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[Google Analytics 4 Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/apps/vtex.slider-layout%23google-analytics-4-integration)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/apps/vtex.slider-layout%23configuration)\n\n[Advanced configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/apps/vtex.slider-layout%23advanced-configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout/docs/apps/vtex.slider-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_76364a8f
|
[
{
"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 creating modals using icons 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-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-modals-using-icons/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/docs/guides/store-framework-using-advanced-layouts)\n\n[Building a Carousel using Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-modals-using-icons/docs/guides/vtex-io-documentation-building-a-carousel-using-slider-layout)\n\n[Creating a Quickview using Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-modals-using-icons/docs/guides/vtex-io-documentation-creating-a-quickview-using-modal-layout)\n\n[Creating modals using icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-modals-using-icons/docs/guides/vtex-io-documentation-creating-modals-using-icons)\n\n[Rendering a badge on top of a product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-modals-using-icons/docs/guides/vtex-io-documentation-rendering-a-badge)\n\n[Using Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-modals-using-icons/docs/guides/vtex-io-documentation-using-flex-layout)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-modals-using-icons/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-modals-using-icons/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-modals-using-icons/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-modals-using-icons/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-modals-using-icons/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-modals-using-icons/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/docs/guides/store-framework-using-advanced-layouts)\n\n[Building a Carousel using Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-modals-using-icons/docs/guides/vtex-io-documentation-building-a-carousel-using-slider-layout)\n\n[Creating a Quickview using Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-modals-using-icons/docs/guides/vtex-io-documentation-creating-a-quickview-using-modal-layout)\n\n[Creating modals using icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-modals-using-icons/docs/guides/vtex-io-documentation-creating-modals-using-icons)\n\n[Rendering a badge on top of a product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-modals-using-icons/docs/guides/vtex-io-documentation-rendering-a-badge)\n\n[Using Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-modals-using-icons/docs/guides/vtex-io-documentation-using-flex-layout)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/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-creating-modals-using-icons/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-modals-using-icons/docs/guides/store-framework)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-modals-using-icons/docs/guides/store-framework-using-advanced-layouts)\n\n[Creating modals using icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-modals-using-icons/docs/guides/vtex-io-documentation-creating-modals-using-icons)\n\nCreating modals using icons\n\nWhen talking about ecommerce, a modal is a **popup window**, triggered by an UI component, that forces users to interact with it before a certain action is taken during browsing.\n\nLet's look at the following scenario: ready to proceed to checkout, a user browsing your store has a full cart. The user then removes an item from the product list without noticing, by accidentally clicking on the trash icon.\n\nTo your business, it's advantageous to trigger a popup window in this removal icon, requiring user confirmation to complete the action. In a lot of cases, the modal will contribute to an increase in conversion rate.\n\nTo build modals in such a scenario using Store Framework, we'll use the [Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout) block and the icons exported by the [Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons) app.\n\n## Instructions\n\nFor this step, we'll take the example given above: let's add a modal to the icon used by the [Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart) to remove product list items.\n\n1. Using a [development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/), open you store's theme using any code editor;\n2. In the `blocks.json` folder, look for the block responsible for rendering the desired icon. In our example, the minicart icon is the removal one and the block responsible for rendering it is called `remove-button`:\n\n`1\n\n \"flex-layout.col#remove-button.desktop\": { \n\n2\n\n \"children\": [\"remove-button\"], \n\n3\n\n \"props\": { \n\n4\n\n \"marginLeft\": \"3\" \n\n5\n\n } \n\n6\n\n }, \n\n`\n\n1. Remove the block responsible for the icon and in its place add the Modal Layout's app `modal-trigger` block:\n\n`1\n\n \"flex-layout.col#remove-button.mobile\": { \n\n2\n\n \"children\": [\"modal-trigger#confirmation-modal\"], \n\n3\n\n \"props\": { \n\n4\n\n \"marginLeft\": \"3\" \n\n5\n\n } \n\n6\n\n }, \n\n`\n\n1. Then, declare the new `modal-trigger` block: list the `modal-layout` block as its child and, according to your store's scenario, list the icon you wish to trigger the modal. For example:\n\n`1\n\n \"modal-trigger#confirmation-modal\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"icon-delete\", \n\n4\n\n \"modal-layout#confirmation-modal\" \n\n5\n\n ] \n\n6\n\n }, \n\n`\n\n> Looking at our example, the icon we wish to use to trigger the modal is the one for removal. We therefore add the `icon-delete` (exported by the Store Icons app) to the list of `modal-trigger` children. Choose the icon according to your store's scenario.\n\n1. Then, declare the `modal-layout` block along with the `modal-actions` block as a child of the first. You can also declare other blocks you may want to have rendered in the modal, such as a [Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-rich-text/). For example:\n\n`1\n\n \"modal-layout#confirmation-modal\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"modal-actions#confirmation-modal\" \n\n4\n\n ] \n\n5\n\n }, \n\n`\n\n1. Upon declaring the `modal-actions` block, list `modal-actions.close` as its child, along with the block previously removed in step 3 to make way for `modal-trigger`. In our example, it's the `remove-button`:\n\n`1\n\n \"modal-actions#confirmation-modal\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"modal-actions.close\", \n\n4\n\n \"remove-button\" \n\n5\n\n ] \n\n6\n\n }, \n\n`\n\n1. Once you're happy with the changes, follow our documentation on [making your theme content public](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-theme-content-public/) to make your configurations available to end users.\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-creating-modals-using-icons.md)\n\n[Creating a Quickview using Modal Layout« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-modals-using-icons//docs/guides/vtex-io-documentation-creating-a-quickview-using-modal-layout)[Rendering a badge on top of a productNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-modals-using-icons//docs/guides/vtex-io-documentation-rendering-a-badge)\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-creating-modals-using-icons/docs/guides/vtex-io-documentation-creating-modals-using-icons%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-creating-modals-using-icons.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-creating-modals-using-icons/docs/guides/vtex-io-documentation-creating-modals-using-icons%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_198a79a8
|
[
{
"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 add and handle custom information in the 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/add-and-handle-custom-information-in-the-order/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-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/add-and-handle-custom-information-in-the-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/add-and-handle-custom-information-in-the-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/add-and-handle-custom-information-in-the-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/add-and-handle-custom-information-in-the-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/add-and-handle-custom-information-in-the-order/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-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/add-and-handle-custom-information-in-the-order/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/custom-data-1)\n\n[Add and handle custom information in the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/add-and-handle-custom-information-in-the-order)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/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/add-and-handle-custom-information-in-the-order/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/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/add-and-handle-custom-information-in-the-order/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-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/add-and-handle-custom-information-in-the-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/add-and-handle-custom-information-in-the-order/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-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/add-and-handle-custom-information-in-the-order/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/custom-data-1)\n\n[Add and handle custom information in the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/add-and-handle-custom-information-in-the-order)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/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/add-and-handle-custom-information-in-the-order/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/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/add-and-handle-custom-information-in-the-order/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-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/add-and-handle-custom-information-in-the-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/add-and-handle-custom-information-in-the-order/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/custom-data-1)\n\n[Add and handle custom information in the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/add-and-handle-custom-information-in-the-order)\n\nAdd and handle custom information in the order\n\nWhen the end customer enters the checkout process at a VTEX store, all order information is organized within fields of the `orderForm` object.\n\nHowever, some stores have the need to request customer data that is not part of the orderForm's default set of objects. For example: gender, cell phone number, age, etc.\n\nTo include them, you must use the `customData` field in the `orderForm`. The purpose of this field is to be populated with custom information needed for the specific operation of the store.\n\nTo work with this field, you must use VTEX’s Checkout API. Three steps are required:\n\n1. [Creating apps and fields through the configuration request](#creating-apps-and-fields-through-the-configuration-request).\n2. [Using the API to record/update/query the data (via orderForm and placeOrder)](#using-the-api-to-recordupdatequery-the-data).\n3. [Finding the desired data in the created order](#finding-the-desired-data-in-the-created-order).\n\n## Creating apps and fields through the configuration request\n\nBefore populating the `customData` field, you need to use the [Update orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pvt/configuration/orderForm) request to create an app. This app will contain custom fields that will be populated during checkout.\n\n> The **Update orderForm configuration** defines settings that apply to all `orderForms` generated in your account. This means that, from the moment you add an app through it, all the store’s orders will contain the extra fields defined in that app. To create an app and its fields, this call only needs to happen once. For more information, access the [Update an account’s orderForm configuration developers guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-an-account-orderform-configuration).\n\nSee below a request body example of the **Updater orderForm configuration** endpoint containing an `apps` object:\n\n`1\n\n... \n\n2\n\n\"apps\": [ \n\n3\n\n { \n\n4\n\n \"fields\": [ \n\n5\n\n \"gender\", \n\n6\n\n \"age\" \n\n7\n\n ], \n\n8\n\n \"id\": \"profile\", \n\n9\n\n \"major\": 1 \n\n10\n\n }, \n\n11\n\n { \n\n12\n\n \"fields\": [ \n\n13\n\n \"street\" \n\n14\n\n ], \n\n15\n\n \"id\": \"address\", \n\n16\n\n \"major\": 1 \n\n17\n\n } \n\n18\n\n ] \n\n19\n\n... \n\n`\n\nIn this case, two applications will be created, which function as groups of fields: one with ID `profile` and one with ID `address`.\n\nThe **profile** app has two fields:\n\n* `gender`\n* `age`\n\nThe **address** app has only one field:\n\n* `street`\n\n## Using the API to record/update/query the data\n\nAfter creating the fields, we need to save the data in them. This can be done using one of the following requests: [Set single custom field value](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23put-/api/checkout/pub/orderForm/-orderFormId-/customData/-appId-/-appFieldName-) or [Set multiple custom field values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23put-/api/checkout/pub/orderForm/-orderFormId-/customData/-appId-).\n\n### **Set single custom field value**\n\nTo update a value of a specific custom field, you can use this [endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23put-/api/checkout/pub/orderForm/-orderFormId-/customData/-appId-/-appFieldName-) by sending the value to be updated (`appFieldValue`) through the request body. The following information must be sent as path parameters in the URL:\n\n* `orderFormId`: ID of the orderForm that will receive the new custom field values.\n* `appId`: ID of the app created through the [Update orderForm Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pvt/configuration/orderForm) endpoint.\n* `appFieldName`: name of the app's field created through the [Update orderForm Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pvt/configuration/orderForm) endpoint.\n\nSee a URL and request body example below:\n\nURl: `https://{accountName}.{environment}.com.br/api/checkout/pub/orderForm/ede846222cd44046ba6c638442c3505a/customData/address/street`\n\n`1\n\n{ \n\n2\n\n \"value\": \"Bourbon Street\" \n\n3\n\n} \n\n`\n\n### **Set multiple custom field values**\n\nTo update values of multiple custom fields at the same time, you can use this [endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23put-/api/checkout/pub/orderForm/-orderFormId-/customData/-appId-) by sending all the values and their respective fields to be updated in the request body (`appFieldValue` and `appFieldName`). The following information must be sent as path parameters in the URL:\n\n* `orderFormId`: ID of the orderForm that will receive the new custom field values.\n* `appId`: ID of the app created through the [Update orderForm Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pvt/configuration/orderForm) endpoint.\n\nSee a URL and request body example below:\n\nURl: `https://{accountName}.{environment}.com.br/api/checkout/pub/orderForm/ede846222cd44046ba6c638442c3505a/customData/address`\n\n`1\n\n{ \n\n2\n\n \"street\": \"Bourbon Street\", \n\n3\n\n \"number\": \"78\", \n\n4\n\n \"postalCode\": \"11554\" \n\n5\n\n} \n\n`\n\nAfter choosing one of the methods and sending the URL request, the terminal will return the response body containing the updated custom data information, as shown in the example below:\n\n`1\n\n... \n\n2\n\n\"customData\": { \n\n3\n\n \"customApps\": [ \n\n4\n\n { \n\n5\n\n \"fields\": { \n\n6\n\n \"street\": \"Bourbon Street\", \n\n7\n\n \"number\": \"78\", \n\n8\n\n \"postalCode\": \"11554\" \n\n9\n\n }, \n\n10\n\n \"id\": \"address\", \n\n11\n\n \"major\": 1 \n\n12\n\n } \n\n13\n\n ] \n\n14\n\n }, \n\n15\n\n... \n\n`\n\n## Finding the desired data in the created order\n\nFinally, it is necessary to implement access to the data saved in the orderForm’s extra fields. To do this, use 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-), appending the order ID to the URL.\n\nThe fields and their respective values will be inside the `customData` object.\n\n## Remove single custom field value\n\nTo remove the value of a specific custom field, you can use the [Remove single custom field value](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23delete-/api/checkout/pub/orderForm/-orderFormId-/customData/-appId-/-appFieldName-) endpoint by sending the following information as path parameters in the URL:\n\n* `orderFormId`: ID of the orderForm where the custom field value will be deleted.\n* `appId`: ID of the app created through the [Update orderForm Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pvt/configuration/orderForm) endpoint.\n* `appFieldName`: name of the app's field created through the [Update orderForm Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pvt/configuration/orderForm) endpoint and which will be deleted.\n\nSee a URL and request body example below:\n\n`https://{accountName}.{environment}.com.br/api/checkout/pub/orderForm/ede846222cd44046ba6c638442c3505a/customData/address/street`\n\n## Error codes\n\nThe following errors may appear as a message in the response body.\n\n### Set single custom field value and Set multiple custom field values endpoints\n\n#### 400 - Bad Request\n\n* `Message error example (code ORD002): \"Invalid order form\"`: this message indicates that the `orderFormId` used in the request does not exist or is incorrect.\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\": \"f2b8107f-e5d5-4b7c-b719-344d1b05d1fa\" \n\n9\n\n} \n\n`\n\n* `Message error example (code CHK0121): \"Invalid app fields\"`: this message indicates that the `value` was not sent in this request.\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"CHK0121\", \n\n5\n\n \"message\": \"Invalid app fields\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"62cf897f-2025-4304-8e25-2104b58d416d\" \n\n9\n\n} \n\n`\n\n#### 404 - Not found\n\n* `Message error example (code CHK0090): \"App id not found\"`: this message indicates that the `appId` parameter used in the request does not exist or is incorrect.\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"CHK0090\", \n\n5\n\n \"message\": \"App id not found\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"0926942a-769b-45ec-a7c3-3d733ed76a46\" \n\n9\n\n} \n\n`\n\n* `Message error example (code CHK0091): \"App key not found for id profile\"`: this message indicates that the `appFieldName` parameter used in the request does not exist or is incorrect. This message code is applicable only for the **Set single custom field value** endpoint.\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"CHK0091\", \n\n5\n\n \"message\": \"App key not found for id profile\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"6e8191fb-4f2a-41c8-8155-92d2595a96b3\" \n\n9\n\n} \n\n`\n\n### Update orderForm configuration endpoint\n\n#### 400 - Bad Request\n\n* `Message error example (code CHK0288): \"Invalid configuration\"`: this message indicates that the mandatory parameters (`paymentConfiguration`, `requiresAuthenticationForPreAuthorizedPaymentOption` and `minimumQuantityAccumulatedForItems`) was not sent in this request.\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"CHK0288\", \n\n5\n\n \"message\": \"Invalid configuration\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"f2b8107f-e5d5-4b7c-b719-344d1b05d1fa\" \n\n9\n\n} \n\n`\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\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/Checkout/custom-data-1/add-and-handle-custom-information-in-the-order.md)\n\n[Custom Data« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order//docs/guides/custom-data-1)[CustomizationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order//docs/guides/customization)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/ricardoaerobr)\n\nON THIS PAGE\n\n[Creating apps and fields through the configuration request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/add-and-handle-custom-information-in-the-order%23creating-apps-and-fields-through-the-configuration-request)\n\n[Using the API to record/update/query the data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/add-and-handle-custom-information-in-the-order%23using-the-api-to-recordupdatequery-the-data)\n\n[Set single custom field value](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/add-and-handle-custom-information-in-the-order%23set-single-custom-field-value)[Set multiple custom field values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/add-and-handle-custom-information-in-the-order%23set-multiple-custom-field-values)\n\n[Finding the desired data in the created order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/add-and-handle-custom-information-in-the-order%23finding-the-desired-data-in-the-created-order)\n\n[Remove single custom field value](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/add-and-handle-custom-information-in-the-order%23remove-single-custom-field-value)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/add-and-handle-custom-information-in-the-order%23error-codes)\n\n[Set single custom field value and Set multiple custom field values endpoints](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/add-and-handle-custom-information-in-the-order%23set-single-custom-field-value-and-set-multiple-custom-field-values-endpoints)[Update orderForm configuration endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/add-and-handle-custom-information-in-the-order%23update-orderform-configuration-endpoint)\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/custom-data-1/add-and-handle-custom-information-in-the-order.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Creating apps and fields through the configuration request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/add-and-handle-custom-information-in-the-order%23creating-apps-and-fields-through-the-configuration-request)\n\n[Using the API to record/update/query the data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/add-and-handle-custom-information-in-the-order%23using-the-api-to-recordupdatequery-the-data)\n\n[Set single custom field value](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/add-and-handle-custom-information-in-the-order%23set-single-custom-field-value)[Set multiple custom field values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/add-and-handle-custom-information-in-the-order%23set-multiple-custom-field-values)\n\n[Finding the desired data in the created order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/add-and-handle-custom-information-in-the-order%23finding-the-desired-data-in-the-created-order)\n\n[Remove single custom field value](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/add-and-handle-custom-information-in-the-order%23remove-single-custom-field-value)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/add-and-handle-custom-information-in-the-order%23error-codes)\n\n[Set single custom field value and Set multiple custom field values endpoints](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/add-and-handle-custom-information-in-the-order%23set-single-custom-field-value-and-set-multiple-custom-field-values-endpoints)[Update orderForm configuration endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order/docs/guides/add-and-handle-custom-information-in-the-order%23update-orderform-configuration-endpoint)\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_2640fdb1
|
[
{
"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 safedata 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.safedata/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/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.safedata/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.safedata/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.safedata/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.safedata/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.safedata/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/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.safedata/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/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.safedata/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.safedata/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/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.safedata/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/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.safedata/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/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.safedata/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.safedata/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/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.safedata/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/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.safedata/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.safedata/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/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.safedata/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/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.safedata/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/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.safedata/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.safedata/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.safedata/docs/vtex-io-apps)\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/guides/advanced-components)\n\nSafedata\n\nOfficial extension\n\nVersion: 1.3.3\n\nLatest version: 1.3.3\n\nThe Safedata app provides a configurable middleware to retrieve and save [**Master Data**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction) v1 and v2 information securely. It enables frontend calls and backend applications to access data using [shopper token authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens) rather than [application keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-application-keys).\n\nSafedata acts as a validation layer on top of the **Master Data** API, ensuring data is being queried only by the user who owns it. The app verifies if the data can be returned or edited based on who is trying to access it, allowing access only to information pertinent to the authenticated user.\n\nRelevant use cases include forms such as warranty submission, newsletter subscription, buyer's club registration, or reseller registration.\n\n## Installation\n\nYou can install Safedata through the [VTEX App Store](https://read.calvincode.net/reader?url=https://apps.vtex.com/vtex-safedata/p) or by running the following command on [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\n`1\n\nvtex install vtex.safedata \n\n`\n\nUpon installation, [Safedata routes](#master-data-rest-api) become instantly available to use with default entities CL (Client) and AD (Address).\n\nOther entities can be set up through [app settings](#setting-up-entities).\n\n## App behavior\n\nSafedata operates based on the `CL` entity, which serves as a reference to identify users. It begins by validating the `StoreUserAuthToken` via **VTEX ID** and retrieving the user's email. Subsequently, Safedata retrieves the necessary fields from the `CL` entity to ensure that users access or modify documents pertinent to them.\n\nThis validation is done through a field comparison between `CL` and the entity that is being queried. For instance, when searching for documents of the `AD` entity, Safedata verifies if the `userId` matches the `id` found in the `CL` entity before allowing the action.\n\n> The comparison fields must be searchable on the **Master Data** fields configuration. However, they do not have to be public. We do not recommend making any fields public.\n\n## Setting up entities\n\nThe basic configurations for CL and AD entities are set by default but can be changed through the app's settings interface.\n\n\n\nTo enable other **Master Data** entities to work with Safedata, take the following steps:\n\n1. On VTEX Admin, go to **Apps > Extensions Hub > App Management**.\n2. Search for **Safedata**.\n3. Click `Settings`.\n4. Click `+ Add more`.\n5. Fill in the required information: \n * **Entity acronym on Master Data** \n * **Field to match on current entity** \n * **Field to match on CL entity** \n * **Allow creating objects anonymously?**\n6. Click `Save`.\n\nYou can delete entity configurations by clicking the trash icon next to their respective rows.\n\n## Querying Master Data information\n\nDepending on your application's requirements and architecture, you can choose between two approaches for accessing Master Data information:\n\n* **Backend applications**: refer to [Master Data REST API](#master-data-rest-api)\n* **Frontend applications**: refer to [GraphQL interface](#graphql-interface)\n\n### Master Data REST API\n\nTo query **Master Data** information using Safedata, replace `api/dataentities` with `api/io/safedata` in [**Master Data** API v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api) and [**Master Data** API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23overview) routes. For example, to retrieve `AD` entity documents by a specific `addressName`, the request would be: `GET https://apiexamples.myvtex.com/api/io/safedata/AD/search?_where=addressName=12345`\n\nThe following routes are supported by Safedata:\n\n| Action | Original route | Safedata route |\n| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------- | --------------------------------------------------------------- |\n| [Get document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23get-/api/dataentities/-acronym-/documents/-id-) | GET /api/dataentities/{dataEntityName}/documents/{documentId} | GET /api/io/safedata/{dataEntityName}/documents/{documentId} |\n| [Search documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23get-/api/dataentities/-acronym-/search) | GET /api/dataentities/{dataEntityName}/search | GET /api/io/safedata/{dataEntityName}/search |\n| [Create document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23post-/api/dataentities/-acronym-/documents) | POST /api/dataentities/{dataEntityName}/documents | POST /api/io/safedata/{dataEntityName}/documents |\n| [Create document with custom ID or update entire document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23put-/api/dataentities/-acronym-/documents/-id-) | PUT /api/dataentities/{dataEntityName}/documents/{documentId} | PUT /api/io/safedata/{dataEntityName}/documents/{documentId} |\n| [Delete document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23delete-/api/dataentities/-acronym-/documents/-id-) | DELETE /api/dataentities/{dataEntityName}/documents/{documentId} | DELETE /api/io/safedata/{dataEntityName}/documents/{documentId} |\n| [Update partial document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23patch-/api/dataentities/-acronym-/documents/-id-) | PATCH /api/dataentities/{dataEntityName}/documents/{documentId} | PATCH /api/io/safedata/{dataEntityName}/documents/{documentId} |\n\nAll underscore query parameters are supported (`_where`, `_fields`, `_schema`, and so on).\n\n#### Expected responses\n\nIf the user is logged out and tries to fetch information that does not belong to them, the middleware returns a status `403`. It is possible to verify these requests through DevTools. Other statuses that the middleware returns include:\n\n| Response | Meaning |\n| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| 401 Unauthorized | No token informed (not logged in) or invalid token. |\n| 403 Forbidden | Operation not allowed. The user is trying to retrieve or edit data that is not their own. |\n| 404 Not Found | Occurs when the user is not found or when a document search does not return data with the specified filter (Safedata always filters the search to return only documents belonging to the shoppers who are logged in). |\n| 200 OK | Successful request. |\n\n### GraphQL interface\n\nSafedata also provides a `patchDocument` mutation in GraphQL, which enables React components to create or update documents in **Master Data**.\n\nYou can test it yourself using the [GraphQL IDE](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide).\n\n\n\n#### Mutation example\n\nThis example demonstrates how to use the `patchDocument` mutation to create a document with a new email value:\n\n`1\n\nmutation patchDocument($document: DocumentInput) { \n\n2\n\n patchDocument(entity: \"CL\", document:$document){ \n\n3\n\n id \n\n4\n\n href \n\n5\n\n documentId \n\n6\n\n result \n\n7\n\n } \n\n8\n\n} \n\n`\n\n#### Input fields\n\n* `entity` (String!): The entity type of the document to update.\n* `document` (DocumentInput!): The document fields to update.\n\n#### `DocumentInput` fields\n\n* `fields` (`[DocumentFieldInput!]!`): An array of fields to update in the document, with a key/value pair representing each field.\n\n#### `DocumentFieldInput` fields\n\n* `key` (String!): The key of the field to update.\n* `value` (String!): The new value of the field to update.\n\n#### Query example\n\n`1\n\n{ \n\n2\n\n \"document\": { \n\n3\n\n \"document\": { \n\n4\n\n \"fields\": [ \n\n5\n\n { \n\n6\n\n \"key\": \"email\", \n\n7\n\n \"value\": \"test@mail.com\" \n\n8\n\n } \n\n9\n\n ] \n\n10\n\n } \n\n11\n\n } \n\n12\n\n} \n\n`\n\n#### Example response\n\n`1\n\n{ \n\n2\n\n \"data\": { \n\n3\n\n \"patchDocument\": { \n\n4\n\n \"id\": \"CL-25bbdecd-eb92-11ee-8452-122c0cad37a5\", \n\n5\n\n \"href\": \"http://api.vtex.com/api/dataentities/CL/documents/25bbdecd-eb92-11ee-8452-122c0cad37a5?an=apiexamples\", \n\n6\n\n \"documentId\": \"25bbdecd-eb92-11ee-8452-122c0cad37a5\", \n\n7\n\n \"result\": \"ok\" \n\n8\n\n } \n\n9\n\n } \n\n10\n\n} \n\n`\n\n## \\[Advanced\\] Handling custom checkout fields\n\nIn cases where custom fields are integrated into the checkout process, Safedata ensures data management during a user's first purchase. By appending the `_orderFormId` parameter to requests, Safedata allows users to securely update their information during their first checkout without requiring login credentials.\n\n> Only the `PATCH /api/io/safedata/{dataEntityName}/documents/{documentId}` route supports the `_orderFormId` parameter, and it only works with entities that contain an `email` field in their schema.\n\n### Example\n\nDuring a user's first purchase, the creation of the `CL` entity may be preemptive if the store incorporates specific customizations, such as capturing additional fields like birth date. Nonetheless, Safedata typically limits users from modifying personal data when not logged in, presenting potential challenges. To address this, you can add the `_orderFormId` query parameter so the customer can securely update their information during their first checkout. Refer to the following example:\n\n`PATCH /safedata/CL/documents?_orderFormId=7217c9c7413142dd93e3b715f95cd03d`\n\n`1\n\n{ \n\n2\n\n \"email\": \"my_email@domain.com\", \n\n3\n\n \"birthDate\": \"1990-10-11T00:00:00\" \n\n4\n\n} \n\n`\n\nWhen this request is called for the first time, the user does not exist, so it is allowed to be created anonymously.\n\nIn subsequent calls, Safedata checks the `_orderFormId` to ensure the user was created in this checkout session so they can update their information without asking for credentials.\n\nThis allows users to update their personal information during the checkout process without logging in only during the first purchase.\n\nOnce the first purchase is finished, a complete profile is generated, and in order to update this information again, the user has to log in.\n\n[Reviews and Ratings« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.reviews-and-ratings)[Seller SelectorNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.seller-selector)\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[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.safedata%23installation)\n\n[App behavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.safedata%23app-behavior)\n\n[Setting up entities](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.safedata%23setting-up-entities)\n\n[Querying Master Data information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.safedata%23querying-master-data-information)\n\n[Master Data REST API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.safedata%23master-data-rest-api)[GraphQL interface](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.safedata%23graphql-interface)\n\n[\\[Advanced\\] Handling custom checkout fields](https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.safedata#advanced-handling-custom-checkout-fields)\n\n[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata/docs/apps/vtex.safedata%23example)\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_856fd0ec
|
[
{
"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 search banner 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-search-banner/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/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-search-banner/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-search-banner/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-search-banner/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-search-banner/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-search-banner/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/guides/basic-components)\n\nBanner\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\nBanner is the Intelligent Search feature that displays banners on the customer search results page, depending on the search context.\n\n## Before you begin\n\nMake sure you have added the `search` app to your theme dependencies within 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## Configuration\n\nThe banner entity is composed of the following fields:\n\n| Field | Description |\n| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |\n| Active | Indicates if the banner is active or not. |\n| Banner name | Unique identifier for the banner. |\n| Type banner | Specifies the type of banner, which can be either HTML or IMAGE. |\n| HTML / Image URL | HTML code or image to be inserted. |\n| Area | Indicates the section of the page where the banner will be displayed. It's important when multiple banners are present on the same page. |\n| Terms | List of terms for this banner. |\n| Period | The period that this banner will be active. |\n| Attributes | List of selected attributes for this banner. |\n\n## Usage\n\nAdd the `search-banner` block to `search-result-layout.desktop` or `search-result-layout.mobile`. For example:\n\n`1\n\n{ \n\n2\n\n \"search-result-layout.desktop\": { \n\n3\n\n \"children\": [ \n\n4\n\n \"flex-layout.row#banner-one\" \n\n5\n\n ] \n\n6\n\n }, \n\n7\n\n \"search-banner#one\": { \n\n8\n\n \"props\": { \n\n9\n\n \"area\": \"one\", \n\n10\n\n \"blockClass\": \"myBanner\", \n\n11\n\n \"horizontalAlignment\": \"center\" \n\n12\n\n } \n\n13\n\n }, \n\n14\n\n \"flex-layout.row#banner-one\": { \n\n15\n\n \"children\": [ \n\n16\n\n \"search-banner#one\" \n\n17\n\n ] \n\n18\n\n } \n\n19\n\n} \n\n`\n\n## Props\n\n| Prop name | Type | Description | Default value |\n| ------------------- | ------ | -------------------------------------------------------------------- | ------------- |\n| area | String | Indicates the area. It must match the area configured in the banner. | \\- |\n| blockClass | String | Defines a custom class to the banner div. | \\- |\n| horizontalAlignment | String | Defines the horizontal alignment for the banner. | \"center\" |\n\nThe possible values for `horizontalAlignment` are:\n\n| Values |\n| -------- |\n| \"left\" |\n| \"right\" |\n| \"center\" |\n\n## Customization\n\nTo apply CSS customizations to this and other blocks, follow the instructions in the guide [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| searchBanner |\n\n[Autocomplete« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.search/Autocomplete)[BreadcrumbNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.breadcrumb)\n\nSee also\n\n[Vtex.searchVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/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/guides/vtex-search-banner/docs/apps/vtex.search/banner%23before-you-begin)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.search/banner%23configuration)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.search/banner%23usage)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.search/banner%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner/docs/apps/vtex.search/banner%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_0afb3b0b
|
[
{
"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 reference list of native sections 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/reference-list-of-native-sections/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-list-of-native-sections/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/reference-list-of-native-sections/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/reference-list-of-native-sections/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/reference-list-of-native-sections/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/reference-list-of-native-sections/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/reference-list-of-native-sections/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/reference-list-of-native-sections/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/reference-list-of-native-sections/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-list-of-native-sections/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/reference-list-of-native-sections/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-list-of-native-sections/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-list-of-native-sections/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-list-of-native-sections/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-list-of-native-sections/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-list-of-native-sections/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-list-of-native-sections/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-list-of-native-sections/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/reference-list-of-native-sections/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/reference-list-of-native-sections/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-list-of-native-sections/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/reference-list-of-native-sections/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-list-of-native-sections/docs/storefront-development)\n\nList of available native sections and overridable components\n\nSections in FastStore are components that organize and encapsulate other components, enabling you to create cohesive and functional content for your store.\n\nFor example, the Hero is a native section designed to capture your brand's identity and messaging. To effective function in the store, the Hero comprises three components: `Hero`, `HeroImage`, and `HeroHeader`.\n\n---\n\n## FastStore native sections\n\nCheck out below a list of FastStore native sections, their components that can be overridden, and if there are props that can be changed through the Headless CMS.\n\n> Components prefixed with `__experimental` indicate that they can be overridden. However, it's important to note that their props are not accessible. We advise against overriding these components unless it is really necessary.\n\n**Alert**\n\n| Type | Availability |\n| --------------------------------- | --------------------------------------------------------------------------------------- |\n| Documentation | [Alert FastStore UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert) |\n| Overridable components | Alert and Icon |\n| Headless CMS: props customization | Icon dismissible |\n\n**BannerText**\n\n| Type | Availability |\n| --------------------------------- | --------------------------------------------------------------------------------------------------- |\n| Documentation | [Banner Text FastStore UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-banner-text) |\n| Overridable components | BannerText BannerTextContent |\n| Headless CMS: props customization | ColorVariant Variant |\n\n**Breadcrumb**\n\n| Type | Availability |\n| --------------------------------- | ------------------------------------------------------------------------------------------------- |\n| Documentation | [Breadcrumb FastStore UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-breadcrumb) |\n| Overridable components | BreadcrumbIcon |\n| Headless CMS: props customization | Icon (HomeIcon) |\n\n**Empty State**\n\n| Type | Availability |\n| --------------------------------- | --------------------------------------------------------------------------------------------------- |\n| Documentation | [Empty State FastStore UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state) |\n| Overridable components | EmptyState |\n| Headless CMS: props customization | Coming soon! |\n\n**Hero**\n\n| Type | Availability |\n| --------------------------------- | ------------------------------------------------------------------------------------- |\n| Documentation | [Hero FastStore UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero) |\n| Overridable Components | Hero HeroImage HeroHeader |\n| Headless CMS: props customization | ButtonProps (Label, Icon) ColorVariant Variant |\n\n**Navbar**\n\n| Type | Availability |\n| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Documentation | [Navbar FastStore UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar) |\n| Overridable components | Navbar NavbarLinks NavbarLinksList NavbarSlider NavbarSliderHeader NavbarSliderContent NavbarSliderFooter NavbarHeader NavbarRow NavbarButtons IconButton |\n| Headless CMS: props customization | NavbarRow: LogoNavbarButtons: SignIn Button Icon, Cart IconNavigation: Regionalization Icon, Menu Icon, Home Icon |\n\n**Newsletter**\n\n| Type | Availability |\n| --------------------------------- | -------------------------------------------------------------------------------- |\n| Documentation | Coming soon! |\n| Overridable components | ToastIconSuccess ToastIconError HeaderIcon InputFieldName InputFieldEmail Button |\n| Headless CMS: props customization | Icon Variant (Lite / Full) |\n\n**ProductDetails**\n\n| Type | Availability |\n| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| Documentation | [FastStore UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-list-of-native-sections/docs/guides/faststore-index) |\n| Overridable components | ProductTitle DiscountBadge BuyButton Icon Price QuantitySelector SkuSelector ShippingSimulation ImageGallery ImageZoom \\_\\_experimentalImageGalleryImage \\_\\_experimentalImageGallery \\_\\_experimentalShippingSimulation |\n| Headless CMS: props customization | ProductTitle: showDiscountBadge, discountBadgeSize, showReferenceNumberBuyButton: Icon |\n\n**ProductShelf**\n\n| Type | Availability |\n| --------------------------------- | ------------------------------------------------------------------------------------------------------- |\n| Documentation | [Product Shelf FastStore UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf) |\n| Overridable components | ProductShelf \\_\\_experimentalCarousel \\_\\_experimentalProductCard |\n| Headless CMS: props customization | Product Card Configuration: showDiscountBadge, bordered |\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/reference/list-of-native-sections.mdx)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[FastStore native sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-list-of-native-sections/docs/guides/faststore/reference-list-of-native-sections%23faststore-native-sections)\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/reference/list-of-native-sections.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[FastStore native sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-list-of-native-sections/docs/guides/faststore/reference-list-of-native-sections%23faststore-native-sections)\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_894bc639
|
[
{
"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 secure proxy 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-secure-proxy/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-secure-proxy/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-secure-proxy/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-secure-proxy/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-secure-proxy/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-secure-proxy/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-secure-proxy/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/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-secure-proxy/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/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-secure-proxy/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/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-secure-proxy/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-secure-proxy/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-secure-proxy/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-secure-proxy/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-secure-proxy/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-secure-proxy/docs/guides/payments-integration-purchase-flows)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/payments-integration-payment-app)\n\n[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/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-secure-proxy/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-secure-proxy/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-secure-proxy/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-secure-proxy/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-secure-proxy/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-secure-proxy/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-secure-proxy/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-secure-proxy/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-secure-proxy/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-secure-proxy/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-secure-proxy/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/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-secure-proxy/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-secure-proxy/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/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-secure-proxy/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-secure-proxy/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/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-secure-proxy/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/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-secure-proxy/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/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-secure-proxy/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-secure-proxy/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-secure-proxy/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-secure-proxy/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-secure-proxy/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-secure-proxy/docs/guides/payments-integration-purchase-flows)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/payments-integration-payment-app)\n\n[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/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-secure-proxy/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-secure-proxy/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-secure-proxy/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-secure-proxy/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-secure-proxy/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-secure-proxy/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-secure-proxy/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-secure-proxy/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-secure-proxy/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-secure-proxy/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-secure-proxy/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/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-secure-proxy/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-secure-proxy/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/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-secure-proxy/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-secure-proxy/docs/guides)\n\nIntegration Guides\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/payments-integration-guide)\n\n[Secure Proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/payments-integration-secure-proxy)\n\nSecure Proxy\n\nSecure Proxy is a solution that allows payment integrations to transfer sensitive data (i.e.: credit card numbers) in a secure environment. An integration must use Secure Proxy if it meets the following conditions:\n\n* It uses credit, debit, or cobranded cards as payment methods\n* The environment where the connector is hosted does not have an [Attestation of Compliance (AOC) of PCI - DSS (Payment Card Industry - Data Security Standard)](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/payments-integration-pci-dss-compliance)\n\nWhen an integration is PCI compliant, it does not need to use Secure Proxy, being allowed to receive sensitive data and communicate directly with the acquirer. When using Secure Proxy, the following changes occur in the flow of the integration:\n\n1. The Authorization request works as usual.\n2. The provider receives tokens from VTEX’s Payments Gateway that refers to the sensitive data, instead of the actual data.\n3. The provider sends the API endpoint of the acquirer and the merchant credentials to the Gateway.\n4. The Gateway makes the API call to the acquirer, acting as a proxy between the provider and the acquirer. In this call, the tokens are replaced by sensitive data. \n\n\n## What is PCI DSS and how is it used in VTEX?\n\nPCI DSS is an international standard for how companies must process card information. Among the many rules of this standard is an important one that states that card information must be transferred in a secure infrastructure that has been audited by a [QSA (Qualified Security Assessors) Company](https://read.calvincode.net/reader?url=https://www.pcisecuritystandards.org/assessors%5Fand%5Fsolutions/qualified%5Fsecurity%5Fassessors), which are qualified by the PCI Security Standards Council.\n\nVTEX’s Payments Gateway service is certified by this entity to process sensitive card information, and this information can only be transferred in a secure environment in which services and partners have an AOC signed by a QSA Company. Security measures needed to meet the PCI DSS requirements include, but are not limited to the use of a firewall, encrypt the transmission of cardholder data, use of updated anti-virus, restrict access to cardholder data with authentication and monitor all access to network resources. More information about PCI DSS requirements can be found in the [PCI DSS Quick Reference Guide](https://read.calvincode.net/reader?url=https://www.pcisecuritystandards.org/documents/PCI%5FDSS-QRG-v3%5F2%5F1.pdf).\n\n## Why use Secure Proxy?\n\nNot all of VTEX’s payment ecosystem (partners and clients) have PCI DSS certification, which is required for our Payments Gateway to send card information. Besides, the VTEX IO platform is a development environment designed to accelerate the creation of new solutions for our ecosystem and we want to enable it to create payment solutions as well.\n\nConsidering that the integration environment is fundamental for a transaction to take place based on business rules about how a payment should be processed, a solution is necessary to address the scenarios in which the integration environment is not certified by PCI requirements. Therefore, Secure Proxy comes as a solution to enable new integration scenarios with VTEX’s payment partner ecosystem.\n\nThrough this solution, the Payments Gateway acts as a communication service between a payment provider in a non-PCI environment and an acquirer. The Payments Gateway sends tokenized card information to the payment provider without the risk of compromising data security. The tokens are used to replace sensitive information in the provider and to act as a reference to the information in the Gateway.\n\nWhen a system does not meet all the security requirements, it might be vulnerable to attacks and data theft. This can lead to serious consequences including fraud losses, loss of confidence from customers, reduction in sales, legal costs, fines, etc. More information about these security issues can be found in the PCI article [Why Security Matters](https://read.calvincode.net/reader?url=https://www.pcisecuritystandards.org/pci%5Fsecurity/why%5Fsecurity%5Fmatters). By meeting the requirements of PCI DSS, those issues and their consequences can be avoided.\n\n> Secure Proxy is mandatory for connectors built with the VTEX IO infrastructure since it is not compliant with PCI DSS. This also includes connectors made through our [Payment Provider Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/payments-integration-payment-provider-framework).\n\n## How it works\n\nIn this section, we detail how the solution works in a payment authorization flow. The image below shows an overview of the flow containing the Secure Proxy, as well as the four steps required for the payment to be authorized by the acquirer.\n\n\n\n### 1\\. Checkout submits a payment authorization request to the Gateway\n\nThere is no change to the current flow. The Checkout makes an [Authorization request](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/4doauthorization) to the Gateway.\n\n### 2\\. Gateway requests the provider to create a new payment using tokens\n\nThe Gateway makes a [Create Payment request](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/createpayment) to the provider. The provider is responsible for receiving all the payment requests from the Gateway (creation, authorization, capture and cancel), regardless of using the Secure Proxy or not, and will use the defined settings in the integration including maximum time to cancel a transaction, supported payment methods, etc.\n\nBelow is an example of a payment creation request using a non-PCI payment provider. In this solution, there is a `secureProxyUrl` field containing the API that the payment provider must call when communicating with the acquirer. In addition, all sensitive card information has been tokenized by the Gateway.\n\n**Request body**\n\n`1\n\n{ \n\n2\n\n ..., \n\n3\n\n \"secureProxyUrl\": \"https://account.vtexpayments.com.br/.../proxy\", \n\n4\n\n \"card\": { \n\n5\n\n \"holderToken\": \"#vtex#token#d799bae#holder#\", \n\n6\n\n \"bin\": \"555544\", \n\n7\n\n \"numberToken\": \"#vtex#token#d799bae#number#\", \n\n8\n\n \"numberLength\": 16, \n\n9\n\n \"cscToken\": \"#vtex#token#d799bae#csc#\", \n\n10\n\n \"cscLength\": 3, \n\n11\n\n \"expiration\": { \n\n12\n\n \"month\": \"02\", \n\n13\n\n \"year\": \"2028\" \n\n14\n\n } \n\n15\n\n } \n\n16\n\n} \n\n`\n\nThe response body for this request can be seen in our [API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/createpayment%23response-body).\n\n### 3\\. Provider calls the Gateway to use the Secure Proxy\n\nThe provider makes a POST `https://account.vtexpayments.com.br/.../proxy` call to the Gateway. This is the endpoint provided in the `secureProxyUrl` field. This step occurs as follows:\n\n1. The payment provider creates the object that will be sent to the acquirer using the tokenized data submitted by the Gateway in the corresponding fields. For this request to be transferred to the acquirer, you must submit the URL you would like to use in the `X-PROVIDER-Forward-To` header. Once this is done, the Gateway will: \n 1. Verify if the URL is in the list of PCI-certified URLs. \n 2. Replace the tokens placed in the card fields. \n 3. Submit the request to the acquirer.\n2. In case custom headers must be submitted to the acquirer, add `X-PROVIDER-Forward-` as a prefix, for instance `X-PROVIDER-Forward-MerchantId`. The Gateway will remove the prefix and submit the headers.\n3. The response body will be forwarded from the external gateway or acquirer to the payment provider.\n\n#### Possible response errors\n\nThe possible known errors are:\n\n* **Error 400:** the submission URL is not specified in the header.\n* **Error 400:** the integration transfers data not recognized by the Payments Gateway in the tokenized fields (`holderToken`, `numberToken`, `cscToken`).\n* **Error 403:** the submission URL of the request is not allowed.\n* **Error 500:** the Gateway cannot respond due to an internal failure.\n\nThe external gateway or acquirer also can respond with their own 4XX or 5XX errors.\n\n> You must open a ticket asking to add the acquirer’s endpoint (the one used in the `X-PROVIDER-Forward-To` header) in the VTEX’s allowed list of endpoints along with the [AOC](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/payments-integration-pci-dss-compliance%23attestation-of-compliance-for-onsite-assessments-aoc) of the acquirer. If a request is made to the acquirer’s endpoint and it is not on the allowed list, it will result in an error.\n\n**Request header**\n\n`1\n\nAccept: application/json \n\n2\n\nContent-Type: application/json \n\n3\n\nUser-Agent: HttpClient-1.0 \n\n4\n\nX-PROVIDER-Forward-To: https://apisandbox.acquirer.com/v2/sales/ \n\n5\n\nX-PROVIDER-Forward-MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \n\n6\n\nX-PROVIDER-Forward-MerchantKey: 012345678901234567890123456789012345678 \n\n`\n\n> Requests to the PCI Proxy only accept two options for Content-Types: `application/json` or `application/x-www-form-urlencoded`. Other Content-Type options are not supported, but if you need any other for an integration you can share your use case with the product team by [opening a ticket to the VTEX support team](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/opening-tickets-to-vtex-support--16yOEqpO32UQYygSmMSSAM).\n\n**Request body**\n\n`1\n\n{ \n\n2\n\n \"MerchantOrderId\": \"123456789\", \n\n3\n\n \"Customer\": { ... }, \n\n4\n\n \"Payment\": { \n\n5\n\n ..., \n\n6\n\n \"CreditCard\": { \n\n7\n\n \"Holder\": \"#vtex#token#d799bae#holder#\", \n\n8\n\n \"CardNumber\": \"#vtex#token#d799bae#number#\", \n\n9\n\n \"ExpirationDate\": \"02/2028\", \n\n10\n\n \"SecurityCode\": \"#vtex#token#d799bae#csc#\", \n\n11\n\n ... \n\n12\n\n }, \n\n13\n\n \"Credentials\": { ... } \n\n14\n\n} \n\n`\n\n> Secure Proxy only supports HTTP-API (REST) integrations, which means it does not support Webservice (SOAP) or any other type of communication protocol.\n\n### 4\\. Requests for external gateways or acquirers in a PCI environment\n\nAn example request that the Gateway will submit to the acquirer: POST `https://apisandbox.acquirer.com/v2/sales/`.\n\n**Request header**\n\n`1\n\nAccept: application/json \n\n2\n\nContent-Type: application/json \n\n3\n\nUser-Agent: HttpClient-1.0 \n\n4\n\nMerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \n\n5\n\nMerchantKey: 012345678901234567890123456789012345678 \n\n`\n\nDefault headers:\n\n* Accept\n* Content-Type\n* User-Agent\n\nCustom headers:\n\n* MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\n* MerchantKey: 012345678901234567890123456789012345678\n\n**Request body**\n\n`1\n\n{ \n\n2\n\n \"MerchantOrderId\": \"123456789\", \n\n3\n\n \"Customer\": { ... }, \n\n4\n\n \"Payment\": { \n\n5\n\n ..., \n\n6\n\n \"CreditCard\": { \n\n7\n\n \"Holder\": \"JOHN DOE\", \n\n8\n\n \"CardNumber\": \"5555444433331111\", \n\n9\n\n \"ExpirationDate\": \"02/2028\", \n\n10\n\n \"SecurityCode\": \"123\", \n\n11\n\n ... \n\n12\n\n }, \n\n13\n\n \"Credentials\": { ... } \n\n14\n\n} \n\n`\n\n> This request has a timeout of 15 seconds. It means that the Gateway will wait 15 seconds for the response of the acquirer and respond back to the payment provider.\n\n## Custom Tokens\n\nAs illustrated in the example above, card fields are the most often used tokens. However, the Secure Proxy also supports the creation and usage of custom tokens. This is done via the `secureProxyTokensURL` field, which is included by the Gateway in the request body of [Create Payment request](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/createpayment) to the payment provider. The field contains the path to the endpoint that allows dealing with custom tokens.\n\nIn the following examples, the `secureProxyTokensURL` field will have the value `https://{{account}}.vtexpayments.com.br/payment-provider/transactions/{{transactionId}}/payments/{{paymentId}}/tokens?hash={{longSecureHash}}`.\n\n### Access Tokens\n\nThe list of all tokens created for a payment can be fetched via a GET request to the `secureProxyTokensURL`. By default, the list will only include the immutable credit card information tokens (`number`, `holder` and `csc`) created by the Gateway.\n\n**Response body**\n\n`1\n\n{ \n\n2\n\n \"tokens\": [ \n\n3\n\n { \n\n4\n\n \"name\": \"number\", \n\n5\n\n \"placeholder\": \"#vtex#number#{secureHash}#\" \n\n6\n\n }, \n\n7\n\n { \n\n8\n\n \"name\": \"holder\", \n\n9\n\n \"placeholder\": \"#vtex#holder#{secureHash}#\" \n\n10\n\n }, \n\n11\n\n { \n\n12\n\n \"name\": \"csc\", \n\n13\n\n \"placeholder\": \"#vtex#csc#{secureHash}#\" \n\n14\n\n } \n\n15\n\n ] \n\n16\n\n} \n\n`\n\nThe `secureHash` is a short string used for authentication during the access to a specific payment within the Secure Proxy, such as `d799bae`, as previously illustrated in [this example](#2-gateway-requests-the-provider-to-create-a-new-payment-using-tokens).\n\n### Create custom tokens\n\nNew tokens can be created via a POST request to the `secureProxyTokensURL`. After being created, these can be referenced inside requests to the Secure Proxy and will be replaced by their values before the requests are forwarded to the acquirer.\n\n> Custom tokens allow, for example, the creation of tokens whose values are derived from credit card information.\n\nThe creation request should include a list of tokens to be created, where each one consists of a `name` and a `value`. The first will be included in the placeholder used to reference the token (as mentioned above) and the second will be a [JsonLogic](https://read.calvincode.net/reader?url=https://jsonlogic.com/) expression that describes its value. In the `value` field for each token in the request body, every string must be encoded in the UTF-8 format.\n\n**Request body**\n\n`1\n\n{ \n\n2\n\n \"tokens\": [ \n\n3\n\n { \n\n4\n\n \"name\": \"newToken\", \n\n5\n\n \"value\": { \"==\": [1, 1] } \n\n6\n\n }, \n\n7\n\n { \n\n8\n\n \"name\": \"hashedCardNumber\", \n\n9\n\n \"value\": { \n\n10\n\n \"md5\": { \n\n11\n\n \"replaceTokens\": [\"#vtex#number#{secureHash}#\"] \n\n12\n\n } \n\n13\n\n } \n\n14\n\n } \n\n15\n\n ] \n\n16\n\n} \n\n`\n\nIn the example request above, two new tokens are created.\n\n* The first token is created from a simple expression and its value is evaluated to be true.\n* The second token has an expression that uses [custom Secure Proxy operators](#custom-supported-operators) to compute the MD5 hash of the card number. This is done by detokenizing the card number token with the `replaceTokens` operator and then applying the MD5 operator to the result.\n\n**Response body**\n\n`1\n\n{ \n\n2\n\n \"tokens\": [ \n\n3\n\n { \n\n4\n\n \"name\": \"newToken\", \n\n5\n\n \"placeholder\": \"#vtex#newToken#{secureHash}#\" \n\n6\n\n }, \n\n7\n\n { \n\n8\n\n \"name\": \"hashedCardNumber\", \n\n9\n\n \"placeholder\": \"#vtex#hashedCardNumber#{secureHash}#\" \n\n10\n\n } \n\n11\n\n ] \n\n12\n\n} \n\n`\n\nThe response consists of a list of the tokens that were created. The `placeholder` can then be used inside requests to the Secure Proxy to reference the values specified by the expression of the token.\n\n> A `placeholder` can be referenced in the body or as a header in a request to the Secure Proxy.\n\n#### Custom supported operators\n\nAside from the [default JsonLogic operators](https://read.calvincode.net/reader?url=https://jsonlogic.com/operations.html), the Secure Proxy also provides support to the following operators:\n\n* `replaceTokens`: given a string, replaces the tokens in it by their respective values.\n* `base64`: given a string, encode in Base64.\n* `hmac-sha256`: given two UTF-8 encoded string arguments, computes the [HMAC-SHA256](https://read.calvincode.net/reader?url=https://datatracker.ietf.org/doc/html/rfc4868) hash considering the first string argument as the _key_ and the second as the _data_ to be hashed. The default result is [Base64-encoded](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Glossary/Base64) by default. \n * Optionally, a third parameter may be specified to choose the desired format of the output. The available options are `\"base64\"` (default) and `\"hex\"`. \n * Also optionally, a fourth parameter can be specified to choose the format of the key. The available options are `“plainText”` (default), `\"hex”` and `\"base64”`.\n* Other hashing operators: `md5`, `sha1`, `sha256`, `sha384`, `sha512`. \n * Given a string, it computes the hash and returns the hex digest. \n * For these hashing operators, the result is the hex digest. \n * These hashing operators also have a second optional parameter to enable the user to choose the desired output to be a Hex digest output or a Base64 output. The parameter is case-insensitive and, if it is used, then it must be the string `\"hex\"` or the string `\"base64\"`. If the optional parameter is not used, the default output is the hex digest.\n\nExample of the creation of a token named `\"example-signature\"` with a `hmac-sha256` hash as its value:\n\n`1\n\n{ \n\n2\n\n \"tokens\":[ \n\n3\n\n { \n\n4\n\n \"name\":\"example-signature\", \n\n5\n\n \"value\":{ \n\n6\n\n \"hmac-sha256\":[ \n\n7\n\n \"this-is-the-key-value\", \n\n8\n\n \"this-is-the-data-value\", \n\n9\n\n \"this-is-the-optional-parameter-output-format\", \n\n10\n\n \"this-is-the-optional-parameter-key-format\" \n\n11\n\n ] \n\n12\n\n } \n\n13\n\n } \n\n14\n\n ] \n\n15\n\n} \n\n`\n\nExample of the creation of a token named `\"example-signature-2\"` with a MD5 hash as its value:\n\n`1\n\n{ \n\n2\n\n \"tokens\":[ \n\n3\n\n { \n\n4\n\n \"name\":\"example-signature-2\", \n\n5\n\n \"value\":{ \n\n6\n\n \"md5\":[ \n\n7\n\n \"this-is-the-data-value\", \n\n8\n\n \"this-is-the-optional-parameter-base64-or-hex-output\" \n\n9\n\n ] \n\n10\n\n } \n\n11\n\n } \n\n12\n\n ] \n\n13\n\n} \n\n`\n\nExample of the creation of a token named `\"example-base64\"` with a Base64 hash as its value:\n\n`1\n\n{ \n\n2\n\n \"tokens\":[ \n\n3\n\n { \n\n4\n\n \"name\":\"example-base64\", \n\n5\n\n \"value\":{ \n\n6\n\n \"base64\":[ \n\n7\n\n \"string-to-be-encoded\" \n\n8\n\n ] \n\n9\n\n } \n\n10\n\n } \n\n11\n\n ] \n\n12\n\n} \n\n`\n\n### Known issues\n\nThe operator `cat` from the [JSONLogic library](https://read.calvincode.net/reader?url=https://jsonlogic.com/operations.html) may misbehave when concatenating dates. It may change the date format.\n\nContributors\n\n3\n\n[](https://github.com/ricardoaerobr)\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/payments-integration-guide/payments-integration-secure-proxy.md)\n\n[PCI - DSS Compliance« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy//docs/guides/payments-integration-pci-dss-compliance)[Split Payouts on Payment Provider ProtocolNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy//docs/guides/split-payouts-on-payment-provider-protocol)\n\nContributors\n\n3\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[What is PCI DSS and how is it used in VTEX?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/payments-integration-secure-proxy%23what-is-pci-dss-and-how-is-it-used-in-vtex)\n\n[Why use Secure Proxy?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/payments-integration-secure-proxy%23why-use-secure-proxy)\n\n[How it works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/payments-integration-secure-proxy%23how-it-works)\n\n[1\\. Checkout submits a payment authorization request to the Gateway](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/payments-integration-secure-proxy%231-checkout-submits-a-payment-authorization-request-to-the-gateway)[2\\. Gateway requests the provider to create a new payment using tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/payments-integration-secure-proxy%232-gateway-requests-the-provider-to-create-a-new-payment-using-tokens)[3\\. Provider calls the Gateway to use the Secure Proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/payments-integration-secure-proxy%233-provider-calls-the-gateway-to-use-the-secure-proxy)[4\\. Requests for external gateways or acquirers in a PCI environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/payments-integration-secure-proxy%234-requests-for-external-gateways-or-acquirers-in-a-pci-environment)\n\n[Custom Tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/payments-integration-secure-proxy%23custom-tokens)\n\n[Access Tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/payments-integration-secure-proxy%23access-tokens)[Create custom tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/payments-integration-secure-proxy%23create-custom-tokens)[Known issues](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/payments-integration-secure-proxy%23known-issues)\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-secure-proxy.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[What is PCI DSS and how is it used in VTEX?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/payments-integration-secure-proxy%23what-is-pci-dss-and-how-is-it-used-in-vtex)\n\n[Why use Secure Proxy?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/payments-integration-secure-proxy%23why-use-secure-proxy)\n\n[How it works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/payments-integration-secure-proxy%23how-it-works)\n\n[1\\. Checkout submits a payment authorization request to the Gateway](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/payments-integration-secure-proxy%231-checkout-submits-a-payment-authorization-request-to-the-gateway)[2\\. Gateway requests the provider to create a new payment using tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/payments-integration-secure-proxy%232-gateway-requests-the-provider-to-create-a-new-payment-using-tokens)[3\\. Provider calls the Gateway to use the Secure Proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/payments-integration-secure-proxy%233-provider-calls-the-gateway-to-use-the-secure-proxy)[4\\. Requests for external gateways or acquirers in a PCI environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/payments-integration-secure-proxy%234-requests-for-external-gateways-or-acquirers-in-a-pci-environment)\n\n[Custom Tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/payments-integration-secure-proxy%23custom-tokens)\n\n[Access Tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/payments-integration-secure-proxy%23access-tokens)[Create custom tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/payments-integration-secure-proxy%23create-custom-tokens)[Known issues](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy/docs/guides/payments-integration-secure-proxy%23known-issues)\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_4cbf5d62
|
[
{
"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 troubleshooting my store catalog does not show the price range filter 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/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/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/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/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/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/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/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/updates/release-notes)\n\nTroubleshooting\n\nAPI\n\n---\n\nDevelopment\n\n[I am getting 500 errors in VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)\n\n[I am getting errors with my service configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)\n\n[Issues during extending the FastStore API schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)\n\n[I can’t access the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/unable-to-access-headless-cms)\n\n[I can’t install the Headless CMS plugins in my account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account)\n\n[I can't install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/i-cant-install-vtex-io-cli)\n\n[I can’t integrate my external Search Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/i-cant-integrate-my-external-search-provider)\n\n[My multi-language store is not functioning in the development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)\n\n[My store catalog does not display the price range filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter)\n\n[My pages are taking too long to be published on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)\n\n[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)\n\n[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)\n\n[The Price in the shelf or in the search results is different from the product page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)\n\n[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)\n\n[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)\n\n[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/i-cant-create-a-new-workspace)\n\n[I can't install an app with a major other than 0.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)\n\n[I don't see my Store Theme changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/i-dont-see-my-store-theme-changes)\n\n---\n\nStore performance\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/updates/release-notes)\n\nTroubleshooting\n\nAPI\n\n---\n\nDevelopment\n\n[I am getting 500 errors in VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)\n\n[I am getting errors with my service configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)\n\n[Issues during extending the FastStore API schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)\n\n[I can’t access the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/unable-to-access-headless-cms)\n\n[I can’t install the Headless CMS plugins in my account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account)\n\n[I can't install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/i-cant-install-vtex-io-cli)\n\n[I can’t integrate my external Search Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/i-cant-integrate-my-external-search-provider)\n\n[My multi-language store is not functioning in the development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)\n\n[My store catalog does not display the price range filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter)\n\n[My pages are taking too long to be published on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)\n\n[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)\n\n[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)\n\n[The Price in the shelf or in the search results is different from the product page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)\n\n[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)\n\n[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)\n\n[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/i-cant-create-a-new-workspace)\n\n[I can't install an app with a major other than 0.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)\n\n[I don't see my Store Theme changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/i-dont-see-my-store-theme-changes)\n\n---\n\nStore performance\n\n---\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting)\n\nDevelopment\n\nMy store catalog does not display the price range filter\n\nPrice filters are not available on the product listing page (PLP).\n\n**Keywords:** price range | filters | catalog\n\nThe price range feature allows you to [create a filter](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/setting-up-the-price-range-filter--tutorials%5F240) that displays price ranges to customers in your store.\n\nAfter creating [price range filters](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/setting-up-the-price-range-filter--tutorials%5F240) in your store catalog, there may be rendering issues, and they may not display on the product listing page (PLP).\n\n\n\nIn some situations, price filters may have rendering issues and not be displayed on the product listing page (PLP).\n\n## Solution\n\nTo solve this problem, consider checking the following:\n\n* [Price range filter configuration](#check-the-price-range-filter-configuration)\n* [simulationBehavior field value](#check-the-simulationbehavior-field-value)\n* [priceRange field value](#check-the-pricerange-field-value)\n\n### Check the price range filter configuration\n\nTo confirm that the price range filters are properly configured, follow the steps below:\n\n1. In the VTEX Admin, go to **Catalog > Categories.**\n2. Click the desired category.\n3. Click **ACTIONS** and **Price range**.\n4. Check the configured price ranges and make changes if necessary.\n\n\n\n### Check the `simulationBehavior` field value\n\nAccess your [Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result) app and, in the `store.search` parameter, check if the property `simulationBehavior` is set as `default`.\n\n`1\n\n{ \n\n2\n\n \"store.search\": { \n\n3\n\n \"blocks\": [ \n\n4\n\n \"search-result-layout\" \n\n5\n\n ], \n\n6\n\n \"props\": { \n\n7\n\n \"context\": { \n\n8\n\n \"skusFilter\": \"FIRST_AVAILABLE\", \n\n9\n\n \"simulationBehavior\": \"default\" \n\n10\n\n } \n\n11\n\n } \n\n12\n\n } \n\n13\n\n} \n\n`\n\n### Check the `priceRange` field value\n\n1. Access your [Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result) and, within the `search-result-layout.desktop` and `search-result-layout.mobile` blocks, check if the property `priceRange` exists and is set to `false`.\n2. Verify if the custom filter property follows the default value `false`. If it is set to `true`, its value should not appear.\n\n> If this field does not exist or the value is set to `true`, the price range filter will not be displayed in the store.\n\n`1\n\n… \n\n2\n\n\"search-result-layout.desktop\": { \n\n3\n\n \"children\": [ \n\n4\n\n \"flex-layout.row#searchbread\", \n\n5\n\n \"flex-layout.row#searchtitle\", \n\n6\n\n \"flex-layout.row#result\", \n\n7\n\n … \n\n8\n\n ], \n\n9\n\n \"props\": { \n\n10\n\n \"hiddenFacets\": { \n\n11\n\n \"priceRange\": false \n\n12\n\n }, \n\n13\n\n … \n\n14\n\n } \n\n15\n\n… \n\n`\n\n`1\n\n… \n\n2\n\n\"search-result-layout.mobile\": { \n\n3\n\n \"children\": [ \n\n4\n\n \"flex-layout.row#searchbread\", \n\n5\n\n \"flex-layout.row#searchtitle\", \n\n6\n\n \"flex-layout.row#result\", \n\n7\n\n … \n\n8\n\n ], \n\n9\n\n \"props\": { \n\n10\n\n \"hiddenFacets\": { \n\n11\n\n \"priceRange\": false \n\n12\n\n }, \n\n13\n\n … \n\n14\n\n } \n\n15\n\n… \n\n`\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\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/troubleshooting/development/my-store-catalog-does-not-show-the-price-range-filter.md)\n\n[My multi-language store is not functioning in the development workspace« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)[My pages are taking too long to be published on Headless CMSNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/ricardoaerobr)\n\nON THIS PAGE\n\n[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter%23solution)\n\n[Check the price range filter configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter%23check-the-price-range-filter-configuration)[Check the simulationBehavior field value](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter%23check-the-simulationbehavior-field-value)[Check the priceRange field value](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter%23check-the-pricerange-field-value)\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/troubleshooting/development/my-store-catalog-does-not-show-the-price-range-filter.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter%23solution)\n\n[Check the price range filter configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter%23check-the-price-range-filter-configuration)[Check the simulationBehavior field value](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter%23check-the-simulationbehavior-field-value)[Check the priceRange field value](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter%23check-the-pricerange-field-value)\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_0e5b0663
|
[
{
"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 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/specifications/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/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/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/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/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/specifications/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/specifications/docs/guides/catalog-integration)\n\n[Categories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/categories)\n\n[Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/brands)\n\n[Products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/products)\n\n[Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/specifications)\n\n[Product specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/product-specifications)\n\n[SKU specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/sku-specifications)\n\n[Updating SKU Specifications with Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/updating-sku-specifications-with-catalog-api)\n\n[SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/skus)\n\n[Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/images)\n\n[Alternative API requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/alternative-api-requests)\n\n[How to implement product color variation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/how-to-implement-product-color-variation)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/specifications/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/specifications/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/specifications/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/specifications/docs/guides/catalog-integration)\n\n[Categories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/categories)\n\n[Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/brands)\n\n[Products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/products)\n\n[Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/specifications)\n\n[Product specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/product-specifications)\n\n[SKU specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/sku-specifications)\n\n[Updating SKU Specifications with Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/updating-sku-specifications-with-catalog-api)\n\n[SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/skus)\n\n[Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/images)\n\n[Alternative API requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/alternative-api-requests)\n\n[How to implement product color variation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/how-to-implement-product-color-variation)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/specifications/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/specifications/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/specifications/docs/guides)\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/catalog-integration)\n\n[Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/specifications)\n\nSpecifications\n\nSpecifications are additional properties that can be added to your store's products or SKUs. A specification is used to create site browsing filters and to differentiate SKUs and products within the product page.\n\nThis guide will describe all the steps to create a specification for a product or an SKU:\n\n1. Create a specification group (mandatory)\n2. Create a specification (mandatory)\n3. Create a specification value\n4. Associate a specification to a product or to an SKU (mandatory)\n\n\n\n## Specification Groups\n\nTo create specifications, the first step is to create specification groups. They are specification aggregators, for example, we can create a group named Technical Specifications, and in it we can insert specifications referring to the product's technical data, such as material, voltage, dimensions, etc.\n\n> The groups and fields created will be valid for its registration category and for all child categories. For example, if a field is created in the root category, it will be available in all store categories.\n\nUsually just one group is created at root level and all the specification fields are associated with this group.\n\n### Create a Specification Group\n\nTo create a specification group, use the [Create Specification Group](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/specificationgroupinsert2) endpoint. The request body for this endpoint must include the `CategoryId` of the category that you are creating the specification group and the `Name` for the specification group. See the request body example below:\n\n`1\n\n{ \n\n2\n\n \"CategoryId\": 11, \n\n3\n\n \"Name\": \"Features\" \n\n4\n\n} \n\n`\n\nYou can also configure the `CategoryId` attribute as `null`. This will set the specification group to global, valid to all Categories in your Catalog. See the request body example below:\n\n`1\n\n{ \n\n2\n\n \"CategoryId\": null, \n\n3\n\n \"Name\": \"Features\" \n\n4\n\n} \n\n`\n\n> You need to create the specification group in the category associated with the desired product or SKU. If you create a specification group on a different category and associate it to the product or SKU by API the response will return `200 OK`, but it won't be visible at the Admin or your store, only by API.\n\n## Specifications\n\nAfter creating a Specification Group, you must create the specification field itself, which can be a [SKU specification](#sku-specifications) or a [product specification](#product-specifications).\n\n### Product Specifications\n\nA product specification is generally used to create site browsing filters or to display additional product information.\n\nFor example, in a fashion store you would be able to create a product specification to let your client know which type of fabric is sold in your store.\n\nThis information could be displayed as a filter in the search navigation menu or as an informative text inside the product page.\n\nProduct specifications can receive data such as strings and numbers, which VTEX APIs then consume and use for frontend customizations or to send information to external integrations.\n\n### SKU Specifications\n\nSKU specifications are used to create site browsing filters and to differentiate SKUs within the product page.\n\nFor example, a store that sells shirts, you would be able to create a SKU specification to tell your products apart by size.\n\nYour SKU specifications would have values such as XS, S, M, L and XL. These would be used as a browsing filter on your site. In addition, these specifications would work as SKU selectors on the product page.\n\n> In VTEX, SKU specifications are mandatory fields required to add SKUs, meaning that if a specification were to be created in a category, all SKUs within that category would need to carry this new specification. All these SKUs are therefore disabled until this new specification is added to the SKUs of the category in question.\n\nFor more details about each field, you can access the [Adding product specifications or fields](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/adding-specifications-or-product-fields--tutorials%5F106%23product-field-types) or the [Adding SKU specifications or fields](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/adding-sku-specifications-or-fields--tutorials%5F119%23sku-field-types) documentation.\n\n### Create a specification\n\nTo create a specification, use the [Create specification API endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/specification).\n\nConsider the following aspects in the request body:\n\n* If you are creating an [SKU specification](#sku-specifications), you need to set `IsStockKeepingUnit` as `true`. If it is a [product specification](#product-specifications), set `IsStockKeepingUnit` as `false`.\n* You will need the `FieldGroupId`, which is the ID of the specification group previously created. You can use the [List Specifications Group by Category](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-specification-group-categoryid) endpoint to get all groups IDs from a category.\n* The request body for this endpoint also includes the `FieldTypeId` that refers to the type you defined as this specification's type. The available types are:\n\n| Specification Type | ID | Description |\n| ----------------------- | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| Text | 1 | This specification is a small text, one-line restricted. The content is free text, but not suitable for large HTML structures. |\n| Multi-line Text | 2 | this specification is a larger text, containing a multi-line text. The content is free text, suitable for large HTML structures. |\n| Number | 4 | this specification is an integer number. |\n| Combo | 5 | this specification is a dropdown component with all the values you configure to it. This specification can be selected by the buyer. |\n| Radio | 6 | this specification is a radio button with all the values you configure to it. This specification can be selected by the buyer. |\n| Checkbox | 7 | this specification is a list of values with selectable checkboxes. This specification can be selected by the buyer. |\n| Indexed Text | 8 | this specification is a small text, one-line restricted. The content is free text, but not suitable for large HTML structures. The value will be directed to the Catalog indexer, so it will influence the search results of customers in the store. |\n| Indexed Multi-Line Text | 9 | this specification is a larger text, containing a multi-line text. The content is free text, suitable for large HTML structures. The value will be directed to the Catalog indexer, so it will influence the search results of customers in the store. |\n\n> When creating an SKU Specification, the request only allows two possible types: **Combo** or **Radio**. If you set up other types and `IsStockKeepingUnit` as `true`, the request will return `400 Bad Request` with the error message `Sku Field can be only of the Radio or Combo type`.\n\n**Request body example:**\n\n`1\n\n{ \n\n2\n\n \"FieldTypeId\": 1, \n\n3\n\n \"CategoryId\": 11, \n\n4\n\n \"FieldGroupId\": 1, \n\n5\n\n \"Name\": \"Fabric\", \n\n6\n\n \"Description\": \"Fabric of the dress\", \n\n7\n\n \"Position\": 1, \n\n8\n\n \"IsFilter\": true, \n\n9\n\n \"IsRequired\": true, \n\n10\n\n \"IsOnProductDetails\": true, \n\n11\n\n \"IsStockKeepingUnit\": false, \n\n12\n\n \"IsActive\": true, \n\n13\n\n \"IsTopMenuLinkActive\": false, \n\n14\n\n \"IsSideMenuLinkActive\": true, \n\n15\n\n \"DefaultValue\": \"Cotton\" \n\n16\n\n} \n\n`\n\n> If the `CategoryId` field is null, the field will be created in the root category.\n\n**Response body example:**\n\n`1\n\n{ \n\n2\n\n \"Id\": 193, \n\n3\n\n \"FieldTypeId\": 1, \n\n4\n\n \"CategoryId\": 11, \n\n5\n\n \"FieldGroupId\": 1, \n\n6\n\n \"Name\": \"Fabric\", \n\n7\n\n \"Description\": \"Fabric of the dress\", \n\n8\n\n \"Position\": 1, \n\n9\n\n \"IsFilter\": true, \n\n10\n\n \"IsRequired\": true, \n\n11\n\n \"IsOnProductDetails\": true, \n\n12\n\n \"IsStockKeepingUnit\": false, \n\n13\n\n \"IsActive\": true, \n\n14\n\n \"IsTopMenuLinkActive\": false, \n\n15\n\n \"IsSideMenuLinkActive\": true, \n\n16\n\n \"DefaultValue\": \"Cotton\" \n\n17\n\n} \n\n`\n\n## Specification values\n\nAfter creating the specification fields, if the `FieldTypeId` is `5` or `6` or `7` (Combo, Radio or Checkbox), it is necessary to register the respective possible values.\n\nYou can add multiple values to the specification, therefore creating the selective options displayed to the buyer. These values will be shown on the product form, as illustrated below:\n\n\n\n### Create specification values\n\nUse the [Create Specification Value](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-post-specification-value) endpoint to create the specification value.\n\nYou need to add the `FieldId` in the request body. To get the ID of the specification you created, use the [Get Specifications By Category ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-specification-category) endpoint.\n\n> Use this request for one value of one specification at a time. To register multiple values to one specification, you will need to create a request for each of the values.\n\nSee the example request below.\n\n**Request body example:**\n\n`1\n\n{ \n\n2\n\n \"FieldId\": 193, \n\n3\n\n \"Name\": \"Metal\", \n\n4\n\n \"IsActive\": true, \n\n5\n\n \"Position\": 1 \n\n6\n\n} \n\n`\n\n**Response body example:**\n\n`1\n\n{ \n\n2\n\n \"FieldValueId\": 360, \n\n3\n\n \"FieldId\": 193, \n\n4\n\n \"Name\": \"Metal\", \n\n5\n\n \"Text\": null, \n\n6\n\n \"IsActive\": true, \n\n7\n\n \"Position\": 1 \n\n8\n\n} \n\n`\n\n> You should activate specification fields, otherwise they will not work.\n\n## Associating a Specification\n\nOnce you have created a specification, and if needed added a value to it, you will associate the specification with a product or an SKU.\n\n### To a Product\n\nTo associate a specification with a product, use the [Associate Product Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-post-create-product-specification) endpoint. There are two different request bodies possible. This depends on the type of the created specification. Check the request body examples below to know which use when associating your specification with a product.\n\nFor Combo and Radio types:\n\nTo get the `FieldValueId` from the previously created specification value, use the [Get Specifications Values By Field ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-specification-field-value-fieldid) endpoint.\n\n`1\n\n{ \n\n2\n\n \"FieldId\": 1, \n\n3\n\n \"FieldValueId\": 13 \n\n4\n\n} \n\n`\n\nFor the other specification types:\n\n`1\n\n{ \n\n2\n\n \"FieldId\": 1, \n\n3\n\n \"Text\": \"Cotton\" \n\n4\n\n} \n\n`\n\n### To an SKU\n\nTo associate a specification with an SKU, use the [Associate SKU Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-post-sku-specification) endpoint. As informed before, the SKU specification can only be the Combo and Radio types.\n\nCheck the request body example below to see all requirements and read their descriptions on the [endpoint documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-post-sku-specification).\n\nTo get the `FieldValueId` from the previously created specification value, use the [Get Specifications Values By Field ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-specification-field-value-fieldid) endpoint.\n\n`1\n\n{ \n\n2\n\n \"FieldId\": 1, \n\n3\n\n \"FieldValueId\": 13 \n\n4\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/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/catalog-integration/specifications.md)\n\n[Products« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications//docs/guides/products)[Product specificationsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications//docs/guides/product-specifications)\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Specification Groups](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/specifications%23specification-groups)\n\n[Create a Specification Group](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/specifications%23create-a-specification-group)\n\n[Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/specifications%23specifications)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/specifications%23product-specifications)[SKU Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/specifications%23sku-specifications)[Create a specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/specifications%23create-a-specification)\n\n[Specification values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/specifications%23specification-values)\n\n[Create specification values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/specifications%23create-specification-values)\n\n[Associating a Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/specifications%23associating-a-specification)\n\n[To a Product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/specifications%23to-a-product)[To an SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/specifications%23to-an-sku)\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/catalog-integration/specifications.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Specification Groups](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/specifications%23specification-groups)\n\n[Create a Specification Group](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/specifications%23create-a-specification-group)\n\n[Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/specifications%23specifications)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/specifications%23product-specifications)[SKU Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/specifications%23sku-specifications)[Create a specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/specifications%23create-a-specification)\n\n[Specification values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/specifications%23specification-values)\n\n[Create specification values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/specifications%23create-specification-values)\n\n[Associating a Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/specifications%23associating-a-specification)\n\n[To a Product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/specifications%23to-a-product)[To an SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications/docs/guides/specifications%23to-an-sku)\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_bde9be2c
|
[
{
"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 installing activity flow in flutter 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/installing-activity-flow-in-flutter-apps/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-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/installing-activity-flow-in-flutter-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/installing-activity-flow-in-flutter-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/installing-activity-flow-in-flutter-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/installing-activity-flow-in-flutter-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/installing-activity-flow-in-flutter-apps/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/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/installing-activity-flow-in-flutter-apps/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-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/installing-activity-flow-in-flutter-apps/docs/guides/activity-flow)\n\n[Installing Activity Flow in Headless stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-headless-stores)\n\n[Installing Activity Flow in mobile apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-mobile-apps)\n\n[Installing Activity Flow in Flutter apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-flutter-apps)\n\n[Installing Activity Flow in React Native apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-react-native-apps)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-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/installing-activity-flow-in-flutter-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/installing-activity-flow-in-flutter-apps/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/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/installing-activity-flow-in-flutter-apps/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-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/installing-activity-flow-in-flutter-apps/docs/guides/activity-flow)\n\n[Installing Activity Flow in Headless stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-headless-stores)\n\n[Installing Activity Flow in mobile apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-mobile-apps)\n\n[Installing Activity Flow in Flutter apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-flutter-apps)\n\n[Installing Activity Flow in React Native apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-react-native-apps)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-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/installing-activity-flow-in-flutter-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/installing-activity-flow-in-flutter-apps/docs/guides)\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/activity-flow)\n\n[Installing Activity Flow in mobile apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-mobile-apps)\n\n[Installing Activity Flow in Flutter apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-flutter-apps)\n\nInstalling Activity Flow in Flutter apps\n\nIn this guide, you'll learn how to install and configure the [VTEX Activity Flow SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/activity-flow) in Flutter apps for Android and iOS. By following these steps, you'll be able to track user navigation, handle deep links, and collect ad events from your app.\n\n## Before you begin\n\n### Install the Activity Flow package\n\nThe Activity Flow SDK captures user navigation and sends events from your mobile app. To install the package, run the following command in your project directory:\n\n`1\n\nflutter pub add activity_flow \n\n`\n\nThis installs the SDK and updates your `pubspec.yaml` file with the `activity_flow` dependency.\n\n## Instructions\n\n### Step 1 – Importing the Activity Flow package\n\nIn your app's main file, import the Activity Flow package as follows:\n\n`1\n\nimport 'package:activity_flow/activity_flow.dart'; \n\n`\n\n### Step 2 – Creating an Activity Flow instance\n\nSet the account name to create an instance of the main package class:\n\n`1\n\nvoid main() { \n\n2\n\nrunApp(const MyApp()); \n\n3\n\n} \n\n4\n\n \n5\n\nclass App extends StatelessWidget { \n\n6\n\n \n7\n\n Widget build(BuildContext context) { \n\n8\n\n \n9\n\n// Call activity flow here \n\n10\n\n initActivityFlow(accountName: appAccountName); \n\n11\n\n... \n\n12\n\n \n13\n\n} \n\n`\n\n## Usage\n\n### Tracking page views automatically\n\nTo automatically track user navigation between app pages, add the `PageViewObserver` to the `navigatorObservers` list in your app:\n\n`1\n\nMyApp( \n\n2\n\n // Add the PageViewObserver to the navigatorObservers list. \n\n3\n\n navigatorObservers: [PageViewObserver()], \n\n4\n\n routes: { \n\n5\n\n // Define your named routes here \n\n6\n\n }, \n\n7\n\n \n8\n\n), \n\n`\n\nThis setup enables automatic screen view tracking for standard route navigation.\n\n### Tracking page views manually (for custom navigation)\n\nFor navigation widgets like `BottomNavigationBar` or `TabBar`, which do not trigger route changes, use the `trackPageView` function to track screen views manually.\n\nFor example, using the `onTap` callback within a `BottomNavigationBar` widget allows for capturing a new route each time the user taps on a different tab:\n\n`` 1\n\nBottomNavigationBar( \n\n2\n\n items: items, \n\n3\n\n currentIndex: _selectedIndex, \n\n4\n\n selectedItemColor: Colors.pink, \n\n5\n\n onTap: (index) { \n\n6\n\n _onItemTapped(index); \n\n7\n\n final label = items[index].label ?? 'Tab-$index'; \n\n8\n\n \n9\n\n // Manually calling the `trackPageView` with the label \n\n10\n\n trackPageView(label); \n\n11\n\n }, \n\n12\n\n) \n\n ``\n\n### Tracking deep links\n\nThe Activity Flow SDK automatically captures deep link query parameters and includes them in page view events when your app is configured for deep linking. Configure each platform as follows.\n\n#### Android\n\nAdd intent filters to `AndroidManifest.xml` for each route that can be accessed via deep link:\n\n`1\n\n \n2\n\n<intent-filter> \n\n3\n\n <action android:name=\"android.intent.action.VIEW\" /> \n\n4\n\n <category android:name=\"android.intent.category.DEFAULT\" /> \n\n5\n\n <category android:name=\"android.intent.category.BROWSABLE\" /> \n\n6\n\n <data \n\n7\n\n android:scheme=\"https\" \n\n8\n\n android:host=\"example.com\" \n\n9\n\n android:pathPrefix=\"{APP_ROUTE}\" /> \n\n10\n\n</intent-filter> \n\n11\n\n \n12\n\n<intent-filter> \n\n13\n\n <action android:name=\"android.intent.action.VIEW\" /> \n\n14\n\n <category android:name=\"android.intent.category.DEFAULT\" /> \n\n15\n\n <category android:name=\"android.intent.category.BROWSABLE\" /> \n\n16\n\n <data android:scheme=\"YOUR_CUSTOM_SCHEME\" /> \n\n17\n\n</intent-filter> \n\n`\n\nThe main difference between intent filters for different routes is the `android:pathPrefix` attribute, which specifies the app route.\n\n#### iOS\n\nConfigure both `Info.plist` and the app delegate to handle deep links.\n\n1. Register a custom URL scheme in `Info.plist`:\n\n`1\n\n<key>CFBundleURLTypes</key> \n\n2\n\n<array> \n\n3\n\n <dict> \n\n4\n\n <key>CFBundleURLSchemes</key> \n\n5\n\n <array> \n\n6\n\n <string>{YOUR_BUNDLE_URL_SCHEME}</string> \n\n7\n\n </array> \n\n8\n\n <key>CFBundleURLName</key> \n\n9\n\n <string>{YOUR_BUNDLE_URL_NAME}</string> \n\n10\n\n </dict> \n\n11\n\n</array> \n\n`\n\n1. Handle incoming URLs in `AppDelegate.swift` (or `AppDelegate.mm`) for both cold and warm starts:\n\n`1\n\nimport Flutter \n\n2\n\nimport UIKit \n\n3\n\nimport activity_flow \n\n4\n\n \n5\n\n@main \n\n6\n\n@objc class AppDelegate: FlutterAppDelegate { \n\n7\n\n override func application( \n\n8\n\n _ application: UIApplication, \n\n9\n\n didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? \n\n10\n\n ) -> Bool { \n\n11\n\n GeneratedPluginRegistrant.register(with: self) \n\n12\n\n \n13\n\n // Capture initial URL if app was launched with a deep link (cold start) \n\n14\n\n if let initialURL = launchOptions?[UIApplication.LaunchOptionsKey.url] as? URL { \n\n15\n\n DeepLinkManager.shared.handle(url: initialURL) \n\n16\n\n } \n\n17\n\n \n18\n\n return super.application(application, didFinishLaunchingWithOptions: launchOptions) \n\n19\n\n } \n\n20\n\n \n21\n\n // Handles incoming URLs from Custom URL Schemes (e.g., myapp://path) \n\n22\n\n override func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool { \n\n23\n\n DeepLinkManager.shared.handle(url: url) \n\n24\n\n return super.application(app, open: url, options: options) \n\n25\n\n } \n\n26\n\n \n27\n\n // Handles incoming URLs from Universal Links \n\n28\n\n override func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool { \n\n29\n\n // Check if the activity is a web browsing activity (Universal Link) \n\n30\n\n if userActivity.activityType == NSUserActivityTypeBrowsingWeb { \n\n31\n\n if let url = userActivity.webpageURL { \n\n32\n\n DeepLinkManager.shared.handle(url: url) \n\n33\n\n } \n\n34\n\n } \n\n35\n\n return super.application(application, continue: userActivity, restorationHandler: restorationHandler) \n\n36\n\n } \n\n37\n\n} \n\n`\n\n1. Configure `SceneDelegate`\n\nIf your project uses a `SceneDelegate`, also forward deep links there:\n\nios/Runner/SceneDelegate.swift\n\n`1\n\nimport UIKit \n\n2\n\nimport Flutter \n\n3\n\nimport activity_flow \n\n4\n\n \n5\n\nclass SceneDelegate: FlutterSceneDelegate { \n\n6\n\n override func scene(_ scene: UIScene, willConnectTo session: UISceneSession, options connectionOptions: UIScene.ConnectionOptions) { \n\n7\n\n // Capture deep links on cold start \n\n8\n\n var hasDeepLink = false \n\n9\n\n \n10\n\n if let userActivity = connectionOptions.userActivities.first(where: { $0.activityType == NSUserActivityTypeBrowsingWeb }) { \n\n11\n\n if let url = userActivity.webpageURL { \n\n12\n\n DeepLinkManager.shared.handle(url: url) \n\n13\n\n hasDeepLink = true \n\n14\n\n } \n\n15\n\n } else if let url = connectionOptions.urlContexts.first?.url { \n\n16\n\n DeepLinkManager.shared.handle(url: url) \n\n17\n\n hasDeepLink = true \n\n18\n\n } \n\n19\n\n \n20\n\n // Call super with empty options if a deep link was handled \n\n21\n\n if hasDeepLink { \n\n22\n\n super.scene(scene, willConnectTo: session, options: UIScene.ConnectionOptions()) \n\n23\n\n } else { \n\n24\n\n super.scene(scene, willConnectTo: session, options: connectionOptions) \n\n25\n\n } \n\n26\n\n } \n\n27\n\n \n28\n\n override func scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) { \n\n29\n\n if let url = URLContexts.first?.url { \n\n30\n\n DeepLinkManager.shared.handle(url: url) \n\n31\n\n } \n\n32\n\n } \n\n33\n\n \n34\n\n override func scene(_ scene: UIScene, continue userActivity: NSUserActivity) { \n\n35\n\n if userActivity.activityType == NSUserActivityTypeBrowsingWeb { \n\n36\n\n if let url = userActivity.webpageURL { \n\n37\n\n DeepLinkManager.shared.handle(url: url) \n\n38\n\n } \n\n39\n\n } \n\n40\n\n } \n\n41\n\n} \n\n`\n\n### (Optional) Tracking ad events\n\n> Ads tracking is available only for accounts using [VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-ads). If you're interested in this feature, open a ticket with [VTEX Support](https://read.calvincode.net/reader?url=https://support.vtex.com/hc/en-us).\n\nWhen you apply the listener to a widget, the SDK automatically tracks three events:\n\n* **Impression:** When the widget is first built and rendered.\n* **View:** When at least 50% of the widget is visible on screen for at least 1 continuous second.\n* **Click:** When the user taps the widget.\n\nTo start tracking your ad events, follow these steps:\n\n1. Call the `addAdsListener`\n\nTo enable tracking, call the `addAdsListener` extension method on any Flutter widget that represents an ad:\n\n`1\n\nyourAdWidget.addAdsListener({Map<String, String> adMetadata); \n\n`\n\n* `yourAdWidget`: The ad widget you want to monitor.\n* `adMetadata`: A map containing specific details about the ad, which will be sent to your analytics service upon a click.\n\nThe following example initializes the Activity Flow to track page views automatically and demonstrates manual tracking for tab changes:\n\n`1\n\nimport 'package:activity_flow/activity_flow.dart'; \n\n2\n\nimport 'package:flutter/material.dart'; \n\n3\n\n \n4\n\nclass HomeScreen extends StatelessWidget { \n\n5\n\n const HomeScreen({super.key}); \n\n6\n\n \n7\n\n @override \n\n8\n\n Widget build(BuildContext context) { \n\n9\n\n return Scaffold( \n\n10\n\n appBar: AppBar(title: const Text('Home')), \n\n11\n\n body: ListView( \n\n12\n\n children: [ \n\n13\n\n const Padding( \n\n14\n\n padding: EdgeInsets.all(16.0), \n\n15\n\n child: Text('Featured Products'), \n\n16\n\n ), \n\n17\n\n \n18\n\n // Standard content \n\n19\n\n const ProductTile(name: 'Product A'), \n\n20\n\n const ProductTile(name: 'Product B'), \n\n21\n\n \n22\n\n // Ad Widget with Activity Flow tracking \n\n23\n\n // We wrap the visual component (e.g., Image, Container) with the listener \n\n24\n\n Padding( \n\n25\n\n padding: const EdgeInsets.symmetric(vertical: 10.0), \n\n26\n\n child: Container( \n\n27\n\n height: 150, \n\n28\n\n width: double.infinity, \n\n29\n\n color: Colors.grey[200], \n\n30\n\n child: Image.asset( \n\n31\n\n 'assets/promo_banner.jpg', \n\n32\n\n fit: BoxFit.cover, \n\n33\n\n ), \n\n34\n\n ).addAdsListener({ \n\n35\n\n 'adId': 'summer_campaign_123', \n\n36\n\n 'creativeId': 'banner_v1', \n\n37\n\n 'position': 'list_middle', \n\n38\n\n 'campaignName': 'Summer Sale 2024', \n\n39\n\n }), \n\n40\n\n ), \n\n41\n\n // More content \n\n42\n\n const ProductTile(name: 'Product C'), \n\n43\n\n ], \n\n44\n\n ), \n\n45\n\n ); \n\n46\n\n } \n\n47\n\n} \n\n`\n\nThis Flutter screen, constructed as a `StatelessWidget` that lists products and displays an ad banner. The banner's Container is wrapped with Activity Flow's `addAdsListener`, which attaches an ad-event listener and sends the provided metadata map with each event.\n\nThis instrumentation enables the automatic tracking of impressions, viewability, and clicks, allowing for comprehensive analytics tied to `adId`, `creativeId`, `position`, and `campaignName`.\n\n## Flutter automated tests\n\nTo ensure your Flutter test runs work correctly when the Activity Flow is installed, run tests with a test environment flag using a `--dart-define` flag.\n\nThe `--dart-define` flag lets you pass compile-time key=value pairs into your Flutter app as Dart environment declarations. Follow the steps below:\n\n1. In your terminal, run `flutter test --dart-define=ACTIVITY_FLOW_TEST_ENV=true`.\n2. In a code editor, open your project.\n3. In the code editor settings, search for `dart.flutterTestAdditionalArgs`.\n4. Add to it the value `--dart-define=ACTIVITY_FLOW_TEST_ENV=true`.\n5. Open the `settings.json` file of your project.\n6. Add the following: `\"dart.flutterTestAdditionalArgs\": [\"--dart-define=ACTIVITY_FLOW_TEST_ENV=true\"]`\n\n## Use case example\n\nBelow is an example that contains an app with some pages and navigation through them:\n\n`1\n\nimport 'package:activity_flow/activity_flow.dart'; \n\n2\n\nimport 'package:flutter/material.dart'; \n\n3\n\nimport 'package:example/screens/favorite.dart'; \n\n4\n\nimport 'package:example/screens/products.dart'; \n\n5\n\nimport 'package:example/screens/profile.dart'; \n\n6\n\n \n7\n\nvoid main() { \n\n8\n\n runApp(const ExampleApp()); \n\n9\n\n} \n\n10\n\n/// A MaterialApp with a custom theme and routes. \n\n11\n\n/// The routes are defined in the [routes] property. \n\n12\n\n/// The theme is defined in the [theme] property. \n\n13\n\nclass ExampleApp extends StatelessWidget { \n\n14\n\n const ExampleApp({super.key}); \n\n15\n\n \n16\n\n @override \n\n17\n\n Widget build(BuildContext context) { \n\n18\n\n initActivityFlow(accountName: appAccountName); \n\n19\n\n \n20\n\n return MaterialApp( \n\n21\n\n title: 'Example App', \n\n22\n\n theme: ThemeData( \n\n23\n\n colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple), \n\n24\n\n useMaterial3: true, \n\n25\n\n ), \n\n26\n\n routes: { \n\n27\n\n '/': (context) => const MyHomePage(), \n\n28\n\n '/products': (context) => const ProductsScreen(), \n\n29\n\n '/profile': (context) => const ProfileScreen(), \n\n30\n\n '/favorites': (context) => const FavoriteScreen(), \n\n31\n\n }, \n\n32\n\n initialRoute: '/', \n\n33\n\n navigatorObservers: [PageViewObserver()], \n\n34\n\n \n35\n\n/// A home screen with buttons to navigate to other screens. \n\n36\n\nclass MyHomePage extends StatelessWidget { \n\n37\n\n const MyHomePage({super.key}); \n\n38\n\n \n39\n\n final List<Map> _routes = const [ \n\n40\n\n { \n\n41\n\n 'name': 'Products', \n\n42\n\n 'route': '/products', \n\n43\n\n }, \n\n44\n\n { \n\n45\n\n 'name': 'Profile', \n\n46\n\n 'route': '/profile', \n\n47\n\n } \n\n48\n\n ]; \n\n49\n\n \n50\n\n @override \n\n51\n\n Widget build(BuildContext context) { \n\n52\n\n return Scaffold( \n\n53\n\n appBar: AppBar( \n\n54\n\n backgroundColor: Theme.of(context).colorScheme.inversePrimary, \n\n55\n\n title: const Text('Home Screen'), \n\n56\n\n ), \n\n57\n\n body: Center( \n\n58\n\n child: Column(mainAxisAlignment: MainAxisAlignment.center, children: [ \n\n59\n\n const AdBanner().addAdsListener({ \n\n60\n\n 'productName': 'Sneakers', \n\n61\n\n 'productPrice': '59.99', \n\n62\n\n 'adID': '1123', \n\n63\n\n }), \n\n64\n\n ..._routes.map((route) => ButtonTemplate( \n\n65\n\n title: route['name'], \n\n66\n\n route: route['route'], \n\n67\n\n )), \n\n68\n\n ])), \n\n69\n\n ); \n\n70\n\n } \n\n71\n\n} \n\n72\n\n \n73\n\n/// A template for creating buttons. \n\n74\n\n/// Receives a [title], [icon], and [route] to navigate to. \n\n75\n\n/// Returns an [ElevatedButton.icon] with the given parameters. \n\n76\n\nclass ButtonTemplate extends StatelessWidget { \n\n77\n\n const ButtonTemplate({ \n\n78\n\n super.key, \n\n79\n\n required this.title, \n\n80\n\n required this.route, \n\n81\n\n }); \n\n82\n\n \n83\n\n final String title; \n\n84\n\n final String route; \n\n85\n\n \n86\n\n @override \n\n87\n\n Widget build(BuildContext context) { \n\n88\n\n return ElevatedButton( \n\n89\n\n onPressed: () => Navigator.pushNamed(context, route), \n\n90\n\n child: Text(title), \n\n91\n\n ); \n\n92\n\n } \n\n93\n\n} \n\n`\n\nThe example demonstrates the integration of Activity Flow into a Flutter app by importing the necessary package, initializing it with `initActivityFlow(accountName: appAccountName)`, and constructing a `MaterialApp` with named routes and a `PageViewObserver` to automatically capture page-view events.\n\nIt outlines a `MyHomePage` that incorporates an `AdBanner`, which utilizes `addAdsListener` to pass ad metadata such as product name, price, and ID. Additionally, it features navigation buttons sourced from a routes list.\n\nThe reusable `ButtonTemplate` facilitates navigation through `Navigator.pushNamed`, showcasing a standard configuration for automatic screen tracking, as well as ad impression and click tracking, in a Flutter application.\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/Activity-Flow/installing-activity-flow-in-flutter-apps.md)\n\n[Installing Activity Flow in mobile apps« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps//docs/guides/installing-activity-flow-in-mobile-apps)[Installing Activity Flow in React Native appsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps//docs/guides/installing-activity-flow-in-react-native-apps)\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/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-flutter-apps%23before-you-begin)\n\n[Install the Activity Flow package](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-flutter-apps%23install-the-activity-flow-package)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-flutter-apps%23instructions)\n\n[Step 1 – Importing the Activity Flow package](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-flutter-apps%23step-1--importing-the-activity-flow-package)[Step 2 – Creating an Activity Flow instance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-flutter-apps%23step-2--creating-an-activity-flow-instance)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-flutter-apps%23usage)\n\n[Tracking page views automatically](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-flutter-apps%23tracking-page-views-automatically)[Tracking page views manually (for custom navigation)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-flutter-apps%23tracking-page-views-manually-for-custom-navigation)[Tracking deep links](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-flutter-apps%23tracking-deep-links)[(Optional) Tracking ad events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-flutter-apps%23optional-tracking-ad-events)\n\n[Flutter automated tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-flutter-apps%23flutter-automated-tests)\n\n[Use case example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-flutter-apps%23use-case-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/Activity-Flow/installing-activity-flow-in-flutter-apps.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/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-flutter-apps%23before-you-begin)\n\n[Install the Activity Flow package](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-flutter-apps%23install-the-activity-flow-package)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-flutter-apps%23instructions)\n\n[Step 1 – Importing the Activity Flow package](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-flutter-apps%23step-1--importing-the-activity-flow-package)[Step 2 – Creating an Activity Flow instance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-flutter-apps%23step-2--creating-an-activity-flow-instance)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-flutter-apps%23usage)\n\n[Tracking page views automatically](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-flutter-apps%23tracking-page-views-automatically)[Tracking page views manually (for custom navigation)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-flutter-apps%23tracking-page-views-manually-for-custom-navigation)[Tracking deep links](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-flutter-apps%23tracking-deep-links)[(Optional) Tracking ad events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-flutter-apps%23optional-tracking-ad-events)\n\n[Flutter automated tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-flutter-apps%23flutter-automated-tests)\n\n[Use case example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/installing-activity-flow-in-flutter-apps/docs/guides/installing-activity-flow-in-flutter-apps%23use-case-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=)"
}
] |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.