id
stringlengths 12
53
| messages
listlengths 3
3
|
|---|---|
doc_4cc6882b
|
[
{
"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 using themes 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/faststore/using-themes-components/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-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/faststore/using-themes-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/faststore/using-themes-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/faststore/using-themes-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/faststore/using-themes-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/faststore/using-themes-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/faststore/using-themes-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/faststore/using-themes-components/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/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/using-themes-components/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/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/using-themes-components/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/styling-overview)\n\n[Themes reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/themes-overview)\n\n[Global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/global-tokens-overview)\n\n[Iconography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/styling-icons)\n\n[Using themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/using-themes-overview)\n\n[Styling the layout and breakpoints](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/using-themes-mixins-breakpoints)\n\n[Styling a component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/using-themes-components)\n\n[Styling a section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/using-themes-pages)\n\n[Importing FastStore UI component styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/using-themes-importing-ui-components-styles)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/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/using-themes-components/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/using-themes-components/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/using-themes-components/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/using-themes-components/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/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/using-themes-components/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-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/faststore/using-themes-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/faststore/using-themes-components/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/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/using-themes-components/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/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/using-themes-components/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/styling-overview)\n\n[Themes reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/themes-overview)\n\n[Global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/global-tokens-overview)\n\n[Iconography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/styling-icons)\n\n[Using themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/using-themes-overview)\n\n[Styling the layout and breakpoints](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/using-themes-mixins-breakpoints)\n\n[Styling a component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/using-themes-components)\n\n[Styling a section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/using-themes-pages)\n\n[Importing FastStore UI component styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/using-themes-importing-ui-components-styles)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/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/using-themes-components/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/using-themes-components/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/using-themes-components/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/using-themes-components/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/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/using-themes-components/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/styling-overview)\n\n[Using themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/using-themes-overview)\n\nStyling a component\n\nCustomize the styling of a component by using design tokens that align with your store's branding.\n\nCustomize a component's styling using design tokens that align with your store's branding. In this guide, you'll learn how to customize the style of a FastStore component using its local tokens. For this tutorial, we will use the `Listing` variant from the [Price Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-price).\n\nThis is how prices look like in our current homepage (with the default color black) :\n\n\n\n> Remember that when changing a component's style, you can use [Global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-overview) or styling from scratch using your preferred styling tool. However, changing the value of a global token may affect different parts of your store's interface.\n\n1. In your `custom-theme.scss` theme file, add the `data-fs-price` data attribute:\n\nsrc/themes/custom-theme.scss\n\n`1\n\n ... \n\n2\n\n // -------------------------------------------------------- \n\n3\n\n // FS UI Components \n\n4\n\n // -------------------------------------------------------- \n\n5\n\n // Add here the customizations for FastStore UI components. \n\n6\n\n [data-fs-price] {} \n\n`\n\n> Each FastStore UI component has a list of data attributes that can be used for further customization. You can find it in the component's [customization section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-price%23customization).\n\n1. Now, add the `Listing` variant using the `Price` [local token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-price%23design-tokens). For this tutorial, we will use the shade of red `#cb4242`:\n\nsrc/themes/custom-theme.scss\n\n`1\n\n \n2\n\n ... \n\n3\n\n // -------------------------------------------------------- \n\n4\n\n // FS UI Components \n\n5\n\n // -------------------------------------------------------- \n\n6\n\n [data-fs-price] { \n\n7\n\n --fs-price-listing-color: #cb4242; \n\n8\n\n } \n\n`\n\n1. Save your changes and check your browser to see the new color of your listing price. You may need to refresh the page.\n\n\n\nSince we are not specifying the `Price` component context, we are applying this change to all the `Price (data-fs-price)` occurrences where the variant is `listing`. If you want to apply this change in only one store component, follow the next step [Customizing a component within a section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components%23customizing-a-component-within-a-section).\n\n## Customizing a component within a section\n\nThe starter provides a set of [native sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-list-of-native-sections), each consisting of different components with unique functionalities. You can customize the components inside its section using the available section and the component's data attributes.\n\nIn the example below, we will change the color of the [Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-price%23customization) component with the `listing` variant. However, we only want to apply this change to the `ProductShelf` section. So, we can use the `data-fs-product-shelf` data-attribute to select the [ProductShelf component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf%23customization) in this section.\n\n1. In your `custom-theme.scss` theme file , add the following code:\n\nsrc/themes/custom-theme.scss\n\n`1\n\n \n2\n\n ... \n\n3\n\n // -------------------------------------------------------- \n\n4\n\n // FS UI Components \n\n5\n\n // -------------------------------------------------------- \n\n6\n\n [data-fs-price] { \n\n7\n\n --fs-price-listing-color: #cb4242; \n\n8\n\n } \n\n9\n\n [data-fs-product-shelf]{ \n\n10\n\n [data-fs-price][data-fs-price-variant=\"listing\"] { \n\n11\n\n background-color: var(--fs-color-warning-bkg); \n\n12\n\n } \n\n13\n\n } \n\n`\n\n1. Save your changes and check your browser to see a yellow background color added to listing prices inside the `ProductShelf`. You may need to refresh the page.\n\n\n\nNotice that in this example, only one section, the `ProductShelf,` received the change. You can use this same approach whenever you need to sync FastStore UI Components.\n\n## Customizing a new component when using override\n\nTo customize a native component in FastStore to suit your store's needs, you can use the **override** feature. When [overriding a native component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1%23overriding-a-native-component) and using your custom component, you may need to style it from scratch. In this section, you'll learn how to style a custom component.\n\n### Before you begin\n\nMake sure you have a basic understanding of [overriding native components and props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1). Additionally, we recommend using [CSS Module](https://read.calvincode.net/reader?url=https://nextjs.org/docs/app/building-your-application/styling/css-modules) to style your new component.\n\n> FastStore components support [Sass](https://read.calvincode.net/reader?url=https://sass-lang.com/) for styling by default, but you can work with your desired tool.\n\nFor better understanding, we will use the example from the [Overriding Native Components and Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1) guide. This example demonstrates how to create a new `BuyButton`, the `CustomBuyButton` in the `ProductDetails` section. To follow along this section, make sure to create the `CustomBuyButton`.\n\n### Instructions\n\n1. Once you have created the `CustomBuyButton` component, create a new file called `CustomBuyButtons.module.scss`.\n\n\n\n1. Add the following code to the `CustomBuyButtons.module.scss` file:\n\nCustomBuyButton.module.scss\n\n`1\n\n.CustomBuyButton { \n\n2\n\n --fs-button-border-radius: var(--fs-border-radius-pill); \n\n3\n\n --fs-button-padding: 0 var(--fs-spacing-5); \n\n4\n\n \n5\n\n color: var(--fs-color-text-inverse); \n\n6\n\n \n7\n\n [data-fs-button-wrapper] { \n\n8\n\n background-color: #E31C58; \n\n9\n\n } \n\n10\n\n} \n\n`\n\n> You can use FastStore UI components' customization data attribute to ease your styling process. In this example, we used `data-fs-button-wrapper`.\n\nTo ensure visual consistency with your store's theme, we highly recommend utilizing the [global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-overview) whenever possible. You can also take advantage of the design tokens set provided by [FastStore UI Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index).\n\n1. Restart the server and check the color and shape of your `CustomBuyButton` component:\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/styling/using-themes/components.mdx)\n\n[Styling the layout and breakpoints« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/using-themes-mixins-breakpoints)[Styling a sectionNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/using-themes-pages)\n\nSee also\n\n[ OverviewStorefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/themes-overview)[Developing and overriding UI componentsStorefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/building-sections-overview)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Customizing a component within a section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/using-themes-components%23customizing-a-component-within-a-section)\n\n[Customizing a new component when using override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/using-themes-components%23customizing-a-new-component-when-using-override)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/using-themes-components%23before-you-begin)[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/using-themes-components%23instructions)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/styling/using-themes/components.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Customizing a component within a section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/using-themes-components%23customizing-a-component-within-a-section)\n\n[Customizing a new component when using override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/using-themes-components%23customizing-a-new-component-when-using-override)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/using-themes-components%23before-you-begin)[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components/docs/guides/faststore/using-themes-components%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_7e41f7f9
|
[
{
"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 marketplace data orders api in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n[Feed v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/orders-feed)\n\n[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/order-modifications)\n\n[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/change-seller)\n\n[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/order-canceling-improvements)\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/actions-orders)\n\n[Fetching marketplace information with the Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/get-marketplace-data-orders-api)\n\n[Fetching payment details from a Mercado Libre order with Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/get-payment-data-mercado-libre-orders-api)\n\n[Formatting order invoicing time via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/formatting-order-invoicing-time)\n\n[Using VTEX Admin filters on orders via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/using-orders-management-filters-in-api)\n\n[Adding a second address for invoicing an order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/adding-a-second-address-to-the-order)\n\nSubscriptions\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n[Feed v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/orders-feed)\n\n[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/order-modifications)\n\n[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/change-seller)\n\n[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/order-canceling-improvements)\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/actions-orders)\n\n[Fetching marketplace information with the Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/get-marketplace-data-orders-api)\n\n[Fetching payment details from a Mercado Libre order with Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/get-payment-data-mercado-libre-orders-api)\n\n[Formatting order invoicing time via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/formatting-order-invoicing-time)\n\n[Using VTEX Admin filters on orders via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/using-orders-management-filters-in-api)\n\n[Adding a second address for invoicing an order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/adding-a-second-address-to-the-order)\n\nSubscriptions\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides)\n\nOrders\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/actions-orders)\n\n[Fetching marketplace information with the Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/get-marketplace-data-orders-api)\n\nFetching marketplace information with the Orders API\n\nThe information contained in ecommerce invoices may vary according to business laws in each country. It is possible, for example, that you are required to include payment method information in case a sale is made through an intermediator.\n\nVTEX stores this data during checkout and makes it available to sellers integrated with different types of marketplaces.\n\nIt is possible to see who the marketplace is by checking the order object with the [Get order API request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23overview%23getorder), in the `affiliateId` field, like in the example below.\n\n`1\n\n{ \n\n2\n\n \"emailTracked\": \"a27499cad31f42b7a771ae34f57c8358@ct.vtex.com.br\", \n\n3\n\n \"approvedBy\": null, \n\n4\n\n \"cancelledBy\": null, \n\n5\n\n \"cancelReason\": null, \n\n6\n\n \"orderId\": \"v5195004lux-01\", \n\n7\n\n \"sequence\": \"502556\", \n\n8\n\n \"marketplaceOrderId\": \"880102018018-01\", \n\n9\n\n \"marketplaceServicesEndpoint\": \"http://oms.vtexinternal.com.br/api/oms?an=luxstore\", \n\n10\n\n \"sellerOrderId\": \"00-v5195004lux-01\", \n\n11\n\n \"origin\": \"Fulfillment\", \n\n12\n\n \"affiliateId\": \"ABC\", \n\n13\n\n \"salesChannel\": \"1\", \n\n14\n\n \"merchantName\": null, \n\n15\n\n \"status\": \"handling\", \n\n16\n\n \"statusDescription\": \"Preparando Entrega\", \n\n17\n\n \"value\": 1160, \n\n18\n\n \"creationDate\": \"2019-01-28T20:09:43.8999580+00:00\", \n\n19\n\n \"lastChange\": \"2019-02-06T20:46:11.7010747+00:00\", \n\n20\n\n… \n\n`\n\n> In case of sellers using the [Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4%23) feature, the `affiliateId` field identifies the marketplace in the level directly above it. This means that if a seller on the third level receives a fulfillment order made in a marketplace in the first level, the order’s `affiliateId` will refer to the second level marketplace. Payment method information can be accessed in two different ways depending on the type of marketplace.\n\n## VTEX marketplaces\n\nVTEX clients who are sellers of other VTEX clients can access intermediator payment method data in the order object, in the `userPaymentInfo.paymentMethod` array, within the `invoiceData` object. See the example below.\n\n`1\n\n... \n\n2\n\n\"invoiceData\": { \n\n3\n\n \"userPaymentInfo\": { \n\n4\n\n \"paymentMethod\": [ \n\n5\n\n \"creditCardPaymentGroup\" \n\n6\n\n ] \n\n7\n\n } \n\n8\n\n} \n\n9\n\n... \n\n`\n\nThe `paymentMethod` array includes strings which follow this pattern `{payment-group-name}PaymentGroup`. There are dozens of possible values, depending on the payment groups used by the marketplace. These are some examples:\n\n* `\"creditCardPaymentGroup\"`\n* `\"debitCardPaymentGroup\"`\n* `\"instantPaymentPaymentGroup\"`\n* `\"promissoryPaymentGroup\"`\n* `\"PayPalPlusPaymentGroup\"`\n* `\"OneBuyPaymentGroup\"`\n* `\"virtualDebitEloPaymentGroup\"`\n* `\"foodCardPaymentGroup\"`\n* `\"giftCardPaymentGroup\"`\n* `\"debitPaymentGroup\"`\n* `\"PaymentHubPaymentGroup\"`\n* `\"PagosNetPaymentGroup\"`\n* `\"bankInvoicePaymentGroup\"`\n* `\"PagosWebPaymentGroup\"`\n* `\"cardPromissoryPaymentGroup\"`\n* `\"SamsungPayPaymentGroup\"`\n\n> For external sellers connected to VTEX marketplaces this data is also sent in the `invoiceData` object, in the format described above.\n\n## Natively integrated external marketplaces\n\nVTEX provides native connectors that allow our clients to connect to external marketplaces. We store intermediator data and make it available to sellers integrating with:\n\n* B2W\n* Via Varejo\n* Magazine Luiza\n* Mercado Libre\n* Amazon\n* Centauro\n* Dafiti\n* Wish\n\nIn this scenario, marketplace payment method information is stored in the `customData` object in the [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23overview) data structure.\n\nThe following marketplaces are also natively integrated, however, their payment information is not automatically stored in the customData object.\n\n* Carrefour\n* Netshoes\n\n### Fetching external marketplace payment method data\n\nThis is an example of what you might find in the `customData` object of the order object when using the Get order request:\n\n`1\n\n{ \n\n2\n\n ... \n\n3\n\n \"customData\": { \n\n4\n\n \"customApps\": [ \n\n5\n\n { \n\n6\n\n \"id\": \"CN-Viavarejo-Integration\", \n\n7\n\n \"fields\": { \n\n8\n\n \"marketplacePaymentMethod\": \"credit_card\" \n\n9\n\n } \n\n10\n\n } \n\n11\n\n ] \n\n12\n\n } \n\n13\n\n ... \n\n14\n\n} \n\n`\n\n> The Checkout API allows integrators to create customizable fields in the shopping cart through the `customData` object. Their middleware can create extra fields in the `orderForm` data structure and set the value of each of these fields when placing an order, so that this additional information can be retrieved when fetching order details with the Orders API. For orders made in marketplaces with native VTEX connectors, payment method will be available in the `marketplacePaymentMethod` field. These are the possible values for this field:\n\n* `\"credit_card\"`\n* `\"debit_card\"`\n* `\"bank_slip\"`\n* `\"bank_deposit\"`\n* `\"pix\"`\n* `\"digital_wallet\"`\n* `\"gift_card\"`\n* `\"virtual_credit\"`\n* `\"payment_method_not_informed\"`\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/Orders/actions-orders/get-marketplace-data-orders-api.md)\n\n[Actions in orders« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api//docs/guides/actions-orders)[Fetching payment details from a Mercado Libre order with Orders APINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api//docs/guides/get-payment-data-mercado-libre-orders-api)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[VTEX marketplaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/get-marketplace-data-orders-api%23vtex-marketplaces)\n\n[Natively integrated external marketplaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/get-marketplace-data-orders-api%23natively-integrated-external-marketplaces)\n\n[Fetching external marketplace payment method data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/get-marketplace-data-orders-api%23fetching-external-marketplace-payment-method-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/Orders/actions-orders/get-marketplace-data-orders-api.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[VTEX marketplaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/get-marketplace-data-orders-api%23vtex-marketplaces)\n\n[Natively integrated external marketplaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/get-marketplace-data-orders-api%23natively-integrated-external-marketplaces)\n\n[Fetching external marketplace payment method data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-marketplace-data-orders-api/docs/guides/get-marketplace-data-orders-api%23fetching-external-marketplace-payment-method-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_4bc7c1f2
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides setting up the spf in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/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[Setting up DKIM for transactional emails](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides/setting-up-dkim-for-transactional-emails)\n\n[Setting up the SPF](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides/setting-up-the-spf)\n\n[How to set up functions in the Message Center templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides/how-to-set-up-functions-in-the-message-center-templates)\n\n[Including order variables in the transactional email template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides/including-order-variables-in-the-transactional-email-template)\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/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[Setting up DKIM for transactional emails](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides/setting-up-dkim-for-transactional-emails)\n\n[Setting up the SPF](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides/setting-up-the-spf)\n\n[How to set up functions in the Message Center templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides/how-to-set-up-functions-in-the-message-center-templates)\n\n[Including order variables in the transactional email template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides/including-order-variables-in-the-transactional-email-template)\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides)\n\nMessage Center\n\n[Setting up the SPF](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides/setting-up-the-spf)\n\nSetting up the SPF\n\nThe [SPF (Sender Policy Framework)](https://read.calvincode.net/reader?url=http://www.open-spf.org/Introduction/) is a standard that specifies how to prevent unauthorized servers from sending emails on behalf of your domain. This framework implements rules that verify if the server has a particular policy set up by the domain’s admin.\n\n## Editing the SPF\n\nTo understand SPF syntax, we recommend reading [SPF Record Syntax](https://read.calvincode.net/reader?url=http://www.open-spf.org/SPF%5FRecord%5FSyntax/).\n\nVTEX uses `include:amazonses.com`, Amazon's transactional email sending service, used in the default sender of Message Center.\n\nHere is an example of an SPF on VTEX:\n\n`1\n\nv=spf1 include:server.com include:amazonses.com ~all \n\n`\n\nAll `include` mechanisms should be set up to add a new SPF. See the example below to understand how to add `include:amazonses.com` if there is already another `include` mechanism:\n\n| Before | After |\n| ---------------------------------------------------------------- | -------------------------------------------------------------------------------------- |\n| v=spf1 include:websitewelcome.com include:\\_spf.google.com \\~all | v=spf1 include:websitewelcome.com include:\\_spf.google.com include:amazonses.com \\~all |\n\n> The domain should only have one SPF entry including all the necessary rules, such as `include` mechanisms and others in [SPF Record Syntax](https://read.calvincode.net/reader?url=http://www.open-spf.org/SPF%5FRecord%5FSyntax/).\n\n## Verifying the SPF\n\nTo verify the SPF entries on your domain, we recommend using the [DIG](https://read.calvincode.net/reader?url=https://www.digwebinterface.com) tool. Follow the steps below:\n\n1. On the [DIG tool website](https://read.calvincode.net/reader?url=https://www.digwebinterface.com/), fill your root domain (e.g. `vtex.com`) in **Hostnames or IP addresses**.\n2. Select **TXT** as **Type**.\n3. Click on **Dig**.\n\n> ️ The modifications are impacted by the domain propagation time. It can take between 24 or 48 hours for DIG to reflect changes.\n\nBelow, check a [consult example using the VTEX domain](https://read.calvincode.net/reader?url=https://www.digwebinterface.com/?hostnames=vtex.com%26type=TXT%26ns=resolver%26useresolver=8.8.4.4%26nameservers=):\n\n\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/api-guides/setting-up-the-spf.md)\n\n[Setting up DKIM for transactional emails« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf//docs/guides/setting-up-dkim-for-transactional-emails)[How to set up functions in the Message Center templatesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf//docs/guides/how-to-set-up-functions-in-the-message-center-templates)\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[Editing the SPF](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides/setting-up-the-spf%23editing-the-spf)\n\n[Verifying the SPF](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides/setting-up-the-spf%23verifying-the-spf)\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/api-guides/setting-up-the-spf.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Editing the SPF](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides/setting-up-the-spf%23editing-the-spf)\n\n[Verifying the SPF](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-spf/docs/guides/setting-up-the-spf%23verifying-the-spf)\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_32e1d81e
|
[
{
"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 node 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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-builder/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-node-builder/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-node-builder/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-node-builder/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-node-builder/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-node-builder/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-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-node-builder/docs/guides/vtex-io-documentation-builders)\n\n[Node Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-node-builder/docs/guides/vtex-io-documentation-node-builder)\n\nNode builder\n\nLearn how to use the VTEX IO Node builder.\n\nThe `node` builder is used to develop [backend apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service) with TypeScript code executed by the [Node.js runtime](https://read.calvincode.net/reader?url=https://nodejs.org/en). This guide aims to provide a comprehensive understanding of how to use this builder effectively. For more information, see [Developing services on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io).\n\n## Versioning\n\nThe Node builder versions are defined in the table below. Each builder version is compatible with a specific version of the Node.js engine, [@types/node package](https://read.calvincode.net/reader?url=https://www.npmjs.com/package/@types/node) (TypeScript definitions for Node), and TypeScript. You can select the desired builder version in your app's `manifest.json` file.\n\n| Builder version | Node.js | @types/node | TypeScript | Status |\n| --------------- | -------------------------------------------------- | ------------------------------------------------------------ | --------------------------------------------------------------------------------------- | ---------------------- |\n| 3.x | [8.x](https://read.calvincode.net/reader?url=https://nodejs.org/en/blog/release/v8.0.0) | \\- | [3.9.7](https://read.calvincode.net/reader?url=https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-9.html) | Deprecated |\n| 4.x | [12.x](https://read.calvincode.net/reader?url=https://nodejs.org/en/blog/release/v12.0.0) | \\- | [3.9.7](https://read.calvincode.net/reader?url=https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-9.html) | Deprecated |\n| 6.x | [16.x](https://read.calvincode.net/reader?url=https://nodejs.org/en/blog/release/v16.0.0) | [12.0.0](https://read.calvincode.net/reader?url=https://www.npmjs.com/package/@types/node/v/12.0.0) | [3.9.7](https://read.calvincode.net/reader?url=https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-9.html) | Active until June 2025 |\n| 7.x | [20.x](https://read.calvincode.net/reader?url=https://nodejs.org/en/blog/release/v20.0.0) | [20.0.0](https://read.calvincode.net/reader?url=https://www.npmjs.com/package/@types/node/v/20.0.0) | [5.5.3](https://read.calvincode.net/reader?url=https://www.typescriptlang.org/docs/handbook/release-notes/typescript-5-5.html) | Active |\n\n> We strongly recommend upgrading your Node app to the latest Node builder before legacy Node builder versions are deprecated. After deprecation, apps using a legacy builder version will continue to work, but you won't be able to release or publish new **major** [versions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-releasing-a-new-app-version%23understanding-app-versioning). Follow the instructions in the [Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/node-builder-7x-migration-guide) to upgrade your Node app.\n\n## Dependency compatibility\n\nWhen building Node apps, all external dependencies must be compatible with Node.js 16.x. This is the runtime version used for validation during the build process.\n\nEven if your app uses Node builder 7.x (which runs on Node.js 20.x), you still need to ensure that your libraries also support Node.js 16.x. Otherwise, the build may fail.\n\n> Always make sure that your dependencies are compatible with Node.js 16.x, even if your development environment or builder version runs on a newer runtime.\n\n## Folder structure\n\nAn app that uses the `node` builder has a `node` folder on its root, which contains the following files and directories:\n\n`1\n\nnode \n\n2\n\n ┣ 📂 clients \n\n3\n\n ┗ 📄 {ClientCodeFileName}.ts \n\n4\n\n ┣ 📂 middlewares \n\n5\n\n ┗ 📄 {MiddlewareCodeFileName}.ts \n\n6\n\n ┣ 📂 event \n\n7\n\n ┗ 📄 {EventCodeFileName}.ts \n\n8\n\n ┣ 📄 {TypeScriptCodeFileName}.ts \n\n9\n\n ┣ 📄 index.ts \n\n10\n\n ┣ 📄 package.json \n\n11\n\n ┣ 📄 service.json \n\n12\n\n ┗ 📄 tsconfig.json \n\n`\n\n* TypeScript code files (`.ts` extension) containing the core logic of the app, organized within directories such as: \n * `clients`: Directory with [Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients) code files. \n * `middlewares`: Directory with middleware code files. \n * `event`: Directory with event handler code files.\n* `index.ts`: Main TypeScript code file, where the execution begins. This file contains the service's main class.\n* `package.json`: JSON file describing dependencies, script commands for building, and version details.\n* `service.json`: Service configuration file used for defining app parameters such as routes, events, time-to-live, etc. For more details, see [Service configuration parameters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service%23service-configuration-parameters).\n* `tsconfig.json`: JSON file containing build configuration options.\n\n## Usage\n\nTo develop an app using the `node` builder, follow these steps:\n\n1. **Start with a template**: Download the [service-example template](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/service-example) or create a new project using the [vtex init CLI command](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-usage%23starting-a-new-project) and choose the `service-example` option.\n2. **Configure the `service.json` file**: Edit the `service.json` configuration file. For more information, see [Service configuration parameters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service%23service-configuration-parameters).\n3. **Configure permissions**: If you want to access external resources, add the required [policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies) for each resource in the [manifest.json](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-manifest), and the corresponding [Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients) in the code to access those resources.\n4. **Implement the app's logic**: Add the necessary TypeScript files containing the app logic.\n5. **Test**: [Link the app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app) to a development workspace for testing.\n\n> See [Engineering guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines) for guidance on scalability, performance optimization, data privacy best practices, and versioning.\n\n## Use case examples\n\nConsider the following scenarios when using the `node` builder:\n\n* **Backend service development**: If you're building backend services using Node.js, the `node` builder streamlines development with native functions and clients for integrating with the VTEX ecosystem.\n* **Event-driven applications**: For apps that rely heavily on an event-driven architecture, where actions trigger responses asynchronously, use the `node` builder to implement event handlers and listeners.\n* **Integration with external systems**: When your app needs to integrate with external systems or APIs, such as payment gateways, databases, or third-party services, the `node` builder helps you create client modules for interacting with these systems.\n* **Custom middleware**: If your app requires custom middleware for tasks like authentication, logging, or request processing, the `node` builder supports creating and integrating middleware components.\n\nBelow are some app examples that use the `node` builder:\n\n* [orders-feed-example](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/orders-feed-example)\n* [external-seller-example](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/external-seller-example)\n* [adyen-platforms](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/adyen-platforms)\n* [mega-menu](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/mega-menu)\n\nContributors\n\n4\n\n[](https://github.com/henriquessb)\n\n[](https://github.com/kaio-donadelli)\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/Reference/concepts/vtex-io-documentation-builders/vtex-io-documentation-node-builder.md)\n\n[Messages Builder« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-node-builder//docs/guides/vtex-io-documentation-messages-builder)[PaymentProvider BuilderNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-node-builder//docs/guides/vtex-io-documentation-paymentprovider-builder)\n\nContributors\n\n4\n\n[](https://github.com/henriquessb)\n\n[](https://github.com/kaio-donadelli)\n\n[](https://github.com/barbara-celi)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Versioning](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-node-builder/docs/guides/vtex-io-documentation-node-builder%23versioning)\n\n[Dependency compatibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-node-builder/docs/guides/vtex-io-documentation-node-builder%23dependency-compatibility)\n\n[Folder structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-node-builder/docs/guides/vtex-io-documentation-node-builder%23folder-structure)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-node-builder/docs/guides/vtex-io-documentation-node-builder%23usage)\n\n[Use case examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-node-builder/docs/guides/vtex-io-documentation-node-builder%23use-case-examples)\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-node-builder.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Versioning](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-node-builder/docs/guides/vtex-io-documentation-node-builder%23versioning)\n\n[Dependency compatibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-node-builder/docs/guides/vtex-io-documentation-node-builder%23dependency-compatibility)\n\n[Folder structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-node-builder/docs/guides/vtex-io-documentation-node-builder%23folder-structure)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-node-builder/docs/guides/vtex-io-documentation-node-builder%23usage)\n\n[Use case examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-node-builder/docs/guides/vtex-io-documentation-node-builder%23use-case-examples)\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_802007d0
|
[
{
"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 punchout 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/punchout/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/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/punchout/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/punchout/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/punchout/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/punchout/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/punchout/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/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/punchout/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/punchout)\n\n[Punchout login integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/punchout-login-integration)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/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/punchout/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/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/punchout/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/punchout/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/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/punchout/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/punchout)\n\n[Punchout login integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/punchout-login-integration)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/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/punchout/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/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/punchout/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/punchout/docs/guides)\n\nIntegration Guides\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/punchout)\n\nPunchout\n\nLearn how punchout enables seamless integration between eprocurement systems and supplier ecommerce sites for efficient B2B purchasing.\n\nB2B ecommerce refers to online transactions between businesses, such as a retailer purchasing inventory from a wholesaler. These transactions often involve negotiated pricing, approval workflows, and integration with eprocurement systems.\n\nOne common feature in B2B ecommerce is punchout, which allows companies to connect their eprocurement systems directly to a supplier’s ecommerce website in the B2B context.\n\nAn eprocurement system is a software that companies use to manage and automate the purchasing of goods and services. It typically includes tools for managing suppliers, generating and approving purchase orders (POs), and integrating with financial and inventory systems.\n\nThis real-time connection with supplier websites through punchout enables employees to access a supplier's storefront from within their eprocurement system without needing to log in or register manually, streamlining the B2B purchasing experience.\n\nWhen an employee \"punches out\" to a supplier’s site, they're automatically authenticated and redirected to a personalized shopping experience tailored to their organization’s commercial agreement. This includes customized catalogs, pricing, and shipping terms.\n\n> Not all purchases made through eprocurement systems use punchout. However, when punchout is available, it provides users with seamless access to a preferred supplier's store while preserving the internal procurement process for approvals and record-keeping.\n\n## Punchout flow\n\nHere's an overview of a typical punchout workflow:\n\n\n\n1. **Login:** An employee logs in to their company’s eprocurement system and selects a supplier ecommerce website to \"punch out\" to (typically by clicking the supplier’s logo).\n2. **Browsing and adding items:** The employee is redirected to the supplier’s ecommerce website and automatically logged in using the credentials provided by the eprocurement system. \nThe supplier’s ecommerce website may be customized for the employee’s company, with a unique homepage, product selection, and pricing based on the applicable trade policy. \nThe employee can browse or search the supplier’s catalog and add items to their shopping cart.\n3. **Checkout:** The employee clicks the checkout button on the supplier's site and is redirected to their eprocurement system. Rather than going through the regular checkout flow on the supplier's site, the shopping cart is sent back to the eprocurement system.\n4. **Purchase order:** The employee can create a purchase order from the cart in their eprocurement system and submit it for approval.\n\n## Benefits of punchout\n\nPunchout integration in eprocurement systems offers multiple benefits, as highlighted below:\n\n* **Improved efficiency:** Punchout simplifies the buying process, allowing procurement teams to work within their existing systems while accessing real-time, accurate supplier catalogs.\n* **Enhanced user experience:** Unlike traditional eprocurement systems, which often have limited interfaces, punchout leverages the supplier’s ecommerce storefront to offer a richer, more intuitive shopping experience.\n* **Dynamic, customized content:** Suppliers can present personalized catalogs, pricing, and content based on individual agreements with each buyer. This is especially useful for large or frequently changing inventories.\n* **Seamless integration:** Punchout supports a smooth transition between the eprocurement system and the ecommerce platform, ensuring consistent record-keeping and reducing manual steps in the purchasing process.\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/punchout/punchout.md)\n\n[Webstore (OAuth 2.0)« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout//docs/guides/login-integration-guide-webstore-oauth2)[Punchout login integrationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout//docs/guides/punchout-login-integration)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Punchout flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/punchout%23punchout-flow)\n\n[Benefits of punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/punchout%23benefits-of-punchout)\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/punchout/punchout.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Punchout flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/punchout%23punchout-flow)\n\n[Benefits of punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/punchout%23benefits-of-punchout)\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_2df25cbe
|
[
{
"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 i cant update the ean of my skus via api in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-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/troubleshooting/i-cant-update-the-ean-of-my-skus-via-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/troubleshooting/i-cant-update-the-ean-of-my-skus-via-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/troubleshooting/i-cant-update-the-ean-of-my-skus-via-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/troubleshooting/i-cant-update-the-ean-of-my-skus-via-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/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/updates/release-notes)\n\nTroubleshooting\n\nAPI\n\n[I can't update the EAN of my SKUs via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api)\n\n---\n\nDevelopment\n\n---\n\nStore performance\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/updates/release-notes)\n\nTroubleshooting\n\nAPI\n\n[I can't update the EAN of my SKUs via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api)\n\n---\n\nDevelopment\n\n---\n\nStore performance\n\n---\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/troubleshooting)\n\nAPI\n\nI can't update the EAN of my SKUs via API\n\nUpdating EANs in VTEX can lead to catalog sync issues affecting inventory.\n\n**Keywords:** SKU, product, EAN, catalog\n\nWhen trying to update the EAN (European Article Number), which contains the barcode information for a SKU, you may face issues with catalog synchronization between the VTEX Admin and API. This can impact inventory management and customer experience.\n\n## Solution\n\nTo solve this issue, consider [deleting the SKU EAN](#deleting-the-sku-ean) and then [adding a new EAN](#step-1---add-a-new-ean-to-the-sku).\n\n### Deleting the SKU EAN\n\nTo update the current SKU EAN, you must first delete all the EAN values associated with the SKU.\n\n* [Delete SKU EAN](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/stockkeepingunit/-skuId-/ean/-ean-): Use the endpoint to delete a specific EAN.\n* [Delete all SKU EAN values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/stockkeepingunit/-skuId-/ean): Use the endpoint to delete all the EANs associated with the SKU.\n\n#### Step 1 - Add a new EAN to the SKU\n\nOnly after all previous EANs have been deleted can you add a new EAN to the SKU. To do this, use the [Create SKU EAN](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit/-skuId-/ean/-ean-) endpoint to create the new EAN value.\n\n#### Step 2 - Check whether the SKU EAN has been updated\n\nAfter adding the new EAN, use the [Get SKU by EAN](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/sku/stockkeepingunitbyean/-ean-) endpoint to confirm it has been updated. The new EAN values will be displayed in the `AlternateIdValues` array.\n\n`1\n\n\"AlternateIdValues\": \n\n2\n\n[ \n\n3\n\n\"8781\", \n\n4\n\n\"878181\" \n\n5\n\n] \n\n`\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/api/i-cant-update-the-ean-of-my-skus-via-api.mdx)\n\n[Getting started with Lighthouse« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/troubleshooting/storefront-getting-started-with-lighthouse)[I am getting 500 errors in VTEX IO CLINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api%23solution)\n\n[Deleting the SKU EAN](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api%23deleting-the-sku-ean)\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/api/i-cant-update-the-ean-of-my-skus-via-api.mdx)\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/i-cant-update-the-ean-of-my-skus-via-api/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api%23solution)\n\n[Deleting the SKU EAN](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api%23deleting-the-sku-ean)\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_e62abe0d
|
[
{
"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 sessions system 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/sessions-system-overview/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-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/sessions-system-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/sessions-system-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/sessions-system-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/sessions-system-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/sessions-system-overview/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/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/sessions-system-overview/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/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/sessions-system-overview/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n[Sessions System Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview)\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/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/sessions-system-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/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/sessions-system-overview/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/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/sessions-system-overview/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n[Sessions System Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview)\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/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/sessions-system-overview/docs/guides)\n\nVTEX Session\n\n[Sessions System Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview)\n\nSessions System Overview\n\nVTEX’s Sessions System is an architecture that allows stores to handle complex B2B scenarios, regionalize customer experience and perform promotion segmentation by Campaign Audiences.\n\n## How it works\n\nThe Sessions System operates using two cookies: `vtex_session` and `vtex_segment`. Learn how they work in the following sections.\n\n### `vtex_session` cookie\n\nThrough the `vtex_session` cookie, the Sessions System identifies the information of a specific session of a user browsing in your store.\n\nIt is possible to see session properties by making a request to `GET` `https://{{accountname}}.{{environment}}.com.br/api/sessions?items={{namespace}}.{{value}},{{namespace}}.{{value2}}`.\n\nThe API returns several **namespaces**, which are the keys that group together certain types of information about the session.\n\nBelow, see a response example with basic data on a session:\n\n`1\n\n{ \n\n2\n\n \"id\": \"840f8910-eb3b-4f25-8d51-a06445317906\", \n\n3\n\n \"namespaces\": { \n\n4\n\n \"account\": { \n\n5\n\n \"id\": { \n\n6\n\n \"value\": \"0e914df8-c516-45bc-a45a-0aab6482eaf7\", \n\n7\n\n \"keepAlive\": true \n\n8\n\n }, \n\n9\n\n \"accountName\": { \n\n10\n\n \"value\": \"qamarketplace\" \n\n11\n\n } \n\n12\n\n }, \n\n13\n\n \"store\": { \n\n14\n\n \"channel\": { \n\n15\n\n \"value\": \"1\" \n\n16\n\n } \n\n17\n\n }, \n\n18\n\n \"impersonate\": { \n\n19\n\n \"canImpersonate\": { \n\n20\n\n \"value\": \"false\" \n\n21\n\n } \n\n22\n\n }, \n\n23\n\n \"profile\": { \n\n24\n\n \"isAuthenticated\": { \n\n25\n\n \"value\": \"false\" \n\n26\n\n } \n\n27\n\n } \n\n28\n\n }, \n\n29\n\n \"version\": 1, \n\n30\n\n \"active\": true, \n\n31\n\n \"debug\": false \n\n32\n\n} \n\n`\n\nBelow you will find a list of possible namespaces that can be returned by the API:\n\n* `account`: Namespace with account information where the session is happening.\n* `checkout`: Namespace with information related to checkout, such as session cart ID (`cartId`) and region (`regionId`) that the checkout returns to identify the geographic location of the user browsing this session.\n* `store`: Namespace with information about the current sales channel of the session.\n* `cookie`: Namespace with information on the authentication cookies of the user.\n* `impersonate`: Namespace that identifies if the logged in user has permission to impersonate another user and browse on that user’s behalf.\n* `profile`: Namespace with information related to the customer’s profile logged into that session. Eligible price tables for that customer are listed in this namespace.\n* `public`: Namespace with general information on a session, `utm_campaign`, `utm_source` and `utmi_campaign`. In this namespace, we also find `postalCode` or `geoCoordinates` and `country`, which are given to VTEX’s checkout so that it can return the `regionId`, require in the namespace `checkout`. These values follow the format defined in the [Checkout API reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pub/regions/-regionId-).\n* `authentication`: Namespace with user authentication data in the context of the session.\n* `rnb`: Namespace that gives information related to applicable Campaign Audiences and promotions for that session.\n\n### `vtex_segment` cookie\n\nThe Sessions System also creates the `vtex_segment` cookie, which contains the information of the commercial conditions to be applied to a session.\n\nIt is possible to see the properties of a segment by making a `GET` request to `https://{{accountName}}.{{environment}}.com.br/api/segments/{{segmentToken}}`.\n\nBelow you will find a response example with data from a segment:\n\n`1\n\n{ \n\n2\n\n \"campaigns\": \"vip\", \n\n3\n\n \"channel\": \"1\", \n\n4\n\n \"priceTables\": \"gold\", \n\n5\n\n \"regionId\": \"U1cj\", \n\n6\n\n \"utm_campaign\": \"black friday\", \n\n7\n\n \"utm_source\": \"google\", \n\n8\n\n \"utmi_campaign\": \"banner\" \n\n9\n\n} \n\n`\n\n> The session identified by the `vtex_session` cookie is individual. However, the `vtex_segment`cookie uses information that can be shared among different users. For example: the same price table can be available to different users in distinct sessions. This way, `vtex_segment` is used to control the cache key of the pages.\n\n## Changing information from a session\n\nIt is possible to change a session’s information by making a `POST` request to the following route:\n\n`https://{{account-name}}.{{environment}}.com.br/api/sessions/{{session_token}}`\n\nBelow you can see an example of a request body used to update the information of a session:\n\n`1\n\n{ \n\n2\n\n \"public\": { \n\n3\n\n \"utm_campaign\": { \n\n4\n\n \"value\": \"Black Friday\" \n\n5\n\n }, \n\n6\n\n \"country\": { \n\n7\n\n \"value\": \"USA\" \n\n8\n\n }, \n\n9\n\n \"postalCode\": { \n\n10\n\n \"value\": \"05408000\" \n\n11\n\n } \n\n12\n\n } \n\n13\n\n} \n\n`\n\n## Main features related to the Sessions System\n\n### Price tables\n\nPrice tables are identified by the sessions system in the namespace `profile`. Each price table displays customized prices for that identified user that is browsing in the store. You can create price tables for specific customer groups. Price tables can by used to handle B2B scenarios.\n\nLearn more about [Configuring price tables for specific users](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/setting-up-price-tables-for-specific-users--5S9oDOMHNmY4K0kAewAiWY).\n\n### Region\n\nThe Region feature is identified by the sessions system in the namespace `checkout`, with the `regionId` property, which is generated when a `postalCode` or `geoCoordinates` and a `country` are added to a session. The feature's goal is to regionalize the experience of the user in the store.\n\nIt allows, for example, sellers to configure their own prices and marketplaces to be displayed according to the customer's region.\n\nTo configure price and availability according to the customer’s region, access our article about [setting up SKU price and availability by Region](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/setting-up-price-and-availability-of-skus-by-region--12ne58BmvYsYuGsimmugoc).\n\n### Campaign audiences\n\nCampaign Audiences are clustering rules that allow promotions to be applied to customers that meet a set of criteria.\n\nThe campaign audiences feature works much like price tables. In the **Promotions & Taxes** module, you can create conditions that apply a promotion to a particular customer if campaign conditions are met.\n\nLearn more about [Campaign Audiences](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/campaign-audiences--3o7lhpNseXY2WmjZO0gQ6m).\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/VTEX-Session/sessions-system-overview.md)\n\n[Conversion« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview//docs/guides/conversion)[Managing SSL CertificatesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview//docs/guides/managing-ssl-certificates)\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[How it works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23how-it-works)\n\n[vtex\\_session cookie](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23vtexsession-cookie)[vtex\\_segment cookie](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23vtexsegment-cookie)\n\n[Changing information from a session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23changing-information-from-a-session)\n\n[Main features related to the Sessions System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23main-features-related-to-the-sessions-system)\n\n[Price tables](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23price-tables)[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23region)[Campaign audiences](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23campaign-audiences)\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-Session/sessions-system-overview.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[How it works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23how-it-works)\n\n[vtex\\_session cookie](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23vtexsession-cookie)[vtex\\_segment cookie](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23vtexsegment-cookie)\n\n[Changing information from a session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23changing-information-from-a-session)\n\n[Main features related to the Sessions System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23main-features-related-to-the-sessions-system)\n\n[Price tables](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23price-tables)[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23region)[Campaign audiences](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23campaign-audiences)\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_9081fd72
|
[
{
"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 admin customers 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-admin-customers/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/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-admin-customers/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-admin-customers/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-admin-customers/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-admin-customers/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-admin-customers/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/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-admin-customers/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-admin-customers/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/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-admin-customers/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-admin-customers/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-admin-customers/docs/vtex-io-apps)\n\nAdmin Customers\n\nOfficial extension\n\nVersion: 2.18.2\n\nLatest version: 2.18.2\n\n> This app is no longer maintained by VTEX. This means support and maintenance are no longer provided.\n\n> To continue using the B2B Suite, it is important to install the [VTEX B2B Admin Customers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers).\n\n# Customers Admin\n\nA VTEX admin app that helps manage your customer data. This application allows users to create, edit, and search for customers. It's an alternative to MasterData when it comes to managing the documents from the CL entity.\n\nThe [vtex.admin-customers-graphql](https://read.calvincode.net/reader?url=https://github.com/vtex/admin-customers-graphql) depends on this application. Its responsibility is to group all the GraphQL queries and mutations needed to manage MasterData data.\n\n## 🚀 Installation\n\nUsing the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/development/vtex-io-cli-installation-and-command-reference/%23command-reference), log into the VTEX account you are working on and install the latest version:\n\n`1\n\nvtex install vtex.admin-customers \n\n`\n\nAfter installing the app, you can find it in the Admin at **Customers > Customers**.\n\n## ✅ Features\n\nThe list below presents every feature of this application, where the checked ones have already been implemented. The features that are yet to come are unchecked.\n\n> Please, whenever a new feature from the list below is implemented, mind-marking the checkbox and create a feature demo.\n\n* [Listing](#listing)\n* [Memorize visibility fields](#memorize-visibility-fields)\n* [Search](#search)\n* [Filters](#filters)\n* [Creation](#creation)\n* [Details view](#details-view)\n* [Edition](#edition)\n* Deletion of profile (GDPR/LGPD)\n* Address association listing\n* Schema viewing with user-level configuration\n* Counters\n\n## 🎥 Demonstration\n\n**Listing** \n\n\n\n**Memorize visibility fields** \n\nThe visibility fields is a feature to toggle visibility of table columns.\n\nHere we have an additional feature that saves the preferred column visibility configuration of the end user, maintaining your configurations even after a page refresh and future visits to this page.\n\n\n\n**Search** \n\nThe search input uses the fields: **E-mail**, **First Name** or **Last Name** to filter the results that matches the terms searched while also displaying the results on the table.\n\n\n\n**Filters** \n\nWith these filters, it is possible to refine your search. You can filter by: **E-mail**, **First Name**, **Last Name**, **Document ID**, **Document** or **Receive Newsletter**.\n\nEvery filter has conditionals for you to choose from; it could be **equal**, **not equal**, or **contains**.\n\n **Creation** \n\n\n\n**Details view**  **Edition** \n\n\n\n## ☕ Developing\n\n1. Clone this repo `git clone https://github.com/vtex/admin-customers`\n2. `yarn --cwd react/` for code completion\n3. `vtex link`\n4. Navigate to `workspace--account.myvtex.com/admin/app/example`\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[Customers Admin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/docs/apps/vtex.admin-customers%23customers-admin)\n\n[🚀 Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/docs/apps/vtex.admin-customers%23-installation)\n\n[✅ Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/docs/apps/vtex.admin-customers%23-features)\n\n[🎥 Demonstration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/docs/apps/vtex.admin-customers%23-demonstration)\n\n[☕ Developing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/docs/apps/vtex.admin-customers%23-developing)\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_78f17148
|
[
{
"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 import customer data in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/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/import-customer-data/docs/guides/erp-integration-guide)\n\n[Set up catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/erp-integration-set-up-catalog)\n\n[Import prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/erp-integration-import-prices)\n\n[Import inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/erp-integration-import-inventory)\n\n[Import customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data)\n\n[Set up order integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/erp-integration-set-up-order-integration)\n\n[Import products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/erp-integration-import-products)\n\n[Set up order processing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/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/import-customer-data/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/import-customer-data/docs/guides/faq-erp-integration)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/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/import-customer-data/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/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/import-customer-data/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/import-customer-data/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/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/import-customer-data/docs/guides/erp-integration-guide)\n\n[Set up catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/erp-integration-set-up-catalog)\n\n[Import prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/erp-integration-import-prices)\n\n[Import inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/erp-integration-import-inventory)\n\n[Import customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data)\n\n[Set up order integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/erp-integration-set-up-order-integration)\n\n[Import products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/erp-integration-import-products)\n\n[Set up order processing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/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/import-customer-data/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/import-customer-data/docs/guides/faq-erp-integration)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/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/import-customer-data/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/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/import-customer-data/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/import-customer-data/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/import-customer-data/docs/guides/erp-integration-guide)\n\n[Import customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data)\n\nImport 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\nThe **Checkout** module stores shopper data in [**Master Data v1**](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw) by default. Because of this, using the [**Master Data v1** API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api) is the best way to integrate your customer database into VTEX.\n\nIn this guide, you can learn how to import customer data to VTEX. Learn more about Master Data and its features in the [Master Data developers guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works).\n\n> Importing your customers' data will also enable automatic fill-in at checkout for those customers. Learn more about [SmartCheckout - Customer information automatic fill-in](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/smartcheckout-preenchimento-automatico-de-dados-do-cliente--2Nuu3xAFzdhIzJIldAdtan%23)\n\n## Data entities\n\n**Master Data v1** leverages the concept of [data entities](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw%23data-entities) to allow for highly customizable databases. These work as tables, where each document (profile or address) is saved as a row.\n\nThere are two native data entities you must use for this integration:\n\n* `CL`: shopper profiles.\n* `AD`: shopper addresses.\n\n## Integration\n\nThe basic operations you will need to import customer data are:\n\n* [creating new customer profiles](#create-new-customer-profile).\n* [creating addresses](#create-new-address).\n\nDepending on your project’s architecture, it may also be important to:\n\n* [Retrieve customer data](#retrieve-customer-data).\n* [Edit customer data](#edit-customer-data).\n\n### Create new customer profile\n\nTo register a new customer profile, use the [Create new document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23post-/api/dataentities/-acronym-/documents) for the `CL` data entity.\n\n> When creating a new document, you will receive an `Id` in the response. This identifies the customer in Master Data and will be used later to register addresses associated with that customer. Make sure you save this ID and associate it with the customer’s ID in your source database.\n\n#### Creating customer profile request example\n\nPOST\n\n`1\n\nhttps://{accountName}.{environment}.com.br/api/dataentities/CL/documents \n\n`\n\nRequest body\n\n`1\n\n{ \n\n2\n\n \"email\": \"clark.kent@examplemail.com\", \n\n3\n\n \"firstName\": \"Clark\", \n\n4\n\n \"lastName\": \"Kent\", \n\n5\n\n \"phone\": \"+12025550195\", \n\n6\n\n \"documentType\": \"CPF\", \n\n7\n\n \"document\": \"12345678900\", \n\n8\n\n \"isCorporate\": false, \n\n9\n\n \"isNewsletterOptIn\": false, \n\n10\n\n \"localeDefault\": \"en-US\" \n\n11\n\n} \n\n`\n\nResponse\n\n`1\n\n{ \n\n2\n\n \"Id\": \"CL-b345cbda-e489-11e6-94f4-0ac138d2d42e\", \n\n3\n\n \"Href\": \"http://api.vtex.com/my-store-name/dataentities/CL/documents/b345cbda-e489-11e6-94f4-0ac138d2d42e\" \n\n4\n\n} \n\n`\n\n### Create new address\n\nTo register a new customer address, use the [Create new document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23post-/api/dataentities/-acronym-/documents) for the `AD` data entity.\n\n> Note that the `userId` in the request body is the `Id` returned by the API when [creating a customer profile](#create-new-customer-profile). Make sure to send it to associate the address with the corresponding customer.\n\n#### Creating new address request example\n\nPOST\n\n`1\n\nhttps://{accountName}.{environment}.com.br/api/dataentities/AD/documents \n\n`\n\nRequest body\n\n`1\n\n{ \n\n2\n\n \"addressName\": \"My House\", \n\n3\n\n \"addressType\": \"residential\", \n\n4\n\n \"city\": \"Metropolis\", \n\n5\n\n \"complement\": \"\", \n\n6\n\n \"country\": \"USA\", \n\n7\n\n \"postalCode\": \"11375\", \n\n8\n\n \"receiverName\": \"Clark Kent\", \n\n9\n\n \"reference\": null, \n\n10\n\n \"state\": \"MP\", \n\n11\n\n \"street\": \"Baker Street\", \n\n12\n\n \"neighborhood\": \"Upper east side\", \n\n13\n\n \"number\": \"21\", \n\n14\n\n \"userId\": \"7e03m794-a33a-11e9-84rt6-0adfa64s5a8e\" \n\n15\n\n} \n\n`\n\n### Retrieve customer data\n\nIf you need to retrieve customer information after you have imported it to VTEX, you can use one of these endpoints:\n\n* [Search documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23get-/api/dataentities/-acronym-/search): more direct solution for fetching a single document, while also being able to return multiple results.\n* [Scroll documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23get-/api/dataentities/-acronym-/scroll): useful if you want to fetch multiple documents spread across multiple requests.\n\n> These requests allow you to filter and sort data by any of the documents’ fields. You can also request that only certain pieces of information be returned, instead of the complete documents. See [Search documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23get-/api/dataentities/-acronym-/search) and [Scroll documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23get-/api/dataentities/-acronym-/scroll) to learn more.\n\n## Edit customer data\n\nOnce your store is up and running, your customers can update their profile information in the [My Account](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-does-my-account-work--2BQ3GiqhqGJTXsWVuio3Xh%23) section and it will be automattically updated in the documents you have created with the Master Data v1 API. So many integrations will not have to deal with customer data maintenance.\n\nHowever, if you need to implement such an integration, you can use the [Update partial document API endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23patch-/api/dataentities/-acronym-/documents/-id-).\n\n### Updating customer profile request example\n\n`1\n\nPATCH \n\n2\n\nhttps://{accountName}.{environment}.com.br/api/dataentities/CL/documents/{id} \n\n`\n\nRequest body\n\n`1\n\n{ \n\n2\n\n \"phone\": \"+12025550195\", \n\n3\n\n \"isNewsletterOptIn\": false \n\n4\n\n} \n\n`\n\n### Updating address request example\n\n`1\n\nPATCH \n\n2\n\nhttps://{accountName}.{environment}.com.br/api/dataentities/AD/documents/{id} \n\n`\n\nRequest body\n\n`1\n\n{ \n\n2\n\n \"street\": \"Market Street\", \n\n3\n\n \"neighborhood\": \"South side\", \n\n4\n\n \"number\": \"27\", \n\n5\n\n} \n\n`\n\nContributors\n\n2\n\n[](https://github.com/PedroAntunesCosta)\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/import-customer-data.md)\n\n[Import inventory« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data//docs/guides/erp-integration-import-inventory)[Set up order integrationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data//docs/guides/erp-integration-set-up-order-integration)\n\nContributors\n\n2\n\n[](https://github.com/PedroAntunesCosta)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Data entities](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data%23data-entities)\n\n[Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data%23integration)\n\n[Create new customer profile](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data%23create-new-customer-profile)[Create new address](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data%23create-new-address)[Retrieve customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data%23retrieve-customer-data)\n\n[Edit customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data%23edit-customer-data)\n\n[Updating customer profile request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data%23updating-customer-profile-request-example)[Updating address request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data%23updating-address-request-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/Integration-Guides/erp-integration-guide/import-customer-data.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Data entities](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data%23data-entities)\n\n[Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data%23integration)\n\n[Create new customer profile](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data%23create-new-customer-profile)[Create new address](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data%23create-new-address)[Retrieve customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data%23retrieve-customer-data)\n\n[Edit customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data%23edit-customer-data)\n\n[Updating customer profile request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data%23updating-customer-profile-request-example)[Updating address request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data%23updating-address-request-example)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_71fe82ae
|
[
{
"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 synchronizing the catalog with vtex ads 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/synchronizing-the-catalog-with-vtex-ads/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/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/synchronizing-the-catalog-with-vtex-ads/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/synchronizing-the-catalog-with-vtex-ads/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/synchronizing-the-catalog-with-vtex-ads/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/synchronizing-the-catalog-with-vtex-ads/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/synchronizing-the-catalog-with-vtex-ads/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/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/synchronizing-the-catalog-with-vtex-ads/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/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/synchronizing-the-catalog-with-vtex-ads/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/vtex-ads)\n\n[Getting started with VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/getting-started-with-vtex-ads-api)\n\n[Synchronizing the catalog with VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/synchronizing-the-catalog-with-vtex-ads)\n\n[Synchronizing product information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/synchronizing-product-information)\n\n[Synchronizing inventory information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/synchronizing-inventory-information)\n\n[Retrieving ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/retrieving-ads)\n\n[Ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/ads-events)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/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/synchronizing-the-catalog-with-vtex-ads/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/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/synchronizing-the-catalog-with-vtex-ads/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/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/synchronizing-the-catalog-with-vtex-ads/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/vtex-ads)\n\n[Getting started with VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/getting-started-with-vtex-ads-api)\n\n[Synchronizing the catalog with VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/synchronizing-the-catalog-with-vtex-ads)\n\n[Synchronizing product information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/synchronizing-product-information)\n\n[Synchronizing inventory information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/synchronizing-inventory-information)\n\n[Retrieving ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/retrieving-ads)\n\n[Ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/ads-events)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/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/synchronizing-the-catalog-with-vtex-ads/docs/guides)\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/vtex-ads)\n\n[Getting started with VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/getting-started-with-vtex-ads-api)\n\n[Synchronizing the catalog with VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/synchronizing-the-catalog-with-vtex-ads)\n\nSynchronizing the catalog with VTEX Ads\n\nSynchronize your product catalog with VTEX Ads to keep product information and inventory data up to date.\n\nTo activate your VTEX Ads integration, the first step is to synchronize your product catalog. This ensures that product and inventory data is available for campaign creation and conversion tracking.\n\nCatalog data is essential for:\n\n* Enabling advertisers to select products for **Product Ads** campaigns.\n* Supporting conversion attribution for both **Product Ads** and **Banner Ads**.\n\nCatalog synchronization is divided into two stages:\n\n1. [Product information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information) \nSend relevant product attributes such as name, image, brand, and price to VTEX Ads so they can be accurately represented in ads and used for targeting and reporting.\n2. [Inventory information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information) \nKeep stock levels updated to ensure ads are only shown for available products and campaigns reflect real-time inventory.\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX Ads/getting-started-with-vtex-ads-api/synchronizing-the-catalog-with-vtex-ads.md)\n\n[Getting started with VTEX Ads API« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads//docs/guides/getting-started-with-vtex-ads-api)[Synchronizing product informationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads//docs/guides/synchronizing-product-information)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX Ads/getting-started-with-vtex-ads-api/synchronizing-the-catalog-with-vtex-ads.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_612bf0c4
|
[
{
"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 development workspace 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-development-workspace/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-development-workspace/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-development-workspace/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-development-workspace/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-development-workspace/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-development-workspace/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-development-workspace/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-creating-a-development-workspace/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-creating-a-development-workspace/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-creating-a-development-workspace/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-creating-a-development-workspace/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-creating-a-development-workspace/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/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-creating-a-development-workspace/docs/guides/vtex-io-documentation-workspace)\n\n[Creating a Development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/docs/guides/vtex-io-documentation-creating-a-development-workspace)\n\n[Creating a Development workspace for a Legacy CMS store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/docs/guides/vtex-io-documentation-creating-development-workspace-for-cms-legacy)\n\n[Creating a Production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/docs/guides/vtex-io-documentation-creating-a-production-workspace)\n\n[Workspace behavior with app installations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations)\n\n[Best practices on workspaces management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/docs/guides/vtex-io-documentation-workspaces-best-practices)\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-creating-a-development-workspace/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-creating-a-development-workspace/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-creating-a-development-workspace/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-creating-a-development-workspace/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/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-creating-a-development-workspace/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-creating-a-development-workspace/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-creating-a-development-workspace/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-creating-a-development-workspace/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/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-development-workspace/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/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-development-workspace/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-creating-a-development-workspace/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-creating-a-development-workspace/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-creating-a-development-workspace/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-creating-a-development-workspace/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-creating-a-development-workspace/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/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-creating-a-development-workspace/docs/guides/vtex-io-documentation-workspace)\n\n[Creating a Development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/docs/guides/vtex-io-documentation-creating-a-development-workspace)\n\n[Creating a Development workspace for a Legacy CMS store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/docs/guides/vtex-io-documentation-creating-development-workspace-for-cms-legacy)\n\n[Creating a Production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/docs/guides/vtex-io-documentation-creating-a-production-workspace)\n\n[Workspace behavior with app installations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations)\n\n[Best practices on workspaces management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/docs/guides/vtex-io-documentation-workspaces-best-practices)\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-creating-a-development-workspace/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-creating-a-development-workspace/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-creating-a-development-workspace/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-creating-a-development-workspace/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/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-creating-a-development-workspace/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-creating-a-development-workspace/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-creating-a-development-workspace/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-creating-a-development-workspace/docs/app-development)\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/docs/guides/vtex-io-documentation-workspace)\n\n[Creating a Development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/docs/guides/vtex-io-documentation-creating-a-development-workspace)\n\nCreating a Development workspace\n\nLearn how to create and use a Development workspace.\n\nDevelopment [workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/) allow you to [link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/), [publish](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/), and [install](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/) apps. These workspaces provide greater freedom in code development without affecting user traffic and the live store.\n\nSince Development workspaces operate in isolation from user traffic, they are ideal for making code changes. Note: Development workspaces cannot be [promoted to Master](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master/) or used for [A/B testing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing/); these capabilities are reserved for [Production workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace/).\n\n## Instructions\n\n1. [Log in to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference) the desired VTEX account.\n2. Create a development workspace by running the following command: \n`1 \nvtex use {workspaceName} \n` \n> Replace `{workspaceName}` according to your scenario.\n\n## Next steps\n\nEmbark on your development journey by creating a new app using our [template apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/code-samples) or [build from scratch](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-getting-started). [Link your app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/) and initiate the development process. Once satisfied with the changes in your Development workspace, change to the next phase by creating a [Production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace). This step ensures comprehensive testing of your modifications under real user traffic conditions.\n\n## Deleting a workspace\n\nYou can manually delete workspaces that are no longer in use by running the following command:\n\n`1\n\nvtex workspace delete {workspaceName} \n\n`\n\n> Deleting a workspace is irreversible, and its content cannot be restored.\n\n## Development workspace behavior\n\nIn Development workspaces, certain actions are permitted while others are restricted to maintain stability and reliability. Here is a summary of allowed and restricted actions:\n\n| Action | Allowed |\n| ------------------------------------------------------------------------------------------------------------------- | ------- |\n| [Install apps.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app) | ✅ |\n| [Run A/B tests.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing) | ❌ |\n| Handle traffic. | ❌ |\n| [Promote to master.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master) | ❌ |\n| App development. | ✅ |\n| [Link an app.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app) | ✅ |\n| [Publish an app.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app) | ✅ |\n\n## Key considerations\n\n* **Workspace inheritance:** Production workspaces are initiated independently and do not inherit code changes from a [Development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace). Therefore, any modifications made in a Development workspace must be manually replicated to the new Production workspace.\n* **Data persistency:** Workspace settings persist unless conflicts arise with the Master workspace. In such cases, Master settings take precedence over settings in other workspaces, including the Development ones.\n* **Expiration:** Once created, Production workspaces have no expiration date.\n* **Deletion:** Unused workspaces are not automatically deleted. Manually deleting unused workspaces is recommended to optimize platform resources and maintain an efficient operational state.\n* **Organization:** Maintain a concise list of workspaces for organizational and resource efficiency reasons.\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/configuring-workspaces/vtex-io-documentation-creating-a-development-workspace.md)\n\n[Workspace« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace//docs/guides/vtex-io-documentation-workspace)[Creating a Development workspace for a Legacy CMS storeNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace//docs/guides/vtex-io-documentation-creating-development-workspace-for-cms-legacy)\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-development-workspace/docs/guides/vtex-io-documentation-creating-a-development-workspace%23instructions)\n\n[Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/docs/guides/vtex-io-documentation-creating-a-development-workspace%23next-steps)\n\n[Deleting a workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/docs/guides/vtex-io-documentation-creating-a-development-workspace%23deleting-a-workspace)\n\n[Development workspace behavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/docs/guides/vtex-io-documentation-creating-a-development-workspace%23development-workspace-behavior)\n\n[Key considerations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/docs/guides/vtex-io-documentation-creating-a-development-workspace%23key-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/guides/vtex-io/App-Guides/configuring-workspaces/vtex-io-documentation-creating-a-development-workspace.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-development-workspace/docs/guides/vtex-io-documentation-creating-a-development-workspace%23instructions)\n\n[Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/docs/guides/vtex-io-documentation-creating-a-development-workspace%23next-steps)\n\n[Deleting a workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/docs/guides/vtex-io-documentation-creating-a-development-workspace%23deleting-a-workspace)\n\n[Development workspace behavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/docs/guides/vtex-io-documentation-creating-a-development-workspace%23development-workspace-behavior)\n\n[Key considerations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace/docs/guides/vtex-io-documentation-creating-a-development-workspace%23key-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_d4162faa
|
[
{
"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 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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-getting-started-with-lighthouse/docs/guides/storefront-best-practices)\n\n[Accessibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-getting-started-with-lighthouse/docs/guides/storefront-accessibility)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-getting-started-with-lighthouse/docs/guides/storefront-analytics)\n\n[Performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-getting-started-with-lighthouse/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-getting-started-with-lighthouse/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-getting-started-with-lighthouse/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-getting-started-with-lighthouse/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-getting-started-with-lighthouse/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-getting-started-with-lighthouse/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-getting-started-with-lighthouse/docs/guides/storefront-best-practices)\n\n[Accessibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-getting-started-with-lighthouse/docs/guides/storefront-accessibility)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-getting-started-with-lighthouse/docs/guides/storefront-analytics)\n\n[Performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-getting-started-with-lighthouse/docs/storefront-development)\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-getting-started-with-lighthouse/docs/guides/storefront-best-practices)\n\n[Performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-getting-started-with-lighthouse//docs/guides/storefront-performance)[SEONext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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/vtex-io-documentation-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_7ec5adb9
|
[
{
"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 customizer 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-customizer/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-customizer/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/guides/basic-components)\n\nProduct Customizer\n\nOfficial extension\n\nVersion: 2.12.4\n\nLatest version: 2.12.4\n\n[](#contributors-)\n\nThe Product Customizer component can be used on the Product Details Page (PDP) to display [attachments](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/o-que-e-um-anexo--aGICk0RVbqKg6GYmQcWUm) and/or a [subscription form](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-subscriptions-work--frequentlyAskedQuestions%5F4453).\n\nAn attachment is the optional and cost-free customization of a product.\n\n\n\n_Example of a PDP with the Product Customizer component displaying product attachments._ \n\nProduct subscriptions facilitate recurring sales by automatically scheduling the purchase of a specific product at the frequency requested by the customer.\n\n\n\n_Example of a PDP with the Product Customizer component displaying the product subscription._ \n\n## Before you start\n\n* If you plan to use the Product Customizer component to display **attachments**, make sure to [set up Assembly Options.](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH)\n* If you plan to use the Product Customizer component to display a **subscription form**, make sure to [set up Subscriptions.](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/setting-up-subscription-v2--1FA9dfE7vJqxBna9Nft5Sj) The Product Customizer integration with the Subscription module is native and will be automatically enabled when subscription settings are detected.\n\n## Configuring Product Customizer\n\n1. Add the `product-customizer` app to your theme dependencies in the `manifest.json`. For example:\n\n`1\n\n dependencies: { \n\n2\n\n+ \"vtex.product-customizer\": \"2.x\" \n\n3\n\n } \n\n`\n\n1. Add the `product-assembly-options` block as a child of the `store.product` template (PDP template). This is enough to enable the subscription form.\n\n`1\n\n \"store.product\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"flex-layout.row#product-breadcrumb\", \n\n4\n\n \"flex-layout.row#product-main\", \n\n5\n\n \"flex-layout.row#description\", \n\n6\n\n \"shelf.relatedProducts\", \n\n7\n\n \"product-reviews\", \n\n8\n\n \"product-questions-and-answers\", \n\n9\n\n+ \"product-assembly-options\" \n\n10\n\n ] \n\n11\n\n }, \n\n`\n\n1. Declare the [product-assembly-options props](#product-assembly-options-props) for your scenario.\n\n### Displaying attachments (optional)\n\n1. To display attachments of a product on the Product Detail Page (PDP), declare the `product-assembly-options` block and add the `assembly-option-input-values` block as its child.\n\n`1\n\n \"product-assembly-options\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"assembly-option-input-values\" \n\n4\n\n ] \n\n5\n\n }, \n\n`\n\n1. Use the blocks exported by the `product-customizer` app to create a solution that best suits your specific scenario.\n\n| Block name | Description |\n| ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |\n| assembly-option-item-image | Displays the attachment image. |\n| assembly-option-item-quantity-selector | Displays a quantity selector. |\n| assembly-option-item-name | Displays the attachment name. |\n| assembly-option-item-price | Displays the attachment price. |\n| assembly-option-item-customize | Displays the Customize button. When clicked, it opens a modal that allows customers to customize the attachment. |\n| assembly-option-item-children-description | Displays a summary with all selected attachments. |\n\n1. Declare the [props](#props) for the chosen blocks according to your scenario. For example:\n\n`1\n\n\"product-assembly-options\": { \n\n2\n\n \"props\":{ \n\n3\n\n \"initiallyOpened\": \"always\" \n\n4\n\n }, \n\n5\n\n \"children\": [ \n\n6\n\n \"flex-layout.row#product-assembly-options\", \n\n7\n\n \"assembly-option-input-values\" \n\n8\n\n ] \n\n9\n\n}, \n\n`\n\nWhile building your solution, note that you can receive inputs from three types of [attachments](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/adding-an-attachment?locale=en):\n\n* **Predefined options**: Predefined attachment options set in the `Permitted Values` field. Set up the `optionsDisplay` prop from the `assembly-option-input-values` block to define how these options are displayed.\n* **Free text**: Text input. Depending on the value set in the **Maximum Number of Characters** field in the attachment settings, shoppers may or may not have a character limit for this attachment.\n* **Boolean**: Boolean attachment options set in the `Permitted Values` field. Customers can select the attachment by clicking the checkbox.\n\nCheck the following example where the three attachment types are implemented:\n\n\n\nCheck out below how the product attachment displayed above was added to the Catalog:\n\n\n\nWhen an attachment is set as **required**, all attachment options are automatically made available to consumers. On the other hand, if an attachment is **not required**, the `Add customization` button is rendered, as shown in the example above. This gives shoppers the option to add or not an attachment to their product.\n\nAlso, keep in mind that the **Checkout** does not natively display the customized product option selected by the customer. To display the product in the Checkout with the selected attachments, it is necessary to customize the Checkout page, allowing it to read and render product information.\n\n## Props\n\n### `product-assembly-options` props\n\n| Prop name | Type | Description | Default value |\n| --------------- | ---- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| initiallyOpened | enum | Defines whether the customization box will be opened even if an attachment is not required (always) or if the customization box will be opened only if the attachment is required (required). | required |\n\n### `assembly-option-input-values` props\n\n| Prop name | Type | Description | Default value |\n| -------------- | ---- | ----------------------------------------------------------------------------------------------------------------------- | ------------- |\n| optionsDisplay | enum | Defines whether a checkbox (box) or a dropdown list (select) will be used to select the attachment pre-defined options. | select |\n\n### `assembly-option-item-customize`props\n\n| Prop name | Type | Description | Default value |\n| ----------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| buttonProps | object | Defines the behavior of the Customize button. In addition to the collapse prop, the buttonProps object can include child blocks to build the content of the modal triggered when the button is clicked. | undefined |\n\n* **`buttonProps` object:**\n\n| Prop name | Type | Description | Default value |\n| --------- | ---- | ----------------------------------------------------------------- | ------------- |\n| collapse | enum | Customize button positioning. Possible values are: left or right. | left |\n\n## Customization\n\nTo apply CSS customizations to this and other blocks, please see the [Using CSS handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization) guide.\n\n| CSS handles |\n| ------------------------------------------- |\n| booleanInputValue |\n| inputValueOptionBox |\n| itemContainer |\n| modalViewDoneButton |\n| modalViewProductContainer |\n| modalViewProductImage |\n| modalViewProductInfos |\n| modalViewProductName |\n| multipleItemQuantitySelector |\n| optionsInputValue |\n| optionsInputValueDropdown |\n| optionsInputValueLabel |\n| optionsInputValueLabelContainer |\n| optionsInputValueOptionBoxContainer |\n| productAssemblyGroupName |\n| productAssemblyGroupNameRow |\n| productAssemblyGroupRequiredTag |\n| productAssemblyOptionItemCustomize |\n| productAssemblyOptionItemCustomize\\_\\_label |\n| productAssemblyOptionItemImage |\n| productAssemblyOptionItemName |\n| textInputValue |\n\n[Order Placed« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.order-placed)[Product HighlightsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-highlights)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Before you start](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-customizer%23before-you-start)\n\n[Configuring Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-customizer%23configuring-product-customizer)\n\n[Displaying attachments (optional)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-customizer%23displaying-attachments-optional)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-customizer%23props)\n\n[product-assembly-options props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-customizer%23product-assembly-options-props)[assembly-option-input-values props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-customizer%23assembly-option-input-values-props)[assembly-option-item-customizeprops](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-customizer%23assembly-option-item-customizeprops)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-customizer/docs/apps/vtex.product-customizer%23customization)\n\nWas this helpful?\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_61ea1a1c
|
[
{
"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 1.0.8 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@1.0.8/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@1.0.8/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@1.0.8/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@1.0.8/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@1.0.8/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@1.0.8/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@1.0.8/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@1.0.8/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/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@1.0.8/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/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@1.0.8/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@1.0.8/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@1.0.8/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@1.0.8/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@1.0.8/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@1.0.8/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@1.0.8/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@1.0.8/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@1.0.8/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/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@1.0.8/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/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@1.0.8/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/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@1.0.8/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@1.0.8/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@1.0.8/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/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@1.0.8/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/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@1.0.8/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/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@1.0.8/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@1.0.8/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@1.0.8/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@1.0.8/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@1.0.8/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@1.0.8/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@1.0.8/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@1.0.8/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@1.0.8/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/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@1.0.8/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/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@1.0.8/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/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@1.0.8/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@1.0.8/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@1.0.8/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/guides/basic-components)\n\nVTEX Intelligent Search\n\nOfficial extension\n\nVersion: 1.0.8\n\nLatest version: 2.18.8\n\n> This page is about version **1.0.8** of the app, which is not the most recent version. The latest stable version is **2.18.8**.\n\nThe VTEX Search is an app that handles the result of the new [VTEX Intelligent Search](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search), used to provide a more complete search experience, by providing new functionality, components and a centralized hub for everything related to Search!\n\n:loudspeaker: **Disclaimer:** Don't fork this project; use, contribute, or open issue with your feature request.\n\n## Table of Contents\n\n* [Usage](#usage) \n * [Indexing Process](#indexing-process) \n * [UI Components](#ui-components) \n * [Autocomplete](#autocomplete) \n * [Search Result Complements](#search-result-complements) \n * [Google Analytics Configuration](#google-analytics-configuration)\n* [Troubleshooting](#troubleshooting)\n* [Contributing](#contributing)\n\n## Usage\n\nThe first step to start using [VTEX Intelligent Search](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search) is to install our suite of apps, that includes:\n\n* `vtex.admin-search`, responsible for the VTEX Admin experience for [VTEX Intelligent Search](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search). :computer:\n* `vtex.search-resolver`, the underlying implementation of our search engine. :nerd\\_face:\n\nYou can do this easily by running:\n\n`1\n\nvtex install vtex.admin-search vtex.search-resolver@1.x \n\n`\n\nThe app you're reading the documentation right now, `vtex.search`, became the house of new UI components closely related to the Search experience, it's not necessary to install it in your workspace and will be covered in [UI Components](#ui-components).\n\n> :loudspeaker: **Important:** After installation, all navigation and search pages will be delivered by the new VTEX Search.\n> \n> Confirm that the [Indexing Process step](#indexing-process) has been completed successfully before promoting the app to `master`.\n\n### Indexing Process\n\nAfter installing our suite of apps, your workspace is ready to begin it's Search journey, but first we need to index your account's catalog in our Search Engine.\n\nGo to your Admin page and click on the menu [Search > Integration Settings](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/6wKQgKmu2FT6084BJT7z5V)and start the Indexing Process.\n\n\n\n### UI Components\n\nIf you want to use our UI components you need import this app in your dependencies on the `manifest.json`.\n\n`1\n\n{ \n\n2\n\n \"dependencies\": { \n\n3\n\n \"vtex.search\": \"1.x\" \n\n4\n\n } \n\n5\n\n} \n\n`\n\nThis app provides the following blocks:\n\n* [Autocomplete](#autocomplete)\n* [Banner](#search-result-complements)\n* [DidYouMean](#search-result-complements)\n* [Suggestions](#search-result-complements)\n\n#### Autocomplete\n\nWe provide a customized autocomplete with new features. It includes:\n\n* Top Searches.\n* Search History.\n* Product Suggestions.\n* Term Suggestions.\n\nYou can read a detailed explanation of Autocomplete and it's features [here](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/4gXFsEWjF7QF7UtI2GAvhL).\n\nTo use our autocomplete, first, you need to declare a block for it in your `store/blocks.json`.\n\n`1\n\n{ \n\n2\n\n \"autocomplete-result-list.v2\": { \n\n3\n\n \"blocks\": [\"product-summary\"] \n\n4\n\n } \n\n5\n\n} \n\n`\n\nFinally, append this block to your Search Bar. To improve the client experience, we also recommend to add the `openAutocompleteOnFocus` prop.\n\n`1\n\n{ \n\n2\n\n \"search-bar\": { \n\n3\n\n \"blocks\": [\"autocomplete-result-list.v2\"], \n\n4\n\n \"props\": { \n\n5\n\n \"openAutocompleteOnFocus\": true \n\n6\n\n } \n\n7\n\n } \n\n8\n\n} \n\n`\n\nA full documentation of our custom autocomplete can be found [here](Autocomplete.md).\n\n#### Search Result Complements\n\n> :loudspeaker: **Important:** These improvements work only in version 3.x of[search-result](https://read.calvincode.net/reader?url=https://vtex.io/docs/components/search/vtex.search-result@3.x/)\n\nThis app provides three new components to improve the search result experience. They are:\n\n* [did-you-mean](DidYouMean.md). A possible misspelling correction for the current query.\n* [search-suggestion](Suggestions.md). A list of search terms similar to the query.\n* [search-banner](Banner.md). A banner that can be configured by query.\n\nAdd any of these components into the `search-result-layout.desktop` or the `search-result-layout.mobile` block.\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#did-you-mean\", \n\n5\n\n \"flex-layout.row#suggestion\", \n\n6\n\n \"flex-layout.row#banner-one\", \n\n7\n\n \"flex-layout.row#result\" \n\n8\n\n ], \n\n9\n\n \"props\": { \n\n10\n\n \"pagination\": \"show-more\", \n\n11\n\n \"preventRouteChange\": true, \n\n12\n\n \"mobileLayout\": { \n\n13\n\n \"mode1\": \"small\", \n\n14\n\n \"mode2\": \"normal\" \n\n15\n\n } \n\n16\n\n } \n\n17\n\n }, \n\n18\n\n \n19\n\n \"flex-layout.row#did-you-mean\": { \n\n20\n\n \"children\": [\"did-you-mean\"] \n\n21\n\n }, \n\n22\n\n \"flex-layout.row#suggestion\": { \n\n23\n\n \"children\": [\"search-suggestions\"] \n\n24\n\n }, \n\n25\n\n \"flex-layout.row#banner-one\": { \n\n26\n\n \"children\": [\"search-banner#one\"] \n\n27\n\n }, \n\n28\n\n \n29\n\n \"search-banner#one\": { \n\n30\n\n \"props\": { \n\n31\n\n \"area\": \"one\", \n\n32\n\n \"blockClass\": \"myBanner\", \n\n33\n\n \"horizontalAlignment\": \"center\" \n\n34\n\n } \n\n35\n\n } \n\n36\n\n} \n\n`\n\n### Google Analytics Configuration\n\nOur search engine uses `_q` as the querystring for the search term. If you want to track the search in your Google Analytics you need to register it.\n\nCheck the correct configuration for Google Analytics using [this documentation](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/store-management/setting-up-google-analytics-search-tracking/).\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/search/issues). Also, feel free to [open issues](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/search/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[Rich Text« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.rich-text)[SuggestionsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.search/suggestions)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)[BannerVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.search@1.0.8/Banner)[DidYouMeanVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.search@1.0.8/DidYouMean)[SuggestionsVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.search@1.0.8/Suggestions)[AutocompleteVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.search@1.0.8/Autocomplete)\n\nON THIS PAGE\n\n[Table of Contents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.search@1.0.8%23table-of-contents)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.search@1.0.8%23usage)\n\n[Indexing Process](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.search@1.0.8%23indexing-process)[UI Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.search@1.0.8%23ui-components)[Google Analytics Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.search@1.0.8%23google-analytics-configuration)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.search@1.0.8%23troubleshooting)\n\n[Contributing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/docs/apps/vtex.search@1.0.8%23contributing)\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_39205ef7
|
[
{
"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 1.0.8 Suggestions app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/vtex-io-apps)\n\nSuggestions\n\n[vtex.search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search)\n\nVersion: 1.0.8\n\nLatest version: 2.18.8\n\n> This page is about version **1.0.8** of the app, which is not the most recent version. The latest stable version is **2.18.8**.\n\n`Suggestions` is a component used to suggest search terms similar to the current query.\n\n## Usage\n\nAdd the `search-suggestions` block to the `search-result-layout.desktop` or `search-result-layout.mobile`. For example:\n\n`1\n\n\"search-result-layout.desktop\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"flex-layout.row#suggestion\", \n\n4\n\n ], \n\n5\n\n \"flex-layout.row#suggestion\": { \n\n6\n\n \"children\": [\"search-suggestions\"] \n\n7\n\n } \n\n8\n\n} \n\n`\n\n## Customization\n\nIn order to apply CSS customizations in this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization).\n\n| CSS Handles |\n| --------------------- |\n| suggestionsList |\n| suggestionsListPrefix |\n| suggestionsListLink |\n| suggestionsListItem |\n\nSee also\n\n[Vtex.searchVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/apps/vtex.search)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/apps/vtex.search@1.0.8/Suggestions%23usage)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/Suggestions/docs/apps/vtex.search@1.0.8/Suggestions%23customization)\n\nWas this helpful?\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_658b050f
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides graphql in vtex io in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/graphql-in-vtex-io)\n\n[List of GraphQL APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/vtex-io-graphql-api-list)\n\n[Developing a GraphQL API in service apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/developing-a-graphql-api-in-service-apps)\n\n[GraphQL authorization in IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/graphql-authorization-in-io-apps)\n\n[Integrating an app with a GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/integrating-an-app-with-a-graphql-api)\n\n[Implementing cache in GraphQL APIs for IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/implementing-cache-in-graphql-apis-for-io-apps)\n\n[Admin GraphQL IDE](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/graphql-ide)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/graphql-in-vtex-io)\n\n[List of GraphQL APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/vtex-io-graphql-api-list)\n\n[Developing a GraphQL API in service apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/developing-a-graphql-api-in-service-apps)\n\n[GraphQL authorization in IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/graphql-authorization-in-io-apps)\n\n[Integrating an app with a GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/integrating-an-app-with-a-graphql-api)\n\n[Implementing cache in GraphQL APIs for IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/implementing-cache-in-graphql-apis-for-io-apps)\n\n[Admin GraphQL IDE](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/graphql-ide)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/app-development)\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/graphql-in-vtex-io)\n\nGraphQL in VTEX IO\n\n[GraphQL](https://read.calvincode.net/reader?url=https://graphql.org/) is a query language for APIs that allows clients to request specific data from a server. Unlike REST APIs, which return fixed data structures, GraphQL allows developers to retrieve only the data they need, preventing over- and under-fetching.\n\nGraphQL has the advantage of being self-documenting, making it easier for developers to explore and consume APIs. With [introspection queries](https://read.calvincode.net/reader?url=https://graphql.org/learn/introspection/) and GraphQL IDEs such as [GraphiQL](https://read.calvincode.net/reader?url=https://github.com/graphql/graphiql), consumers can inspect the schema to view available endpoints, arguments, and fields.\n\nIn VTEX IO, there are specific ways to interact with GraphQL APIs. They include authenticating endpoints, implementing an API in an app, making GraphQL requests in an app, and more. For example, you need to use the [GraphQL builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-graphql-builder) to define the schema when creating an API in an app, and you also need to use [IO clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients) to make GraphQL requests in an app.\n\n## Essential concepts\n\nTo effectively work with GraphQL APIs in VTEX IO, it's important to understand the following core concepts:\n\n* **Schema**: The GraphQL schema defines the structure of the API, including types, queries, and mutations. It serves as the blueprint for both the server and the client.\n* **Queries** and **mutations**: Queries are used to fetch data, while mutations are used to modify data. Understanding how to craft these is crucial for interacting with GraphQL APIs.\n* **Introspection**: GraphQL allows for introspection, meaning you can query the API to understand its structure. This is particularly useful for exploring available queries, mutations, and types.\n\n## Guides in this section\n\nIn this section, we will cover the following topics:\n\n[List of GraphQL APIsSee how to use GraphQL APIs of VTEX Apps.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-graphql-api-list)[GraphQL authorization in IO appsLearn to implement and use protected GraphQL operations with IO apps.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps)[Admin GraphQL IDELearn how to make GraphQL queries in the Admin and use the IDE features.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-ide)\n\nContributors\n\n1\n\n[](https://github.com/henriquessb)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/GraphQL/graphql-in-vtex-io.md)\n\n[Node builder 7.x migration guide« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io//docs/guides/node-builder-7x-migration-guide)[List of GraphQL APIsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io//docs/guides/vtex-io-graphql-api-list)\n\nContributors\n\n1\n\n[](https://github.com/henriquessb)\n\nON THIS PAGE\n\n[Essential concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/graphql-in-vtex-io%23essential-concepts)\n\n[Guides in this section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/graphql-in-vtex-io%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/GraphQL/graphql-in-vtex-io.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Essential concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/graphql-in-vtex-io%23essential-concepts)\n\n[Guides in this section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-in-vtex-io/docs/guides/graphql-in-vtex-io%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_30192ac6
|
[
{
"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 subscriptions 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/subscriptions/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/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/subscriptions/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/subscriptions/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/subscriptions/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/subscriptions/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/subscriptions/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/getting-started)\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/catalog-overview)\n\n[Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/marketplace-overview)\n\n[Orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/orders-overview)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/checkout-overview)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/payments-overview)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/fulfillment)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/search-overview)\n\n[Pricing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/pricing-overview)\n\n[Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/promotions-overview)\n\n[Subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/subscriptions)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/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/subscriptions/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/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/subscriptions/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/subscriptions/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/getting-started)\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/catalog-overview)\n\n[Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/marketplace-overview)\n\n[Orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/orders-overview)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/checkout-overview)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/payments-overview)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/fulfillment)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/search-overview)\n\n[Pricing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/pricing-overview)\n\n[Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/promotions-overview)\n\n[Subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/subscriptions)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/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/subscriptions/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/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/subscriptions/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/subscriptions/docs/guides)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/getting-started)\n\n[Subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/subscriptions)\n\nSubscriptions\n\n> **Help us improve our documentation!** Tell us about your experience with this article by filling out [this form](https://read.calvincode.net/reader?url=https://forms.gle/fQoELRA1yfKDqmAb8).\n\n[Subscriptions](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-subscriptions-work--frequentlyAskedQuestions%5F4453) is the VTEX solution for customers to make recurrent purchases on a regular schedule, determining the orders’ products and frequency. This overview article presents what you can accomplish with **Subscriptions** and gathers relevant documentation on the subject.\n\n## Understanding Subscriptions\n\n**Subscriptions** is an app developed by VTEX to facilitate recurring sales for a store. It works as an automatic scheduler, executing a repurchase at the frequency requested by the customer.\n\nTo enable **Subscriptions** for customers, merchants have to [create subscription plans](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-a-subscription-plan--1qGRoFczm98Wgt81f9mUqC) to associate the products valid for subscriptions and the frequencies available for recurrent orders.\n\nOnce the [Subscriptions module is configured](#setting-up-subscriptions-mandatory), the merchant can generate, edit and manage customers’ recurrent orders, and [create subscription promotions](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/creating-a-subscription-promotion--3ROT13HYNeUIv0plDqgNed).\n\nThe composition of a subscription is as the following:\n\n\n\nEvery subscription order has an execution count called cycle. The cycle determines the position of an order counting from when the shopper subscribed. The original order that creates the subscription corresponds to 0, the first subscription order corresponds to 1, the second corresponds to 2, and so on.\n\nCustomers can create a subscription during checkout or on their [My Account](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh) page, and the communication between merchants and customers regarding subscriptions is made in the **Email Templates** module through [transactional emails](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/transactional-emails-for-subscriptions-orders--2NYHqHMRqZ43Cn6s84ZCB5).\n\n> This module may process personal or sensitive information. Learn more about how VTEX handles data privacy at our [Data privacy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-privacy) guide.\n\n## Setting up Subscriptions (mandatory)\n\nTo install the **Subscriptions** module, merchants have to contact [our Support](https://read.calvincode.net/reader?url=https://help.vtex.com/support). After that, they have to follow the configuration steps described in [How to configure Subscriptions in your store](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-to-configure-subscriptions-in-your-store--1FA9dfE7vJqxBna9Nft5Sj).\n\nAfter the installation, merchants have to [create subscription plans](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-a-subscription-plan--1qGRoFczm98Wgt81f9mUqC) to associate the products valid for subscriptions and the frequencies available for recurrent orders.\n\nWe highly recommend creating subscription plans in the **Subscriptions** module of your VTEX Admin, although it is also possible to create them as [catalog attachments](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/how-to-create-a-subscription-attachment-via-the-catalog-module--2bUuKyPflA8cOGLv8OvaKK).\n\n## Managing Subscriptions\n\nIn this section, you will find content about controlling and editing the **Subscriptions** settings of your store, and about updating, retrieving data and removing subscription orders.\n\n### Settings\n\nYou can edit the **Subscriptions** settings of your store and retrieve information about them.\n\n* [POST - Edit Subscriptions settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/subscriptions-api-v3%23post-/api/rns/settings)\n* [GET - Get Subscription Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/subscriptions-api-v3%23get-/api/rns/settings)\n\n### Plans\n\nIt is possible to list and retrieve information about **Subscription plans**.\n\n* [GET - List plans](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/subscriptions-api-v3%23get-/api/rns/pvt/plans)\n* [GET - Get plan details](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/subscriptions-api-v3%23get-/api/rns/pvt/plans/-id-)\n\n### Subscriptions\n\nYou can update settings, edit items and retrieve information about a given subscription.\n\n* [POST - Create subscription](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/subscriptions-api-v3%23post-/api/rns/pub/subscriptions)\n* [PATCH - Update subscription](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/subscriptions-api-v3%23patch-/api/rns/pub/subscriptions/-id-)\n* [GET - Get subscription details](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/subscriptions-api-v3%23get-/api/rns/pub/subscriptions/-id-)\n* [GET - List subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/subscriptions-api-v3%23get-/api/rns/pub/subscriptions)\n* [PATCH - Edit item on subscription](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/subscriptions-api-v3%23patch-/api/rns/pub/subscriptions/-id-/items/-itemId-)\n* [POST - Add item to subscription](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/subscriptions-api-v3%23post-/api/rns/pub/subscriptions/-id-/items)\n* [DELETE - Remove item from subscription](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/subscriptions-api-v3%23delete-/api/rns/pub/subscriptions/-id-/items/-itemId-)\n\n### Cycles\n\nCycles are the execution count of subscription orders. The cycle determines the position of an order counting from when the customer subscribed.\n\nYou can retrieve information about cycles and rerun cycles that present errors, which will reprocess the order.\n\n* [GET - Get cycle details](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/subscriptions-api-v3%23get-/api/rns/pub/cycles/-cycleId-)\n* [GET - List cycles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/subscriptions-api-v3%23get-/api/rns/pub/cycles)\n* [POST - Retry cycle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/subscriptions-api-v3%23post-/api/rns/pub/cycles/-cycleId-/retry)\n\n### Communication\n\nThe communication between stores and customers about subscription orders happens via [transactional emails](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/transactional-emails-for-subscriptions-orders--2NYHqHMRqZ43Cn6s84ZCB5). It is possible to retrieve the conversation messages sent to a customer regarding a subscription order.\n\n* [GET - Get conversation messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/subscriptions-api-v3%23get-/api/rns/pub/subscriptions/-subscriptionId-/conversation-message)\n\n## Enabling manual prices\n\nWhen using **Subscriptions**, merchants might need to configure prices manually. By [enabling the Manual Price feature for Subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-manual-prices-for-subscriptions-v3%23setting-a-manual-price-in-a-subscription-item), merchants can apply a manual price on each subscription item, overriding the current price, and maintain the same manual price for future recurrent orders from a given subscription.\n\n## Simulating prices\n\nIt is possible to simulate a subscription order price at checkout, getting information about items and shipping costs.\n\n* [POST - Calculate the current prices for a specific subscription](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/subscriptions-api-v3%23post-/api/rns/pub/subscriptions/-id-/simulate)\n* [POST - Calculate the current prices for the provided subscription template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/subscriptions-api-v3%23post-/api/rns/pub/subscriptions/simulate)\n\n## Configuring pickup points for subscription orders\n\n> The feature pickup points for subscription orders is in beta and available only for stores using the **Checkout V6**.\n\nA [pickup point](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) is a physical location where customers can pick up their orders instead of having them delivered to their addresses, and merchants can [configure pickup points for subscription orders](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/pickup-points-for-subscription-orders-beta--csIqB6iBh4QNIFdEj0nVv). The requirements are the following:\n\n* Have the [Subscriptions module](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-to-configure-subscriptions-in-your-store--1FA9dfE7vJqxBna9Nft5Sj) installed.\n* Have pickup points configured.\n* Associate to pickup points for subscriptions orders only carriers that do not have a [delivery windows](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) configured.\n* Have items count in inventory at the subscription cycle date.\n\n## Controlling reports\n\nYou can generate reports about subscription orders using templates to filter orders. When you create a template, you determine which criteria will be used for filtering: order status, creation date, scheduled date, among others.\n\n* [GET - List report templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/subscriptions-api-v3%23get-/api/rns/pvt/reports)\n* [GET - Get report document details](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/subscriptions-api-v3%23get-/api/rns/pvt/reports/-reportName-/documents/-documentId-)\n* [POST - Generate report](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/subscriptions-api-v3%23post-/api/rns/pvt/reports/-reportName-/documents)\n\nContributors\n\n4\n\n[](https://github.com/Isabella-Veloso)\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/Getting-Started/subscriptions.md)\n\n[Promotions« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions//docs/guides/promotions-overview)[Back office integration guide (ERP/PIM/WMS)Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions//docs/guides/erp-integration-guide)\n\nContributors\n\n4\n\n[](https://github.com/Isabella-Veloso)\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[Understanding Subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/subscriptions%23understanding-subscriptions)\n\n[Setting up Subscriptions (mandatory)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/subscriptions%23setting-up-subscriptions-mandatory)\n\n[Managing Subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/subscriptions%23managing-subscriptions)\n\n[Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/subscriptions%23settings)[Plans](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/subscriptions%23plans)[Subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/subscriptions%23subscriptions)[Cycles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/subscriptions%23cycles)[Communication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/subscriptions%23communication)\n\n[Enabling manual prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/subscriptions%23enabling-manual-prices)\n\n[Simulating prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/subscriptions%23simulating-prices)\n\n[Configuring pickup points for subscription orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/subscriptions%23configuring-pickup-points-for-subscription-orders)\n\n[Controlling reports](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/subscriptions%23controlling-reports)\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/subscriptions.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Understanding Subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/subscriptions%23understanding-subscriptions)\n\n[Setting up Subscriptions (mandatory)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/subscriptions%23setting-up-subscriptions-mandatory)\n\n[Managing Subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/subscriptions%23managing-subscriptions)\n\n[Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/subscriptions%23settings)[Plans](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/subscriptions%23plans)[Subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/subscriptions%23subscriptions)[Cycles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/subscriptions%23cycles)[Communication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/subscriptions%23communication)\n\n[Enabling manual prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/subscriptions%23enabling-manual-prices)\n\n[Simulating prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/subscriptions%23simulating-prices)\n\n[Configuring pickup points for subscription orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/subscriptions%23configuring-pickup-points-for-subscription-orders)\n\n[Controlling reports](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/subscriptions/docs/guides/subscriptions%23controlling-reports)\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_37b4d9e6
|
[
{
"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 managing url redirects 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-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/docs/guides/store-framework-routing)\n\n[Adding custom headers to your Store Framework store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store)\n\n[Best practices for associating a custom page with a content type](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type)\n\n[Customizing your 404 page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/docs/guides/vtex-io-documentation-customizing-your-404-page)\n\n[Enabling 404 pages for invalid single-segment paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/docs/guides/vtex-io-documentation-enabling-404-pages-for-invalid-single-segment-paths)\n\n[Managing URL redirects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/docs/guides/vtex-io-documentation-managing-url-redirects)\n\n[Using several service workers in your store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/docs/guides/store-framework-routing)\n\n[Adding custom headers to your Store Framework store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store)\n\n[Best practices for associating a custom page with a content type](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type)\n\n[Customizing your 404 page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/docs/guides/vtex-io-documentation-customizing-your-404-page)\n\n[Enabling 404 pages for invalid single-segment paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/docs/guides/vtex-io-documentation-enabling-404-pages-for-invalid-single-segment-paths)\n\n[Managing URL redirects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/docs/guides/vtex-io-documentation-managing-url-redirects)\n\n[Using several service workers in your store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/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-managing-url-redirects/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/docs/guides/store-framework)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/docs/guides/store-framework-routing)\n\n[Managing URL redirects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/docs/guides/vtex-io-documentation-managing-url-redirects)\n\nManaging URL redirects\n\nLearn how to manage your store's URL redirects to prevent 404 errors.\n\nURL redirection is a method of forwarding website visitors and search engines from one URL to another. Redirects might be useful when you need to move content to a new URL, remove an old product page, or forward users from a specific region to a custom page. Implementing the appropriate redirects can improve the user experience by preventing visitors from hitting 404 error pages.\n\nCheck the following sections to learn how to [create](#creating-url-redirects), [remove](#deleting-url-redirects), and [verify](#verifying-url-redirects) your store's URL redirects.\n\n## Before you begin\n\n1. [Install the VTEX IO Command-Line Interface (CLI)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference).\n2. [Install the redirects plugin for the VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins%23installing-a-plugin):\n\n`1\n\nvtex plugins install redirects \n\n`\n\n## Creating URL redirects\n\n1. Using the [CSV file template](#csv-file-template) as a reference, create a `.csv` file containing the redirects you wish to create.\n2. Save the file under the name of your choice.\n3. Open the terminal and log in to your VTEX account.\n4. Import redirects to your account by running the following command: \n * _Replace `{CSVpath}` with the path to your `.csv` file._ \n`1 \nvtex redirects import {CSVpath} \n`\n\nOnce your file is processed, the redirects will take effect. Please keep in mind that this may take some time.\n\n## Deleting URL redirects\n\n1. Using the [CSV file template](#csv-file-template) as a reference, create a `.csv` file with the redirects you wish to delete.\n2. Save the file under the name of your choice.\n3. Open the terminal and log in to your VTEX account.\n4. Delete redirects from your account by running the following command: \n * _Replace `{CSVpath}` with the path to your `.csv` file._ \n`1 \nvtex redirects delete {CSVpath} \n`\n\n## Verifying URL redirects\n\n1. Open the terminal and log in to your VTEX account.\n2. Retrieve the full list of your store's redirects into a `.csv` file by running the following command. \n * _Replace `{fileName}` with any name of your choice._ \n`1 \nvtex redirects export {fileName}.csv \n`\n\nAfter running this command, a file named `{fileName}.csv` containing all the redirects of your store will be created in your current directory.\n\nCheck the [CSV file template](#csv-file-template) to understand the meaning of each field of the `.csv` file generated.\n\n## CSV file template\n\nTo create or delete URL redirects in your store, you must create a `.csv` file as in the following example.\n\n\n\nNotice that the file must contain a row with four columns and the following values:\n\n| Property name | Description | Example |\n| ------------- | ------------------------------------------------------------------------------------------- | --------- |\n| from | Original path. | /blouse/p |\n| to | Relative path or full URL to which you want to redirect your visitors. | /shirts/p |\n| type | Redirect type. TEMPORARY or PERMANENT | TEMPORARY |\n| endDate | **Only for TEMPORARY redirects**. Expiration date of the redirect on the format mm/dd/yyyy. | 5/20/2020 |\n\n> You must not modify this row. Otherwise, you will not be able to create or delete redirects.\n\nUnder the first row of your `.csv` file, enter the `from`, `to`, `type`, and `endDate` values corresponding to the redirects you want to create or delete, as in the following example:\n\n\n\nKeep in mind that:\n\n* The `from` column can only receive relative paths.\n* The `to` column can receive either relative paths (e.g., `/shirts/p`) or full URLs (e.g., `https://myotherstore.com`).\n\n> You cannot create redirects using wildcards or variables. You must specify each redirect using relative paths or full URLs.\n\n* `TEMPORARY` redirects receive the `302` status code, while `PERMANENT` redirects receive the `301` status code.\n* The `endDate` must be left empty if the redirect is `PERMANENT`.\n\n[Creating URL redirects 🔼](#creating-url-redirects)\n\n[Removing URL redirects 🔼](#deleting-url-redirects)\n\n[Verifying URL redirects 🔼](#verifying-url-redirects)\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/pages/vtex-io-documentation-managing-url-redirects.md)\n\n[Enabling 404 pages for invalid single-segment paths« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects//docs/guides/vtex-io-documentation-enabling-404-pages-for-invalid-single-segment-paths)[Using several service workers in your storeNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects//docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store)\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-managing-url-redirects/docs/guides/vtex-io-documentation-managing-url-redirects%23before-you-begin)\n\n[Creating URL redirects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/docs/guides/vtex-io-documentation-managing-url-redirects%23creating-url-redirects)\n\n[Deleting URL redirects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/docs/guides/vtex-io-documentation-managing-url-redirects%23deleting-url-redirects)\n\n[Verifying URL redirects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/docs/guides/vtex-io-documentation-managing-url-redirects%23verifying-url-redirects)\n\n[CSV file template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/docs/guides/vtex-io-documentation-managing-url-redirects%23csv-file-template)\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/pages/vtex-io-documentation-managing-url-redirects.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-managing-url-redirects/docs/guides/vtex-io-documentation-managing-url-redirects%23before-you-begin)\n\n[Creating URL redirects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/docs/guides/vtex-io-documentation-managing-url-redirects%23creating-url-redirects)\n\n[Deleting URL redirects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/docs/guides/vtex-io-documentation-managing-url-redirects%23deleting-url-redirects)\n\n[Verifying URL redirects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/docs/guides/vtex-io-documentation-managing-url-redirects%23verifying-url-redirects)\n\n[CSV file template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-url-redirects/docs/guides/vtex-io-documentation-managing-url-redirects%23csv-file-template)\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_32fbe1be
|
[
{
"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 update cart items 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/update-cart-items/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/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/update-cart-items/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/update-cart-items/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/update-cart-items/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/update-cart-items/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/update-cart-items/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/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/update-cart-items/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/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/update-cart-items/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/update-cart-items/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/update-cart-items/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/update-cart-items/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/update-cart-items/docs/guides/remove-all-personal-data)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/add-cart-items)\n\n[Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/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/update-cart-items/docs/guides/change-price)\n\n[Ignore profile data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/ignore-profile-data)\n\n[Get cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/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/update-cart-items/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/update-cart-items/docs/guides/add-service-to-the-cart)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/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/update-cart-items/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/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 Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/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/update-cart-items/docs/guides/data-protection-plus)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/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/update-cart-items/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/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/update-cart-items/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/update-cart-items/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/update-cart-items/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/update-cart-items/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/update-cart-items/docs/guides/remove-all-personal-data)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/add-cart-items)\n\n[Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/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/update-cart-items/docs/guides/change-price)\n\n[Ignore profile data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/ignore-profile-data)\n\n[Get cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/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/update-cart-items/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/update-cart-items/docs/guides/add-service-to-the-cart)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/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/update-cart-items/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/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 Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/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/update-cart-items/docs/guides/data-protection-plus)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/checkout-api-overview)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/update-cart-items)\n\nUpdate cart items\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 modify the quantity of an item in the cart or remove it by the API.\n\n> ️ To remove all items from the cart at the same time, use the [Remove all items](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/removeallitems) endpoint.\n\n## Getting shopping cart information\n\nThe first step is to get the `orderFormId` of the shopping cart that you want to update cart items information. 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## Updating shopping cart items quantity\n\nTo update items in the shopping cart, you need to use the [Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/itemsupdate) endpoint. In this request, you must send the following information through the URL:\n\n* **Path param**: `orderFormId` value.\n* **Query param**: `allowedOutdatedData`. You can set up this query as `false` or `true` to define whether some cart information can be updated through the minicart.\n\nSee a URL example below:\n\n`https://accountname.environment.com.br/api/checkout/pub/orderForm/ede846222cd44046ba6c638442c3505a/items?allowedOutdatedData=paymentData`\n\nAdditionally, you need to send the request body containing the `index` (item's position in the array or cart) and the new `quantity` value. See a request body example below:\n\n`1\n\n{ \n\n2\n\n \"orderItems\": [ \n\n3\n\n { \n\n4\n\n \"quantity\": 3, \n\n5\n\n \"index\": \"1\" \n\n6\n\n } \n\n7\n\n ] \n\n8\n\n} \n\n`\n\nAfter sending the request, the endpoint will return the response body with the shopping cart information containing the new item quantity information.\n\n`1\n\n... \n\n2\n\n\"items\": [ \n\n3\n\n { \n\n4\n\n \"uniqueId\": \"BAE0177A615A4EB1B261DDF3274076F8\", \n\n5\n\n \"id\": \"5\", \n\n6\n\n \"productId\": \"7\", \n\n7\n\n \"productRefId\": \"\", \n\n8\n\n \"refId\": null, \n\n9\n\n \"ean\": \"978020137962\", \n\n10\n\n \"name\": \"Ultra Moisturizing Milk Conditioner 100 ml\", \n\n11\n\n \"skuName\": \"100 ml\", \n\n12\n\n \"modalType\": null, \n\n13\n\n \"parentItemIndex\": null, \n\n14\n\n \"parentAssemblyBinding\": null, \n\n15\n\n \"assemblies\": [], \n\n16\n\n \"priceValidUntil\": \"2023-11-08T18:01:42Z\", \n\n17\n\n \"tax\": 0, \n\n18\n\n \"price\": 4490, \n\n19\n\n \"listPrice\": 4490, \n\n20\n\n \"manualPrice\": null, \n\n21\n\n \"manualPriceAppliedBy\": null, \n\n22\n\n \"sellingPrice\": 448840, \n\n23\n\n \"rewardValue\": 0, \n\n24\n\n \"isGift\": false, \n\n25\n\n \"additionalInfo\": { \n\n26\n\n \"dimension\": null, \n\n27\n\n \"brandName\": \"VALDIE&CO\", \n\n28\n\n \"brandId\": \"2000000\", \n\n29\n\n \"offeringInfo\": null, \n\n30\n\n \"offeringType\": null, \n\n31\n\n \"offeringTypeId\": null \n\n32\n\n }, \n\n33\n\n \"preSaleDate\": null, \n\n34\n\n \"productCategoryIds\": \"/4/1/\", \n\n35\n\n \"productCategories\": { \n\n36\n\n \"1\": \"Treatments\", \n\n37\n\n \"4\": \"Stylers\" \n\n38\n\n }, \n\n39\n\n \"quantity\": 3, \n\n40\n\n \"seller\": \"cosmetics1\", \n\n41\n\n \"sellerChain\": [ \n\n42\n\n \"cosmetics1\" \n\n43\n\n ], \n\n44\n\n \"imageUrl\": \"http://cosmetics2.vteximg.com.br/arquivos/ids/155403-55-55/Ultra-Moisturizing-Milk-Conditioner.jpg?v=637109315995300000\", \n\n45\n\n \"detailUrl\": \"/ultra-moisturizing-milk-conditioner/p\", \n\n46\n\n \"components\": [], \n\n47\n\n \"bundleItems\": [], \n\n48\n\n \"attachments\": [], \n\n49\n\n \"attachmentOfferings\": [], \n\n50\n\n \"offerings\": [], \n\n51\n\n \"priceTags\": [ \n\n52\n\n { \n\n53\n\n \"name\": \"discount@price-0e45a4e3-6084-4bf9-bff7-0fe8403699fc#e5b461db-58da-46a0-87b9-fbab27c5caad\", \n\n54\n\n \"value\": -480, \n\n55\n\n \"rawValue\": -4.8, \n\n56\n\n \"isPercentual\": false, \n\n57\n\n \"identifier\": \"0e45a4e3-6084-4bf9-bff7-0fe8403699fc\", \n\n58\n\n \"owner\": \"cosmetics2\" \n\n59\n\n } \n\n60\n\n ], \n\n61\n\n \"availability\": \"cannotBeDelivered\", \n\n62\n\n \"measurementUnit\": \"mg\", \n\n63\n\n \"unitMultiplier\": 100.0000, \n\n64\n\n \"manufacturerCode\": null, \n\n65\n\n \"priceDefinition\": { \n\n66\n\n \"calculatedSellingPrice\": 448840, \n\n67\n\n \"total\": 1346520, \n\n68\n\n \"sellingPrices\": [ \n\n69\n\n { \n\n70\n\n \"value\": 448840, \n\n71\n\n \"quantity\": 3 \n\n72\n\n } \n\n73\n\n ] \n\n74\n\n } \n\n75\n\n }, \n\n76\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.\" } \\[/block\\]\n\n## Removing shopping cart items\n\nTo remove an item from the cart you must use the same endpoint and parameters as in the previous section ([Updating shopping cart items quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/update-cart-items%23updating-shopping-cart-items-quantity)). However, the `quantity` value to be sent in the request body must be `0`. See a request body example below:\n\n`1\n\n... \n\n2\n\n{ \n\n3\n\n \"orderItems\": [ \n\n4\n\n { \n\n5\n\n \"quantity\": 0, \n\n6\n\n \"index\": 1 \n\n7\n\n } \n\n8\n\n ] \n\n9\n\n} \n\n10\n\n... \n\n`\n\nAfter sending the request, the endpoint will return the response body with the shopping cart information without the removed item.\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* **Message error example (code CHK0023)**: `\"Invalid quantity for the item\"`. This message indicates that the `quantity` value (mandatory) has not been sent in the request body.\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"CHK0023\", \n\n5\n\n \"message\": \"Invalid quantity for item\", \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* **Message error example (code CHK0041)**: `\"Invalid item index\"`. This message indicates that the `index` 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\": \"CHK0041\", \n\n5\n\n \"message\": \"Invalid item index\", \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 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/update-cart-items.md)\n\n[Add cart items« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items//docs/guides/add-cart-items)[Change the price of an SKU in a cartNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items//docs/guides/change-price)\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/update-cart-items/docs/guides/update-cart-items%23getting-shopping-cart-information)\n\n[Updating shopping cart items quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/update-cart-items%23updating-shopping-cart-items-quantity)\n\n[Removing shopping cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/update-cart-items%23removing-shopping-cart-items)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/update-cart-items%23error-codes)\n\n[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/update-cart-items%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/update-cart-items%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/update-cart-items.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/update-cart-items/docs/guides/update-cart-items%23getting-shopping-cart-information)\n\n[Updating shopping cart items quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/update-cart-items%23updating-shopping-cart-items-quantity)\n\n[Removing shopping cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/update-cart-items%23removing-shopping-cart-items)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/update-cart-items%23error-codes)\n\n[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/update-cart-items%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/update-cart-items/docs/guides/update-cart-items%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_15576606
|
[
{
"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 handling errors and exceptions 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/handling-errors-and-exceptions/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/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/handling-errors-and-exceptions/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/handling-errors-and-exceptions/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/handling-errors-and-exceptions/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/handling-errors-and-exceptions/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/handling-errors-and-exceptions/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/docs/guides/api-usage)\n\n[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/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/handling-errors-and-exceptions/docs/guides/making-your-first-request)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/docs/guides/authentication)\n\n[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/docs/guides/api-response-codes)\n\nError handling and best practices\n\n[Handling errors and exceptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/docs/guides/handling-errors-and-exceptions)\n\n[Best practices for avoiding rate limit errors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/docs/guides/best-practices-for-avoiding-rate-limit-errors)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/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/handling-errors-and-exceptions/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/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/handling-errors-and-exceptions/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/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/handling-errors-and-exceptions/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/handling-errors-and-exceptions/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/docs/guides/api-usage)\n\n[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/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/handling-errors-and-exceptions/docs/guides/making-your-first-request)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/docs/guides/authentication)\n\n[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/docs/guides/api-response-codes)\n\nError handling and best practices\n\n[Handling errors and exceptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/docs/guides/handling-errors-and-exceptions)\n\n[Best practices for avoiding rate limit errors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/docs/guides/best-practices-for-avoiding-rate-limit-errors)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/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/handling-errors-and-exceptions/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/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/handling-errors-and-exceptions/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/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/handling-errors-and-exceptions/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/handling-errors-and-exceptions/docs/guides)\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/docs/guides/api-usage)\n\nError handling and best practices\n\n[Handling errors and exceptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/docs/guides/handling-errors-and-exceptions)\n\nHandling errors and exceptions\n\nLearn how to handle errors and exceptions in VTEX API Core Commerce APIs to build resilient applications.\n\nHandling errors and exceptions is essential for building resilient applications that can effectively navigate temporary restrictions from VTEX Core Commerce API's rate limits. Exception handling and error recovery mechanisms help your store respond gracefully to rate limit exceeded errors without impacting user interactions. They also minimize unnecessary retries and resource wastage by introducing appropriate wait times and contributing to responsible resource management.\n\nTo implement effective error handling in rate-limiting scenarios, consider the [VTEX API response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-response-codes) article and prioritize the best practices outlined in this article, with a specific emphasis on the code families of 3xx (Redirection), 4xx (Client Errors), and 5xx (Server Errors).\n\n## Handle 3xx errors\n\nHTTP status codes in the 3xx range are used for redirection purposes, usually demanding the user agent to take additional actions to fulfill the request.\n\n| Error code | Error handling strategies |\n| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| 308 Permanent Redirect | Update the URL or endpoint used in the request to the new provided location.Ensure the redirection is valid and current at the time of the request.Confirm if the redirection is genuinely permanent rather than temporary.Update your bookmarks, links, or references to reflect the new resource location. |\n\n## Handle 4xx errors\n\nHTTP status codes in the 4xx range denote client errors, typically originating from issues on the client side.\n\n| Error code | Error handling strategies |\n| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| 400 Bad Request | Refer to [API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference) for the expected request format.Review the request parameters.Validate the request structure and syntax.Ensure all required parameters are included. |\n| 401 Unauthorized | Verify the authentication method used. Refer to [Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication) for more information.Ensure that authentication tokens or API keys are correctly passed in the request headers.Re-authenticate with valid credentials. |\n| 403 Forbidden | Ensure you have the appropriate [roles](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc?%26utm%5Fsource=autocomplete) to perform the desired action.Check the expiration or validity of your access credentials. |\n| 404 Not Found | Refer to [API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference) for correct endpoint naming.Double-check the URL or endpoint for accuracy.Confirm if the resource has been moved or deleted.Check the [VTEX status page](https://read.calvincode.net/reader?url=https://status.vtex.com/) for real-time outages and incident reports. If the issue persists, reach out to [VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/support). |\n| 405 Method Not Allowed | Ensure the request method matches the allowed methods for the resource. Refer to [VTEX API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference) for supported methods.Check for spelling errors in the method used. |\n| 429 Too Many Requests | Reduce the frequency of requests by optimizing code to limit unnecessary API calls or batch requests when possible.Implement an [exponential backoff strategy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors) to gradually increase the delay between retries after receiving a 429 error.Monitor your API request patterns closely to identify any areas that may be triggering rate limits frequently and adjust accordingly.Consider implementing a queue system to better manage and distribute requests over time.In case of persistent rate limit issues, consider reaching out to [VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/support) for further assistance or clarification. |\n\n## Handle 5xx errors\n\nHTTP status codes in the 5xx range indicate server errors, revealing issues on the server side that hinder request fulfillment. Effective error handling in this category is essential for maintaining a reliable application.\n\n| Error code | Error handling strategies |\n| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| 500 Internal Server Error | Check if the issue is on your end or the server's.If possible, test the same request on different tools to confirm the issue.Check the [VTEX status page](https://read.calvincode.net/reader?url=https://status.vtex.com/) for real-time outages and incident reports.Retry the request after some time, as the error might be temporary.If the issue persists, reach out to [VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/support). |\n| 503 Service Unavailable | Retry the request after some time, as the error might be temporary.Check the [VTEX status page](https://read.calvincode.net/reader?url=https://status.vtex.com/) for real-time outages and incident reports.If the issue persists, reach out to [VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/support). |\n| 504 Gateway Timeout | Check for potential network connectivity problems on your end.Investigate if the request payload size or complexity might be causing the timeout.Check the [VTEX status page](https://read.calvincode.net/reader?url=https://status.vtex.com/) for real-time outages and incident reports. If the issue persists, reach out to [VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/support).Consider [implementing retry mechanisms or backoff strategies](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/Exponential%5Fbackoff) to manage timeouts effectively. |\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/Getting-Started/handling-errors-and-exceptions.md)\n\n[Response status codes« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions//docs/guides/api-response-codes)[Best practices for avoiding rate limit errorsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions//docs/guides/best-practices-for-avoiding-rate-limit-errors)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Handle 3xx errors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/docs/guides/handling-errors-and-exceptions%23handle-3xx-errors)\n\n[Handle 4xx errors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/docs/guides/handling-errors-and-exceptions%23handle-4xx-errors)\n\n[Handle 5xx errors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/docs/guides/handling-errors-and-exceptions%23handle-5xx-errors)\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/handling-errors-and-exceptions.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Handle 3xx errors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/docs/guides/handling-errors-and-exceptions%23handle-3xx-errors)\n\n[Handle 4xx errors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/docs/guides/handling-errors-and-exceptions%23handle-4xx-errors)\n\n[Handle 5xx errors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/handling-errors-and-exceptions/docs/guides/handling-errors-and-exceptions%23handle-5xx-errors)\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_2fd072d2
|
[
{
"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 migrating google tag manager app in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-google-tag-manager-app/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-google-tag-manager-app/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-google-tag-manager-app/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-google-tag-manager-app/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-google-tag-manager-app/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-google-tag-manager-app/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-google-tag-manager-app/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-google-tag-manager-app/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-google-tag-manager-app/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-google-tag-manager-app/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-google-tag-manager-app/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-google-tag-manager-app/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-google-tag-manager-app/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-google-tag-manager-app/updates/release-notes)\n\nMigrating Google Tag Manager app from major 2.x to major 3.x\n\nVersion 3.x of [VTEX Google Tag Manager (GTM) app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager) introduces enhanced tracking capabilities for user interactions within the store. With the integration of the `ecommerceV2` variable, this version allows for comprehensive monitoring of the user journey, capturing events from product views to completed purchases. Additionally, it allows stores to send events in both the Google Analytics 4 (GA4) format and the Universal Analytics (UA) format, facilitating a seamless transition to GA4.\n\n## Product schema properties of GTM 3.x\n\nTo ensure consistency in product information across all areas of the store and effectively track the user's journey, Google Tag Manager 3.x introduces Enhanced Ecommerce properties to the product data schema as events. By adding these properties, stores can include additional information such as product printing, promotion, and sales data, thereby enhancing the overall tracking capabilities and maintaining a unified view of the user's journey throughout the store.\n\n| GTM 3.x property | Type | Description |\n| ---------------- | ------------------ | --------------------------------------------------------------------------- |\n| id | Updated property | Product ID - Previously SKU ID. |\n| variant | Updated property | SKU ID - Previously SKU Name. The variant of the product, e.g., Rebel pink. |\n| name | Updated property | Product Name - Previously Product Name or SKU Name. |\n| quantity | Unchanged property | Product quantity |\n| price | Unchanged property | Product price. |\n| category | Unchanged property | Product category, e.g., Apparel. |\n| brand | Unchanged property | Product brand. |\n| dimension1 | New property | Product Reference ID. |\n| dimension2 | New property | SKU Reference ID. |\n| dimension3 | New property | SKU Name (does not include the Product Name). |\n\nThe `dimension1`, `dimension2`, `dimension3` properties are custom dimensions that you can use to collect and analyze data that Google Analytics does not automatically create.\n\nFor more information about custom dimensions and Enhanced Ecommerce, refer to [Custom dimensions and metrics](https://read.calvincode.net/reader?url=https://support.google.com/analytics/answer/2709828?hl=en%26ref%5Ftopic=2709827%23configuration%26zippy=%2Cin-this-article) and [Google Enhanced ecommerce official guide](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/analyticsjs/enhanced-ecommerce%23ecommerce-data) respectively.\n\n## Migrating to GTM 3.x\n\nTo migrate to the app's 3.x version, please follow these guides:\n\n1. [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%23create-a-google-analytics-4-property): Refer to the \"Create a Google Analytics 4 property\" section and follow the instructions provided.\n2. Once you have completed the setup, proceed to the [Setting up Google Tag Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager) guide for instructions on configuring events, tags, and triggers specifically for GA4.\n\nBy following these steps, you'll be able to smoothly migrate to the latest version of the app and set up events, tags, and triggers for both GA4 and UA formats.\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/google-tag-manager/vtex-io-documentation-migrating-google-tag-manager-app.md)\n\nSee also\n\n[Vtex Google Tag ManagerGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-google-tag-manager-app/docs/guides/vtex-google-tag-manager)[Setting up Google Tag ManagerStorefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-google-tag-manager-app/docs/guides/vtex-io-documentation-setting-up-google-tag-manager)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Product schema properties of GTM 3.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-google-tag-manager-app/docs/guides/vtex-io-documentation-migrating-google-tag-manager-app%23product-schema-properties-of-gtm-3x)\n\n[Migrating to GTM 3.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-google-tag-manager-app/docs/guides/vtex-io-documentation-migrating-google-tag-manager-app%23migrating-to-gtm-3x)\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-migrating-google-tag-manager-app.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Product schema properties of GTM 3.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-google-tag-manager-app/docs/guides/vtex-io-documentation-migrating-google-tag-manager-app%23product-schema-properties-of-gtm-3x)\n\n[Migrating to GTM 3.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-google-tag-manager-app/docs/guides/vtex-io-documentation-migrating-google-tag-manager-app%23migrating-to-gtm-3x)\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_15768c92
|
[
{
"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 policies from license 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-policies-from-license-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-policies-from-license-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-policies-from-license-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-policies-from-license-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-policies-from-license-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-policies-from-license-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-policies-from-license-manager/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-policies-from-license-manager/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-policies-from-license-manager/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-policies-from-license-manager/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-policies-from-license-manager/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-policies-from-license-manager/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/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-policies-from-license-manager/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-policies-from-license-manager/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-policies-from-license-manager/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-policies-from-license-manager/docs/guides/vtex-io-documentation-policies)\n\n[Accessing external resources within a VTEX IO app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/accessing-external-resources-within-a-vtex-io-app)\n\n[Controlling access to app resources](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/controlling-access-to-app-resources)\n\n[Roles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-documentation-roles)\n\n[VTEX Resource Name (VRN)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-documentation-vrn)\n\n[Policies from License Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-documentation-policies-from-license-manager)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/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-policies-from-license-manager/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-policies-from-license-manager/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-policies-from-license-manager/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-policies-from-license-manager/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/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-policies-from-license-manager/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-policies-from-license-manager/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-policies-from-license-manager/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-policies-from-license-manager/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-policies-from-license-manager/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/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-policies-from-license-manager/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-policies-from-license-manager/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-policies-from-license-manager/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-policies-from-license-manager/docs/guides/vtex-io-documentation-policies)\n\n[Accessing external resources within a VTEX IO app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/accessing-external-resources-within-a-vtex-io-app)\n\n[Controlling access to app resources](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/controlling-access-to-app-resources)\n\n[Roles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-documentation-roles)\n\n[VTEX Resource Name (VRN)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-documentation-vrn)\n\n[Policies from License Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-documentation-policies-from-license-manager)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/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-policies-from-license-manager/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-policies-from-license-manager/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-policies-from-license-manager/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-policies-from-license-manager/docs/app-development)\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-documentation-policies)\n\n[Policies from License Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-documentation-policies-from-license-manager)\n\nPolicies from License Manager\n\nDiscover the policies a VTEX IO app can use from License Manager resources.\n\nIn order for a VTEX IO app to access external resources, it requires authorization through policies declared in its [manifest.json file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-manifest). One type of external resource available is the [License Manager resources](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3), which can be authorized to access by declaring the resource’s **Key** in the `policies` list of the app. For instance, by adding `Sku.aspx` to the `policies` list, your app gains permission to read SKUs from the Catalog.\n\n`1\n\n{ \n\n2\n\n \"$schema\": \"https://raw.githubusercontent.com/vtex/node-vtex-api/master/gen/manifest.schema\", \n\n3\n\n \"name\": \"app-name\", \n\n4\n\n \"vendor\": \"vendor\", \n\n5\n\n \"version\": \"0.0.0\", \n\n6\n\n \"title\": \"VTEX IO App\", \n\n7\n\n \"description\": \"\", \n\n8\n\n \"dependencies\": {}, \n\n9\n\n \"builders\": {...}, \n\n10\n\n \"scripts\": {...}, \n\n11\n\n \"policies\": [ \n\n12\n\n { \n\n13\n\n \"name\": \"Sku.aspx\" \n\n14\n\n }, \n\n15\n\n { \n\n16\n\n \"name\": \"outbound-access\", \n\n17\n\n \"attrs\": { \n\n18\n\n \"host\": \"{{account}}.vtexcommercestable.com.br\", \n\n19\n\n \"path\": \"/arquivos/favicon.ico\" \n\n20\n\n } \n\n21\n\n } \n\n22\n\n ] \n\n23\n\n} \n\n`\n\n> Note that License Manager policies are declared in a different way than outbound-access policies. While outbound-access policies require the explicit host and path for each resource, License Manager policies operate based on predefined roles.\n\nBelow is a table listing the role-based VTEX IO policies for the License Manager resources. The table indicates which [Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients) the policy is associated with.\n\n| Name | Key | Description | Client | Resources |\n| ---------------------------- | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| Product management | ProdutoForm.aspx | View the registration screen and product change. | catalog | {{account}}.vtexcommercestable.com.br/api/catalog\\_system/pvt/products/\\* |\n| Product and SKU Management | ManterFormularioProdutoSku | Change and inclusion of product and SKU. | catalog | {{account}}.vtexcommercestable.com.br/api/catalog\\_system/pvt/products/\\* |\n| Brands | Marca.aspx | List all registered brands. | catalog | {{account}}.vtexcommercestable.com.br/api/catalog\\_system/pvt/brand/list |\n| SKUs | Sku.aspx | Lists all registered SKUs. | catalog | {{account}}.vtexcommercestable.com.br/api/catalog\\_system/pvt/sku/\\* |\n| Orders Full Access | AcessaTodosPedidos | Reading and writing for all requests via Checkout API. It does not allow access to requests for the flow of the order management module. | checkout | {{account}}.vtexcommercestable.com.br/api/oms/pvt/orders/\\* |\n| Order Cancellation | CancelaPedidos | Cancel orders. | checkout | /api/oms/pvt/orders/{{orderId}}/cancel |\n| Save OrderForm Configuration | SaveOrderFormConfiguration | Save the configuration of shopping carts. | checkout | /api/checkout/pvt/configuration/orderform |\n| Read Shopping Cart | GetOrderForm | Reading and listing all shopping carts. It does not allow access to non-masked cart data. | checkout | /api/checkout/pub/orderform/{{orderFormId}} |\n| Get account by identifier | Get\\_Account\\_By\\_Identifier | Consultation that returns accounts for the identifier, which may be the account ID, host, or name of the account application. | licenseManager | /api/license-manager/account/api/license-manager/pvt/accounts/\\*/api/pvt/accounts/\\*/api/site/pvt/accounts/\\*/api/license-manager/site/pvt/accounts/\\* |\n| Master Data administrator | ADMIN\\_DS | Manage Master Data. | masterData | {{account}}.vtexcommercestable.com.br/\\* |\n| Vbase Read Only | vbase-read-only | Read-only access to VBase. | vbase | /buckets/\\* |\n| Vbase Read Write | vbase-read-write | Read and write access to VBase. | vbase | /buckets/\\* |\n| List Orders | ListOrders | List all orders from the given account. | OMS | /api/oms/pvt/orders |\n\n> If you know about a policy that needs to be described in the table and wants it to be documented, open a request using our [feedback form](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform).\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/concepts/vtex-io-documentation-policies/vtex-io-documentation-policies-from-license-manager.md)\n\n[VTEX Resource Name (VRN)« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager//docs/guides/vtex-io-documentation-vrn)[A/B testsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager//docs/guides/ab-tests)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/concepts/vtex-io-documentation-policies/vtex-io-documentation-policies-from-license-manager.md)\n\nCopy page\n\nOn this page\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_967602ea
|
[
{
"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 session 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/session-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/session-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/session-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/session-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/session-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/session-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/session-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/session-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/session-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-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/session-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-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/session-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/sdk-overview)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/analytics-overview)\n\n[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/cart-overview)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/search-overview)\n\n[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/session-overview)\n\n[Enabling refresh token on FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/session-enabling-refresh-token)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-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/session-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/session-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/session-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-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/session-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/session-overview/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-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/session-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/session-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-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/session-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-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/session-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/sdk-overview)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/analytics-overview)\n\n[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/cart-overview)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/search-overview)\n\n[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/session-overview)\n\n[Enabling refresh token on FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/session-enabling-refresh-token)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-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/session-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/session-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/session-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-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/session-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/session-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/session-overview/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/sdk-overview)\n\nSession\n\nThe Session module manages the state of session-related information in the customer's browser, including currency, channel, localization, and customer data. It ensures session validation and synchronization with the shopping cart, providing a consistent and up-to-date shopping experience.\n\n## Session object structure\n\nYou can see details of the session data managed by the module below.\n\n### Session\n\n| **Field** | **Type** | **Description** |\n| -------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| addressType | string | Specifies the type of address associated with the session. Possible values are: shipping (delivery addresses), billing (payment addresses), or null if not specified. |\n| b2b | object | Contains B2B information. See \\[B2B\\] for more details. |\n| channel | string | Indicates the sales channel associated with the session. |\n| country | string | Indicates the country associated with the session in a three-letter ISO code (example: USA). |\n| currency | object | Contains currency details for the session. See [Currency](#currency) for more information. |\n| geoCoordinates | object | Contains geographical coordinates for the user session. See [GeoCoordinates](#geocoordinates) for details. |\n| locale | string | Indicates the locale of the session, including language and region (example: \"en-US\"). |\n| person | object | Contains information about the customer. See \\[Person\\] for details. |\n| postalCode | string | Indicates the postal code associated with the session. |\n\n#### `b2b`\n\n| **Field** | **Type** | **Description** |\n| ---------- | -------- | ---------------------------------------------------------- |\n| customerID | String | Identifies the buyer organization the customer belongs to. |\n\n#### `geoCoordinates`\n\n| **Field** | **Type** | **Description** |\n| --------- | -------- | ---------------------------------------------------------------- |\n| latitude | number | Indicates the latitude coordinate of the geographical location. |\n| symbol | number | Indicates the longitude coordinate of the geographical location. |\n\n#### `currency`\n\n| **Field** | **Type** | **Description** |\n| --------- | -------- | ---------------------------------------------------------------------- |\n| code | String | Indicates the currency code in three-letter ISO format (example: USD). |\n| symbol | String | Indicates the symbol associated with the currency (example: $). |\n\n#### `person`\n\n| **Field** | **Type** | **Description** |\n| ---------- | -------- | ------------------------------------------------------------------------- |\n| id | String | Provides the customer identifier, if available in the ecommerce platform. |\n| email | String | Stores the email address provided by the customer. |\n| givenName | String | Contains the customer’s first name. |\n| familyName | String | Contains the customer’s last name. |\n\n## Import\n\nThe Session module exports a `createSessionStore` function and `Session` type, which you can import like this:\n\n`1\n\nimport { createSessionStore } from '@faststore/sdk' \n\n2\n\nimport type { Session } from '@faststore/sdk' \n\n`\n\n## Usage\n\nThe following example demonstrates how to manage a session using `createSessionStore`.\n\n* The `createSessionStore` function initializes a session store with the provided default session and an optional validation function.\n* The `validateSession` function sends the current session data to the [FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview) for validation and returns the validated session.\n\n`` 1\n\n \n2\n\nimport { gql } from '@faststore/graphql-utils' \n\n3\n\nimport { createSessionStore } from '@faststore/sdk' \n\n4\n\nimport { useMemo } from 'react' \n\n5\n\nimport type { Session } from '@faststore/sdk' \n\n6\n\n \n7\n\nimport storeConfig from 'store.config' \n\n8\n\n \n9\n\nimport { cartStore } from '../cart' \n\n10\n\nimport { request } from '../graphql/request' \n\n11\n\nimport { createValidationStore, useStore } from '../useStore' \n\n12\n\nimport type { \n\n13\n\n ValidateSessionMutation, \n\n14\n\n ValidateSessionMutationVariables, \n\n15\n\n} from '../../../@generated/graphql/index' \n\n16\n\n \n17\n\nexport const mutation = gql` \n\n18\n\n mutation ValidateSession($session: IStoreSession!, $search: String!) { \n\n19\n\n validateSession(session: $session, search: $search) { \n\n20\n\n locale \n\n21\n\n channel \n\n22\n\n country \n\n23\n\n postalCode \n\n24\n\n currency { \n\n25\n\n code \n\n26\n\n symbol \n\n27\n\n } \n\n28\n\n person { \n\n29\n\n id \n\n30\n\n email \n\n31\n\n givenName \n\n32\n\n familyName \n\n33\n\n } \n\n34\n\n } \n\n35\n\n } \n\n36\n\n` \n\n37\n\n \n38\n\nexport const validateSession = async (session: Session) => { \n\n39\n\n const data = await request< \n\n40\n\n ValidateSessionMutation, \n\n41\n\n ValidateSessionMutationVariables \n\n42\n\n >(mutation, { session, search: window.location.search }) \n\n43\n\n \n44\n\n return data.validateSession \n\n45\n\n} \n\n46\n\n \n47\n\nconst [validationStore, onValidate] = createValidationStore(validateSession) \n\n48\n\n \n49\n\nconst defaultStore = createSessionStore(storeConfig.session, onValidate) \n\n50\n\n \n51\n\nexport const sessionStore = { \n\n52\n\n ...defaultStore, \n\n53\n\n set: (val: Session) => { \n\n54\n\n defaultStore.set(val) \n\n55\n\n \n56\n\n // Trigger cart revalidation when session changes \n\n57\n\n cartStore.set(cartStore.read()) \n\n58\n\n }, \n\n59\n\n} \n\n60\n\n \n61\n\nexport const useSession = () => { \n\n62\n\n const session = useStore(sessionStore) \n\n63\n\n const isValidating = useStore(validationStore) \n\n64\n\n \n65\n\n return useMemo( \n\n66\n\n () => ({ \n\n67\n\n ...session, \n\n68\n\n isValidating, \n\n69\n\n }), \n\n70\n\n [isValidating, session] \n\n71\n\n ) \n\n72\n\n} \n\n ``\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/sdk/session/overview.mdx)\n\n[useSearch« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/search-use-search)[Enabling refresh token on FastStoreNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/session-enabling-refresh-token)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Session object structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/session-overview%23session-object-structure)\n\n[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/session-overview%23session)\n\n[Import](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/session-overview%23import)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/session-overview%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/faststore/docs/sdk/session/overview.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Session object structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/session-overview%23session-object-structure)\n\n[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/session-overview%23session)\n\n[Import](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/session-overview%23import)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/session-overview%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_88b77f53
|
[
{
"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 multilevel omnichannel inventory 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/multilevel-omnichannel-inventory/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/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/multilevel-omnichannel-inventory/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/multilevel-omnichannel-inventory/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/multilevel-omnichannel-inventory/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/multilevel-omnichannel-inventory/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/multilevel-omnichannel-inventory/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/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/multilevel-omnichannel-inventory/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n[VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/vtex-shipping-network)\n\n[VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/vtex-tracking)\n\n[VTEX Pick and Pack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/vtex-pick-and-pack)\n\n[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/multilevel-omnichannel-inventory)\n\n[Multilevel omnichannel inventory API integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/multilevel-omnichannel-inventory-api-integration)\n\n[Change chain orders in external marketplaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces)\n\n[Pickup point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/setting-up-white-label-seller-as-pickup-point)\n\n[Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/delivery-promise)\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/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/multilevel-omnichannel-inventory/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/multilevel-omnichannel-inventory/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/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/multilevel-omnichannel-inventory/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n[VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/vtex-shipping-network)\n\n[VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/vtex-tracking)\n\n[VTEX Pick and Pack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/vtex-pick-and-pack)\n\n[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/multilevel-omnichannel-inventory)\n\n[Multilevel omnichannel inventory API integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/multilevel-omnichannel-inventory-api-integration)\n\n[Change chain orders in external marketplaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces)\n\n[Pickup point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/setting-up-white-label-seller-as-pickup-point)\n\n[Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/delivery-promise)\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/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/multilevel-omnichannel-inventory/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/multilevel-omnichannel-inventory/docs/guides)\n\nLogistics\n\n[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/multilevel-omnichannel-inventory)\n\nMultilevel Omnichannel Inventory\n\nA [marketplace](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tutorial/estrategias-de-marketplace-na-vtex--tutorials%5F402) is the environment where the product is sold, or the storefront. The [seller](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/estrategias-de-marketplace-na-vtex--tutorials%5F402%23selling-on-marketplaces) owns the product and is responsible for fulfillment. [VTEX promotes digital collaboration](https://read.calvincode.net/reader?url=https://vtex.com/us-en/ecommerce-marketplace/) by allowing multiple combinations of architecture between these two entities. One of these combinations is called [Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4).\n\n_Multilevel Omnichannel Inventory_ is the VTEX setting that allows [franchises](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/o-que-e-conta-franquia--kWQC6RkFSCUFGgY5gSjdl) or [white label sellers](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/white-label-seller--5orlGHyDHGAYciQ64oEgKa)' inventory to be sold in marketplaces to which the main account is connected.\n\nFor VTEX sellers, this means being able to sell products from its franchises or white label sellers in a marketplace, without the need to set up the integration with the desired marketplace for all franchise stores, and white label sellers.\n\nFor marketplaces, this means selling products from its direct sellers and also physical stores and white label sellers associated with those sellers in a scalable way.\n\nThis article covers the account architecture details, chain order flows and necessary settings for VTEX marketplaces to implement this feature via API.\n\n> To know how to implement this feature via VTEX Admin, along with benefits and restrictions around the use of Multilevel Omnichannel Inventory, check out our [Multilevel Omnichannel Inventory Help article](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4).\n\n## Account architecture\n\nWhen a store sells its products in a marketplace, we have a one-level relationship between seller and marketplace. However, VTEX's architecture allows stores to act as both sellers and marketplaces, expanding the number of possible combinations.\n\nStores that have white label sellers and franchises are marketplaces to those accounts. But they can also be connected to other VTEX marketplaces, becoming sellers themselves. In this case, we have a three level architecture, as illustrated in the image below.\n\n\n\n* **Marketplace (level 1):** storefront where the product is sold and order is placed.\n* **Direct seller (level 2):** main account, integrated to the marketplace level 1\\. Serves as a marketplace for white label sellers, franchise accounts and physical stores connected to it.\n* **Franchise accounts/physical stores (level 3):** owns the product, and is responsible for fulfillment. Connected as white label sellers to the main account.\n\nWith the Multilevel Omnichannel Inventory setting, all franchise accounts and white label sellers (level 3) are already fully integrated to a store's main account (level 2). This means that when the main account sets up an integration with an other marketplace (level 1), the franchise accounts can be integrated as well, no longer being necessary to manage each franchise individually in order to set up its integration with the marketplace (level 1).\n\n> This feature is valid just for [VTEX marketplaces](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tutorial/marketplace-strategies-at-vtex--tutorials%5F402%23ser-um-marketplace-vtex).\n\n## Order flow\n\nThe Multilevel Omnichannel Inventory also affects an order's flow. The 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. The table below summarizes all types of order flows that VTEX supports.\n\n| **Order source and destination** | **Order type and workflow** |\n| ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| VTEX store is the **source** of an order → | [Marketplace order](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/fluxo-e-status-de-pedidos--tutorials%5F196%23marketplace-flow)with Checkout Workflow. |\n| VTEX store is **intermediate** in the order flow → | [Chain order](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/fluxo-e-status-de-pedidos--tutorials%5F196%23chain-flow)with Chain Workflow. |\n| VTEX store is the **destination** of an order → | [Seller order](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/fluxo-e-status-de-pedidos--tutorials%5F196%23seller-flow)with Fulfillment Workflow. |\n| VTEX store is both the **source** and the **destination** → | [Complete order](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/fluxo-e-status-de-pedidos--tutorials%5F196%23complete-flow)flow with Fulfillment workflow. |\n\nThe Multilevel Omnichannel Inventory setting allows the entire inventory from a physical store network to be integrated into marketplaces, creating **chain orders**.\n\nLet's break down how chain orders are applied in Multilevel Omnichannel Inventory architecture:\n\n* Order originates in the marketplace (level 1).\n* Order goes through an intermediate agent, in this case, the direct sellers (level 2).\n* Order reaches its destination, to be fulfilled by the white label sellers (level 3).\n\nTherefore, chain orders in direct seller have characteristics that come from both _marketplaces_, because they take the role of a seller's marketplace, and _sellers_, since they are also sellers of a marketplace.\n\nCheck out the order flow for chain orders in the image below:\n\n\n\nThe order flow seen by the level 2 store in a Multilevel Omnichannel Inventory is similar to the marketplace order flow, except for receiving the payment for orders. In the Payment pending stage, instead of the chain receiving payment directly from the gateway, the marketplace informs the chain it has received the payment confirmation.\n\n> VTEX stores cannot use the [change order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order) feature for chain orders made on VTEX marketplaces.\n\n## Setup for VTEX marketplaces\n\nThe setup for Multilevel Omnichannel Inventory must be made by the marketplace [through their VTEX Admin](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) or REST API. This setup can be made in sellers that are already integrated, or sellers being added for the first time.\n\nTo configure Multilevel Omnichannel Inventory via REST API:\n\n1. The marketplace must call the endpoint [Configure Seller Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis%23post-/seller-register/pvt/sellers).\n2. Fill the `fulfillmentEndpoint` field with the seller's checkout endpoint, following the example below: \n`1 \nhttps://{{sellerAccount}}.vtexcommercestable.com.br/api/checkout?affiliateid={{affiliateId}}&sc={{salesChannel}} \n`\n3. Replace the placeholders with the following values: \n * **sellerAccount**: [Account name](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tutorial/o-que-e-account-name--i0mIGLcg3QyEy8OCicEoC) of the seller in VTEX. \n * **affiliateId**: 3-digit [afiliate](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tutorial/o-que-e-afiliado--4bN3e1YarSEammk2yOeMc0) identification code created by the seller. The seller must inform this ID to the marketplace so that the marketplace can complete the configuration process. \n * **salesChannel**: Sales channel (or [trade policy](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/como-funciona-uma-politica-comercial--6Xef8PZiFm40kg2STrMkMV%23master-data) associated to the seller account created. The seller must inform this ID to the marketplace so that the marketplace can complete the configuration process.\n\nContributors\n\n5\n\n[](https://github.com/anabaarbosa)\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/jumeyermattosarruda)\n\n[](https://github.com/Isabella-Veloso)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Fulfillment/multilevel-omnichannel-inventory/multilevel-omnichannel-inventory.md)\n\n[VTEX Pick and Pack Carrriers Integration Protocol« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory//docs/guides/vtex-pick-and-pack-carriers-integration-protocol)[Multilevel omnichannel inventory API integrationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory//docs/guides/multilevel-omnichannel-inventory-api-integration)\n\nContributors\n\n5\n\n[](https://github.com/anabaarbosa)\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/jumeyermattosarruda)\n\n[](https://github.com/Isabella-Veloso)\n\nON THIS PAGE\n\n[Account architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/multilevel-omnichannel-inventory%23account-architecture)\n\n[Order flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/multilevel-omnichannel-inventory%23order-flow)\n\n[Setup for VTEX marketplaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/multilevel-omnichannel-inventory%23setup-for-vtex-marketplaces)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Fulfillment/multilevel-omnichannel-inventory/multilevel-omnichannel-inventory.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Account architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/multilevel-omnichannel-inventory%23account-architecture)\n\n[Order flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/multilevel-omnichannel-inventory%23order-flow)\n\n[Setup for VTEX marketplaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/multilevel-omnichannel-inventory%23setup-for-vtex-marketplaces)\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_97261a1e
|
[
{
"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 alert 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-alert/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-alert/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-alert/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-alert/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-alert/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-alert/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-alert/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-alert/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-alert/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/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-alert/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/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-alert/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/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-alert/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-alert/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-alert/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-alert/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/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-alert/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-alert/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/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-alert/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-alert/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/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-alert/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/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-alert/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/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-alert/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-alert/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-alert/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-alert/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/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-alert/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-alert/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-alert/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/components-index)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-overview)\n\nAlert\n\nDisplays short messages related to the behavior of a system, feature, or page.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/Alert)\n\nExample\n\nCode\n\nDismissible Alert message\n\n[With Link](#)\n\nAlert message\n\n[With Link](#)\n\nIcon with Alert message\n\nAlert message\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { Alert } 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/Alert/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### Dismissible\n\nExample\n\nCode\n\nGet 10% off today: NEW10\n\n### With Link\n\nExample\n\nCode\n\nGet 10% off today: NEW10\n\n[Buy now](#)\n\n### With Icon\n\nExample\n\nCode\n\nGet 10% off today: NEW10\n\n### Plain\n\nExample\n\nCode\n\nGet 10% off today: NEW10\n\n---\n\n## Design tokens\n\n| Local token | Default value/Global token linked |\n| ------------------------- | --------------------------------- |\n| \\--fs-alert-height | var(--fs-spacing-7) |\n| \\--fs-alert-padding-left | var(--fs-spacing-3) |\n| \\--fs-alert-padding-right | var(--fs-alert-padding-left) |\n| \\--fs-alert-bkg-color | var(--fs-color-highlighted-bkg) |\n| \\--fs-alert-text-color | var(--fs-color-highlighted-text) |\n| \\--fs-alert-text-size | var(--fs-text-size-1) |\n\n### Desing tokens: Icon\n\n| Local token | Default value/Global token linked |\n| ----------------------------- | --------------------------------- |\n| \\--fs-alert-icon-width | var(--fs-spacing-4) |\n| \\--fs-alert-icon-height | var(--fs-alert-icon-width) |\n| \\--fs-alert-icon-margin-right | var(--fs-spacing-1) |\n| \\--fs-alert-icon-color | var(--fs-alert-text-color) |\n\n### Desing tokens: Link\n\n| Local token | Default value/Global token linked |\n| ------------------------------ | --------------------------------- |\n| \\--fs-alert-link-color | var(--fs-alert-text-color) |\n| \\--fs-alert-link-color-visited | var(--fs-alert-text-color) |\n\n### Design tokens: Dismissible\n\n| Local token | Default value/Global token linked |\n| -------------------------------- | --------------------------------- |\n| \\--fs-alert-button-text-color | var(--fs-alert-text-color) |\n| \\--fs-alert-button-bkg-color | var(--fs-alert-bkg-color) |\n| \\--fs-alert-button-border-radius | var(--fs-border-radius) |\n\n---\n\n## Data attributes\n\nYou can target and override `Alert` styles using the following data attributes:\n\n`data-fs-alert`\n\n`data-fs-alert-content`\n\n`data-fs-alert-link`\n\n`data-fs-alert-button`\n\n`data-fs-alert-dismissible=\"true\"`\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-alert | | | | | | |\n| **icon** | string \\| number | false | true | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | Icon component for additional customization. |\n| **dismissible** | false \\| true | Enables dismissible feature. | | | | | | | |\n| **link** | LinkProps<\"a\"> | Extends all Link Props. | | | | | | | |\n| **onClose** | (event: MouseEvent<HTMLElement, MouseEvent>) => void | Function called when dismiss button is clicked. | | | | | | | |\n\n---\n\n## Best Practices\n\n### ✅ Do's\n\n* Write short messages to inform about the behavior of a system, feature, or page. Consider using 30 to 40 characters max.\n\n### ❌ Don'ts\n\n* Don't use long texts. Important information can be lost.\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/alert.mdx)\n\n[Accordion« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-accordion)[BreadcrumbNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-breadcrumb)\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-alert/docs/guides/faststore/molecules-alert%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23examples)\n\n[Dismissible](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23dismissible)[With Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23with-link)[With Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23with-icon)[Plain](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23plain)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23design-tokens)\n\n[Desing tokens: Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23desing-tokens-icon)[Desing tokens: Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23desing-tokens-link)[Design tokens: Dismissible](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23design-tokens-dismissible)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23props)\n\n[Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23best-practices)\n\n[✅ Do's](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23-dos)[❌ Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23-donts)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/molecules/alert.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-alert/docs/guides/faststore/molecules-alert%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23examples)\n\n[Dismissible](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23dismissible)[With Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23with-link)[With Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23with-icon)[Plain](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23plain)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23design-tokens)\n\n[Desing tokens: Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23desing-tokens-icon)[Desing tokens: Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23desing-tokens-link)[Design tokens: Dismissible](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23design-tokens-dismissible)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23props)\n\n[Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23best-practices)\n\n[✅ Do's](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23-dos)[❌ Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-alert/docs/guides/faststore/molecules-alert%23-donts)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_f0fe0c73
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX checkout ui settings app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.checkout-ui-custom)\n\n[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.messages)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/guides/affiliates-program-app)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.checkout-ui-custom)\n\n[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.messages)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/guides/affiliates-program-app)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/vtex-io-apps)\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/guides/functional-apps)\n\nCheckout UI Settings\n\nOfficial extension\n\nVersion: 0.1.0\n\nLatest version: 0.1.0\n\nThe Checkout UI Settings app is responsible for **customizing your store's Checkout UI through scripts**.\n\nThe main advantage of using the app instead of the [store's admin](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/configure-template-in-smartcheckout-update--ToTE5XB39t0SwtHgpgwSv?locale=en) for this customization is that your Checkout scripts will behave as configurations for platform apps.\n\nIn practice, it means that Checkout UI Settings allows A/B testing in your store's scripts, in addition to the possibility of quick rollbacks for old scripts (i.e. scripts pertaining to older Checkout UI Settings app's versions).\n\n## Configuration\n\n1. Using your terminal and the [VTEX IO Toolbelt](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/development/vtex-io-cli-installment-and-command-reference), log into the desired account;\n2. Run `vtex list` to access the list of apps that are already installed on the account you're working on. If the Checkout UI Settings option already exists, you can skip to step 7 of this step-by-step;\n3. If the Checkout UI Settings app was not found in the list of installed apps, run the `vtex init` command;\n4. Select the `checkout-ui-settings` option;\n5. Open the `checkout-ui-settings` app in whichever code editor you prefer;\n6. In the `manifest.json` file, change the predefined default value `vendor` to the name of the account in which you want to install the app;\n7. In the `checkout-ui-custom` folder, create the files in which the scripts will be included, just as you would do in the [admin's interface](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/configure-template-in-smartcheckout-update--ToTE5XB39t0SwtHgpgwSv?locale=en%23configure-code). Notice that a few defaults files already exist in the `checkout-ui-custom` folder, files which you can use to insert the scripts;\n8. According to the Checkout customization you are looking for, open the most suitable file and insert the desired scripts;\n9. Save your changes. Then, [publish](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/development/publishing-an-app) the app's new version;\n10. Still logged into the desired account, [create a production workspace](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/development/creating-a-production-workspace) and [install the app](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/development/installing-an-app);\n11. If everything is working as expected, [promote the workspace to master](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/development/promoting-a-workspace-to-master).\n\n## Modus Operandi\n\nOnce the app is deployed and installed in the account, every scripts contained in it will be automatically linked to your store and used to [build the templates](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/configure-template-in-smartcheckout-update--ToTE5XB39t0SwtHgpgwSv?locale=en%23configuring-templates-from-the-code-menu) to customize your Checkout.\n\n:warning: **Scripts used by Checkout are linked to the Checkout UI Settings version that's installed in your store**. If a prior app version was already installed and your want to change the scripts linked to it, you'll need to repeat the already existing code and thereafter launch the app's new version containing the changes you just did. Housekeeper is responsible for updating app versions in the accounts it's installed in.\n\n[Checkout UI Custom« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.checkout-ui-custom)[MessagesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.messages)\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-ui-settings/docs/apps/vtex.checkout-ui-settings%23configuration)\n\n[Modus Operandi](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-ui-settings/docs/apps/vtex.checkout-ui-settings%23modus-operandi)\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_ea18b902
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides setting up the zoom in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom/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/setting-up-the-zoom/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom/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/setting-up-the-zoom/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/setting-up-the-zoom/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/setting-up-the-zoom/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/setting-up-the-zoom/docs/guides/setting-up-the-zoom)\n\n[Creating gift lists](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom/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/setting-up-the-zoom/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/setting-up-the-zoom/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/setting-up-the-zoom/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/setting-up-the-zoom/docs/guides/configure-the-price-history-control)\n\n[Shelf template controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom/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/setting-up-the-zoom/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/setting-up-the-zoom/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom/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/setting-up-the-zoom/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom/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/setting-up-the-zoom/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/setting-up-the-zoom/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/setting-up-the-zoom/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/setting-up-the-zoom/docs/guides/setting-up-the-zoom)\n\n[Creating gift lists](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom/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/setting-up-the-zoom/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/setting-up-the-zoom/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/setting-up-the-zoom/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/setting-up-the-zoom/docs/guides/configure-the-price-history-control)\n\n[Shelf template controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom/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/setting-up-the-zoom/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/setting-up-the-zoom/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom/docs/storefront-development)\n\n(Legacy) CMS Portal\n\n[Setting up the zoom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom/docs/guides/setting-up-the-zoom)\n\nSetting up the zoom\n\nA tool very commonly used in online stores is the zoom.\n\nIt allows the customer to see a detailed image by passing the mouse over a photo of the product. Let us see how to set up and implement this function.\n\n\n\n## Setting up the CSS\n\nThe first thing to do is to set up the CSS of the page to be opened with an approximate image of the product at the moment the user passes the mouse over the photos of the product. To do this, save a file with the CSS of the page and upload it to your store’s server.\n\nBelow we reproduce an excerpt of CSS that you can use as a starting point for this purpose. Copy and paste it into a text editor and save it as “zoom.css”, for example.\n\n`1\n\n.zoomPad{position:relative;float:left;z-index:99;cursor:crosshair} .zoomPreload{-moz-opacity:.8;opacity:.8;filter:alpha(opacity=80);color:#333;font-size:12px;font-family:Tahoma;text-decoration:none;border:1px solid #CCC;background-color:#fff;padding:8px;text-align:center;background-image:url(/arquivos/ajax-loader.gif);background-repeat:no-repeat;background-position:center center;z-index:110;width:100%;height:100%;position:absolute;top:0;left:0;} .zoomPup{overflow:hidden;background-color:#FFF;-moz-opacity:.6;opacity:.6;filter:alpha(opacity=60);z-index:120;position:absolute;border:1px solid #CCC;z-index:101;cursor:crosshair} .zoomOverlay{position:absolute;left:0;top:0;background:#FFF;z-index:5000;width:100%;height:100%;display:none;z-index:101} .zoomWindow{position:absolute; left:445px !important; top:40px; background:#FFF; z-index:6000; height:auto; z-index:10000; z-index:110;} .zoomWrapper{position:relative;border:1px solid #999;z-index:110; width:531px !important; height:400px !important;} .zoomWrapperTitle{display:block;background:#999;color:#FFF;height:18px;line-height:18px;width:100%;overflow:hidden;text-align:center;font-size:10px;position:absolute;top:0;left:0;z-index:120;-moz-opacity:.6;opacity:.6;filter:alpha(opacity=60)} .zoomWrapperImage{display:block;position:relative;overflow:hidden;z-index:110; height:400px !important;} .zoomWrapperImage img{border:0;display:block;position:absolute;z-index:101} .zoomIframe{z-index:-1;filter:alpha(opacity=0);-moz-opacity:.8;opacity:.8;position:absolute;display:block} \n\n`\n\nNext we are going to send the saved CSS file to the server. To do this, click on **CMS** \\> Access **Layout** \\> Click on **CMS** folder > Access **Files Manager** \\> Access **.css** \\> in the window that opens on the right, click on **Add**.\n\nThen find the CSS file you saved and send it to the server, clicking on **Localizar** (\"Find\") and then on **Salvar arquivo** (\"Save File\")\n\n\n\nYour file will then be listed in the window, as shown above.\n\n## Activate the zoom in the page template\n\nOnce you have done the above, you have to insert a control to activate the zoom on the product page template. This process also takes place in the **CMS**, but this time you have to locate the product page template, which should be in the **CMS** folder > **HTML Templates**. When you have located the template, you must enter the reference for the .css file we have just uploaded.\n\nFor this, you must include a tag such as `<link href=\"/files/zoom.css\" rel=\"stylesheet\" type=\"text/css\">` in the head template, as we would do with any other .css file.\n\nNow all you have to do is insert `zoom=\"on\"` in the product tag, like this:`<vtex.cmc:ProductImage zoom=\"on\">`\n\n## Working conditions\n\nYou also have to set up the standard size for the zoom image. You can do this in **CMS** module > **Settings** \\> **File Types**. By default, this type of zoom image is set up with 1000×1000 pixels.\n\n\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/setting-up-the-zoom.md)\n\n[List of controls for templates« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom//docs/guides/list-of-controls-for-templates)[Creating gift listsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom//docs/guides/creating-gift-lists)\n\nContributors\n\n1\n\n[](https://github.com/jumeyermattosarruda)\n\nON THIS PAGE\n\n[Setting up the CSS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom/docs/guides/setting-up-the-zoom%23setting-up-the-css)\n\n[Activate the zoom in the page template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom/docs/guides/setting-up-the-zoom%23activate-the-zoom-in-the-page-template)\n\n[Working conditions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom/docs/guides/setting-up-the-zoom%23working-conditions)\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/setting-up-the-zoom.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Setting up the CSS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom/docs/guides/setting-up-the-zoom%23setting-up-the-css)\n\n[Activate the zoom in the page template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom/docs/guides/setting-up-the-zoom%23activate-the-zoom-in-the-page-template)\n\n[Working conditions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-zoom/docs/guides/setting-up-the-zoom%23working-conditions)\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_dcbd0cef
|
[
{
"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 what is a vtex app in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/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-what-is-a-vtex-app/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/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-what-is-a-vtex-app/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/app-development)\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\nWhat is a VTEX App\n\nA VTEX App extends the functionalities of the VTEX platform, helping merchants create comprehensive experiences for different layers of digital commerce, such as:\n\n* Marketing and affiliate programs\n* Reviews, ratings, and analytics\n* Customer support and notifications\n* Marketplaces and channels\n* Finance and taxes\n* Logistics and productivity\n* Privacy and security\n* Store design\n\nFrom enhancing storefronts to composing the VTEX Admin, VTEX Apps can be as unique as possible. VTEX Apps are available for download at the [VTEX App Store](https://read.calvincode.net/reader?url=https://apps.vtex.com/), and they can be either free or paid.\n\n## VTEX App Store\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 to be downloaded by clients and partners.\n\n## How to use VTEX Apps?\n\nYou can use VTEX Apps to:\n\n* Connect to VTEX Commerce APIs and integrate with VTEX modules.\n* Integrate third-party solutions to the VTEX IO platform.\n* Extend the native VTEX admin.\n* Enhance storefront components with the [VTEX Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-store-framework).\n* Speed up connections with Storefront and Admin apps.\n\n## Developing apps\n\nAs a developer, you can develop your own VTEX Apps. VTEX Apps are built and deployed to the VTEX platform with [VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io). Hence, by learning VTEX IO, you can create unique digital commerce experiences.\n\nNotice that, besides developing custom solutions for the VTEX ecosystem, you can also publish and share your apps with VTEX merchants on the VTEX App Store, helping them leverage their business. Check out [how to become a registered VTEX App Store developer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer). For more information about developing apps in this context, please refer to the [VTEX App Store section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-app-store).\n\n### Types of apps\n\nCustom apps complete business solutions, addressing pain points from real customers. With VTEX IO, it's possible to develop:\n\n* **[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):** React components that compose the [storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-store-framework) \\- works as an open beta.\n* **[Admin apps](https://read.calvincode.net/reader?url=https://learn.vtex.com/docs/course-admin-lang-en):** Modules and functionalities for the [VTEX Admin](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/vtex-admin-start-here--531cHtUCUi3puRXNDmKziw) \\- works as a closed beta.\n* **[Backend apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service):** Node or .NET Core services that speed up connections with Storefront or Admin apps - works as a closed beta.\n* **[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps):** Integrations that collect user data for a third-party service - works as a closed beta.\n* **[Edition apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app):** Bundle of settings, policies, backend and frontend apps encapsulated and exported by a [Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account).\n\nA VTEX App can also be characterized as:\n\n* **Private**: Apps that are not published on the VTEX App Store. They can be installed in multiple accounts, according to their **allowed list**.\n* **Public**: Apps published on the VTEX App Store.\n* **Single-account**: Apps designed to run for a single account, i.e., in a single store.\n* **Multi-account**: Apps designed to run in multiple accounts, i.e., different stores. The vendor’s responsibility is to handle account isolation properly in the application layer.\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/Getting-Started/vtex-io-documentation-what-is-a-vtex-app.md)\n\n[What is VTEX IO« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app//docs/guides/vtex-io-documentation-what-is-vtex-io)[Governance and shared security in VTEX IO appsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app//docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\nSee also\n\n[Developing an appApp Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/vtex-io-documentation-developing-an-app)[ConceptsApp Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/concepts)[App Store GuidelinesApp Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/vtex-io-documentation-what-is-a-vtex-app%23vtex-app-store)\n\n[How to use VTEX Apps?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/vtex-io-documentation-what-is-a-vtex-app%23how-to-use-vtex-apps)\n\n[Developing apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/vtex-io-documentation-what-is-a-vtex-app%23developing-apps)\n\n[Types of apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/vtex-io-documentation-what-is-a-vtex-app%23types-of-apps)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Getting-Started/vtex-io-documentation-what-is-a-vtex-app.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/vtex-io-documentation-what-is-a-vtex-app%23vtex-app-store)\n\n[How to use VTEX Apps?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/vtex-io-documentation-what-is-a-vtex-app%23how-to-use-vtex-apps)\n\n[Developing apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/vtex-io-documentation-what-is-a-vtex-app%23developing-apps)\n\n[Types of apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app/docs/guides/vtex-io-documentation-what-is-a-vtex-app%23types-of-apps)\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_302adb97
|
[
{
"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 enable the remarks field in the order screen 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/enable-the-remarks-field-in-the-order-screen/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-remarks-field-in-the-order-screen/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-remarks-field-in-the-order-screen/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-remarks-field-in-the-order-screen/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/docs/guides/enable-cart-transfer-between-devices)\n\n[Force stock availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/docs/guides/enable-partial-cancellation)\n\n[Hide cancellation buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-remarks-field-in-the-order-screen/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-remarks-field-in-the-order-screen/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-remarks-field-in-the-order-screen/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-remarks-field-in-the-order-screen/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-remarks-field-in-the-order-screen/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-remarks-field-in-the-order-screen/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-remarks-field-in-the-order-screen/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-remarks-field-in-the-order-screen/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-remarks-field-in-the-order-screen/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/docs/guides/enable-cart-transfer-between-devices)\n\n[Force stock availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/docs/guides/enable-partial-cancellation)\n\n[Hide cancellation buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/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/enable-the-remarks-field-in-the-order-screen/docs/guides/how-to-customize-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/enable-the-remarks-field-in-the-order-screen/docs/guides/enable-the-remarks-field-in-the-order-screen)\n\nEnable the Observation field in the order screen\n\nLearn how to enable the Observation field in the VTEX Sales App order screen to capture additional order information.\n\nThe VTEX Sales App allows the use of an **Observation** field, where you can store additional information regarding the order.\n\nThe information entered in this field is sent via API to the Order Management System. It populates the `openTextField` field, which can be retrieved later either in the VTEX Admin or through an [Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api) call.\n\n> To activate the Observation field on the order screen, open a [support ticket with VTEX](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support) requesting this feature.\n\nContributors\n\n4\n\n[](https://github.com/Isabella-Veloso)\n\n[](https://github.com/geisecosta)\n\n[](https://github.com/carolinamenezes)\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/enable-the-remarks-field-in-the-order-screen.md)\n\n[Define payment methods displayed on VTEX Sales App« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-remarks-field-in-the-order-screen//docs/guides/define-payment-methods-displayed-on-vtex-sales-app)[Enable the sales associate codeNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-remarks-field-in-the-order-screen//docs/guides/sales-associate-code)\n\nContributors\n\n4\n\n[](https://github.com/Isabella-Veloso)\n\n[](https://github.com/geisecosta)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/karenkrieger)\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/enable-the-remarks-field-in-the-order-screen.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_f74a4901
|
[
{
"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 refresh token flow for headless implementations 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/refresh-token-flow-for-headless-implementations/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/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/refresh-token-flow-for-headless-implementations/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/refresh-token-flow-for-headless-implementations/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/refresh-token-flow-for-headless-implementations/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/refresh-token-flow-for-headless-implementations/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/refresh-token-flow-for-headless-implementations/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/docs/guides/api-usage)\n\n[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/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/refresh-token-flow-for-headless-implementations/docs/guides/making-your-first-request)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/docs/guides/authentication)\n\n[API authentication using API keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/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/refresh-token-flow-for-headless-implementations/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/refresh-token-flow-for-headless-implementations/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/refresh-token-flow-for-headless-implementations/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/refresh-token-flow-for-headless-implementations/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/refresh-token-flow-for-headless-implementations/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/refresh-token-flow-for-headless-implementations/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/refresh-token-flow-for-headless-implementations/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/refresh-token-flow-for-headless-implementations/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/refresh-token-flow-for-headless-implementations/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/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/refresh-token-flow-for-headless-implementations/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/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/refresh-token-flow-for-headless-implementations/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/refresh-token-flow-for-headless-implementations/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/docs/guides/api-usage)\n\n[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/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/refresh-token-flow-for-headless-implementations/docs/guides/making-your-first-request)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/docs/guides/authentication)\n\n[API authentication using API keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/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/refresh-token-flow-for-headless-implementations/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/refresh-token-flow-for-headless-implementations/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/refresh-token-flow-for-headless-implementations/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/refresh-token-flow-for-headless-implementations/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/refresh-token-flow-for-headless-implementations/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/refresh-token-flow-for-headless-implementations/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/refresh-token-flow-for-headless-implementations/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/refresh-token-flow-for-headless-implementations/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/refresh-token-flow-for-headless-implementations/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/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/refresh-token-flow-for-headless-implementations/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/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/refresh-token-flow-for-headless-implementations/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/refresh-token-flow-for-headless-implementations/docs/guides)\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/docs/guides/api-usage)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/docs/guides/authentication)\n\n[Refresh token flow for headless implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/docs/guides/refresh-token-flow-for-headless-implementations)\n\nRefresh token flow for headless implementations\n\nLearn how to implement refresh token in headless stores.\n\nThe refresh token flow is a security mechanism in authentication systems that allows clients to obtain new access tokens without requiring users to reauthenticate.\n\nThis guide explains how to implement the refresh token flow in [headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-commerce) scenarios using native VTEX Login.\n\n> If you are using FastStore, the [FastStore SDK Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/sdk-overview%23session) automatically handles token renewal, session management, and error handling. You only need to follow the instructions in [Enabling refresh token on FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/security-enabling-refresh-token).\n\n## Authentication tokens\n\nThe refresh token flow operates with two types of tokens:\n\n* **Access token (`VtexIdclientAutCookie_{{accountName}}`)**: Short-lived token (24h), the primary credential used to authenticate API requests. It has a short expiration time to minimize security risks.\n* **Refresh token (`vid_rt`)**: Token with configurable expiration, always with a longer duration when compared to the access token (1, 7, or 30 days). Used to renew access tokens.\n\n> Contact VTEX [Support](https://read.calvincode.net/reader?url=https://support.vtex.com/hc/en-us/requests) to request the refresh token activation and expiration time configuration.\n\n## Refresh token flow\n\nWhen the access token expires, but the refresh token is still valid, the client must use the refresh token to request a new access token via a dedicated renewal endpoint. The refresh process also returns a new refresh token, which replaces the previous one.\n\nThe following diagram illustrates the complete refresh token lifecycle, showing how authentication and token renewal work over time.\n\nUser's BrowserVTEX ID29 days later1\\. Login2\\. Cookie: Access token X Cookie: Refresh token A3\\. Reauthenticate with Refresh token A4\\. Cookie: Access token Y Cookie: Refresh token BUser's BrowserVTEX ID\n\nThe following steps detail the refresh token flow shown in the diagram:\n\n1. **Login** \nThe user initiates authentication by logging into the system. VTEX ID processes the login request.\n2. **VTEX ID responds with tokens** \nIf authentication is successful, VTEX ID issues: \n * Access token \n * Refresh token \nThese tokens are stored in cookies during the user's browser session.\n3. **Reauthentication after access token expiration** \nAfter 24 hours, the access token expires. If the refresh token is still valid, the client can automatically obtain a new access token without any additional interaction. \nFor example, if the refresh token has a 30-day lifespan and the user attempts to log in 29 days after their last authentication, the user’s browser sends the refresh token to VTEX ID to obtain a new access token. However, once the 30-day period ends, the refresh token expires, and the user must log in again to generate new access and refresh tokens. \nThis happens automatically when stores use [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework) or [Legacy CMS Portal](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/1oN446gRGcR2s70RvBCAmj). For [headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-commerce) stores, it needs to be manually implemented following the instructions on this guide.\n4. **VTEX ID issues new tokens** \nVTEX ID validates the refresh token and, if it's still valid: \n * Issues a new access token \n * Provides a new refresh token \nThese new tokens replace the old ones in the browser.\n\nThis cycle repeats until the refresh token expires, ensuring uninterrupted user authentication.\n\n## Implementing the refresh token flow\n\nTo implement the refresh token flow in headless stores, use the VTEX ID API endpoints described in the following sections.\n\n### 1\\. Starting authentication\n\nInitiate the authentication flow and obtain an `authenticationToken` by sending a `GET` request to the [Start authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api%23get-/api/vtexid/pub/authentication/start) endpoint.\n\n**Request:**\n\n`1\n\ncurl --location 'https://{{storeDomain}}/api/vtexid/pub/authentication/start?scope={{accountName}}&fingerprint={{fingerprint}} \\ \n\n`\n\n#### **Response body example:**\n\n`1\n\n{ \n\n2\n\n \"authenticationToken\": \"C17BCD635B637E66BF2BBE07CEED0B1B7425387FB8D6E42FE68EBCE7A49193F2\", \n\n3\n\n \"oauthProviders\": [ \n\n4\n\n { \n\n5\n\n \"providerName\": \"Google\", \n\n6\n\n \"className\": \"google-plus\", \n\n7\n\n \"expectedContext\": [] \n\n8\n\n }, \n\n9\n\n { \n\n10\n\n \"providerName\": \"Facebook\", \n\n11\n\n \"className\": \"facebook\", \n\n12\n\n \"expectedContext\": [] \n\n13\n\n } \n\n14\n\n ], \n\n15\n\n \"showClassicAuthentication\": true, \n\n16\n\n \"showAccessKeyAuthentication\": true, \n\n17\n\n \"showPasskeyAuthentication\": false, \n\n18\n\n \"authCookie\": null, \n\n19\n\n \"isAuthenticated\": false, \n\n20\n\n \"selectedProvider\": null, \n\n21\n\n \"samlProviders\": [] \n\n22\n\n} \n\n`\n\n### 2\\. Continuing authentication\n\nAfter starting the authentication process, the next step is to proceed with the login method configured for the store. VTEX ID supports multiple login providers, including:\n\n* Access key (login code sent by email)\n* Email and password\n* Social logins (Google, Facebook)\n* Custom OAuth providers\n\nEach store can enable one or more of these options, and all of which follow the same general flow at this stage: the client uses the `authenticationToken` from the previous step to complete the login process.\n\nIf the store uses **access key** as the login method, you must send a login code to the user's email using a `POST` request to the [Send access key](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api%23post-/api/vtexid/pub/authentication/accesskey/send) endpoint.\n\n**Example request for access key login:**\n\n`1\n\ncurl --location --request POST 'https://{{storeDomain}}/api/vtexid/pub/authentication/accesskey/send?email={{userEmail}}' \\ \n\n2\n\n--header 'Cookie: _vss={{authenticationToken}}' \n\n`\n\nThe expected response is an empty `200 OK`, and the user will instantly receive an email with the access code.\n\n### 3\\. Validating the session\n\nOnce the user has provided their credentials or login code — depending on the login provider configured for the store — you must validate the session to complete authentication and receive the access and refresh tokens.\n\nFor the access key method, use the received access key and the user email to validate the session via a `POST` request to the [Validate session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api%23post-/api/vtexid/pub/authentication/accesskey/validate) endpoint. The request is structured as follows:\n\n**Request:**\n\n`1\n\ncurl --location 'https://{{storeDomain}}/api/vtexid/pub/authentication/accesskey/validate' \\ \n\n2\n\n--header 'Cookie: _vss={{authenticationToken}} \\ \n\n3\n\n--form 'accesskey=\"{{accessKey}}\"' \\ \n\n4\n\n--form 'login=\"{{userEmail}}\"' \n\n`\n\n**Response body example:**\n\n`1\n\n{ \n\n2\n\n \"authStatus\": \"Success\", \n\n3\n\n \"promptMFA\": false, \n\n4\n\n \"lastAttemptAvailable\": null, \n\n5\n\n \"clientToken\": null, \n\n6\n\n \"authCookie\": { \n\n7\n\n \"Name\": \"VtexIdclientAutCookie_{{accountName}}\", \n\n8\n\n \"Value\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\" \n\n9\n\n }, \n\n10\n\n \"accountAuthCookie\": { \n\n11\n\n \"Name\": \"VtexIdclientAutCookie_{{accountId}}\", \n\n12\n\n \"Value\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\" \n\n13\n\n }, \n\n14\n\n \"expiresIn\": 86399, \n\n15\n\n \"userId\": \"1f6c17e5-06f9-44a9-a459-b3686e03fa9d\", \n\n16\n\n \"phoneNumber\": null, \n\n17\n\n \"scope\": null \n\n18\n\n} \n\n`\n\nThe response headers will set a `vid_rt` cookie, which contains the refresh token value, as illustrated below:\n\n| Set-Cookie | vid\\_rt=QiEOQKuzdRjukvSnsn7F8h1wwkrqq8wWlkk7bXA5LSbTHkbKbYEfDJ7MGb6\\_pllGWd1VQ-JxQI7UDLvYrCUH9o7i1rOSeSG8zJewZw; expires=Thu, 27 Mar 2025 10:22:49 GMT; domain={{storeDomain}}; path=/api/vtexid/refreshtoken/webstore; secure; samesite=strict; httponly |\n| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n\n### 4\\. Refreshing the token\n\nFinally, use the obtained refresh token to request a new access token via a `POST` request to the [Refresh token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api%23post-/api/vtexid/refreshtoken/webstore) endpoint.\n\n**Request:**\n\n`1\n\ncurl --location --request POST 'https://{{storeDomain}}/api/vtexid/refreshtoken/webstore' \\ \n\n2\n\n--header 'Host: {{storeDomain}}' \\ \n\n3\n\n--header 'Content-Type: application/json;charset=UTF-8' \\ \n\n4\n\n--header 'Cookie: vid_rt={{vid_rt}}; \n\n5\n\nVtexIdclientAutCookie_{{accountId}}={{VtexIdclientAutCookie_accountId}}; VtexIdclientAutCookie_{{accountName}}={{VtexIdclientAutCookie_accountName}}' \\ \n\n6\n\n--data-raw '{ \n\n7\n\n \"fingerprint\": \"a1b2c3d4e5f6\" \n\n8\n\n}' \n\n`\n\n**Response body example:**\n\n`1\n\n{ \n\n2\n\n \"status\": \"Success\", \n\n3\n\n \"userId\": \"1f6c17e5-06f9-44a9-a459-b3686e03fa9d\", \n\n4\n\n \"refreshAfter\": \"2025-03-26T02:53:39+00:00\" \n\n5\n\n} \n\n`\n\nThe response cookies provide valid values for:\n\n* `vid_rt`\n* `VtexIdclientAutCookie_{{accountId}}`\n* `VtexIdclientAutCookie_{{accountName}}`\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/Getting-Started/authentication/refresh-token-flow-for-headless-implementations.md)\n\n[Expiring a shopper's password« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations//docs/guides/expiring-a-shoppers-password)[Response status codesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations//docs/guides/api-response-codes)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Authentication tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/docs/guides/refresh-token-flow-for-headless-implementations%23authentication-tokens)\n\n[Refresh token flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/docs/guides/refresh-token-flow-for-headless-implementations%23refresh-token-flow)\n\n[Implementing the refresh token flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/docs/guides/refresh-token-flow-for-headless-implementations%23implementing-the-refresh-token-flow)\n\n[1\\. Starting authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/docs/guides/refresh-token-flow-for-headless-implementations%231-starting-authentication)[2\\. Continuing authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/docs/guides/refresh-token-flow-for-headless-implementations%232-continuing-authentication)[3\\. Validating the session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/docs/guides/refresh-token-flow-for-headless-implementations%233-validating-the-session)[4\\. Refreshing the token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/docs/guides/refresh-token-flow-for-headless-implementations%234-refreshing-the-token)\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/refresh-token-flow-for-headless-implementations.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Authentication tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/docs/guides/refresh-token-flow-for-headless-implementations%23authentication-tokens)\n\n[Refresh token flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/docs/guides/refresh-token-flow-for-headless-implementations%23refresh-token-flow)\n\n[Implementing the refresh token flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/docs/guides/refresh-token-flow-for-headless-implementations%23implementing-the-refresh-token-flow)\n\n[1\\. Starting authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/docs/guides/refresh-token-flow-for-headless-implementations%231-starting-authentication)[2\\. Continuing authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/docs/guides/refresh-token-flow-for-headless-implementations%232-continuing-authentication)[3\\. Validating the session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/docs/guides/refresh-token-flow-for-headless-implementations%233-validating-the-session)[4\\. Refreshing the token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations/docs/guides/refresh-token-flow-for-headless-implementations%234-refreshing-the-token)\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_97129500
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore storefront features handling third party scripts in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/storefront-features-overview)\n\n[Adding third-party scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/storefront-features-handling-third-party-scripts)\n\n[Building navigation menus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/storefront-features-building-navigation-menus)\n\n[Displaying content for authenticated users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users)\n\n[Implementing regionalization features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/storefront-features-implementing-regionalization-features)\n\n[Implementing search features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/storefront-features-implementing-search-features)\n\n[Managing product images in specific contexts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/storefront-features-managing-product-images-in-specific-contexts)\n\n[Implementing Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/delivery-promise-implementation)\n\n[Implementing Live Shopping for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/storefront-features-overview)\n\n[Adding third-party scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/storefront-features-handling-third-party-scripts)\n\n[Building navigation menus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/storefront-features-building-navigation-menus)\n\n[Displaying content for authenticated users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users)\n\n[Implementing regionalization features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/storefront-features-implementing-regionalization-features)\n\n[Implementing search features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/storefront-features-implementing-search-features)\n\n[Managing product images in specific contexts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/storefront-features-managing-product-images-in-specific-contexts)\n\n[Implementing Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/delivery-promise-implementation)\n\n[Implementing Live Shopping for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/storefront-features-overview)\n\nAdding third-party scripts\n\nIn this guide, learn how to add third-party scripts to FastStore projects.\n\nThird-party scripts are elements embedded in a webpage but served from a different domain than the one the user visits. Examples of these scripts include social media buttons, video players, ads, analytics tools, and other elements contributing to a more dynamic and interactive web experience.\n\n> There is an ongoing issue where FastStore stores are not receiving Google Tag Manager (GTM) events due to an integration conflict between FastStore and [Partytown](https://read.calvincode.net/reader?url=https://partytown.builder.io/). The team is actively working on a fix.\n> \n> In the meantime, please follow the workaround outlined in this [Known Issue article](https://read.calvincode.net/reader?url=https://help.vtex.com/en/known-issues/gtm-scripts-are-not-loading-on-the-native-thirdparty-scripts--4hTYThw8092OCHhUIvpCAa).\n\n## Before you begin\n\n### Choose essential third-party scripts\n\nTo maintain your website's performance without compromising the functionality offered by third-party scripts, consider incorporating only those third-party scripts that enhance the value of your website.\n\n### Update the `@faststore/core` version\n\nEnsure your project uses `@faststore/core` version `2.1.82` or above. If not, follow these steps:\n\n1. Open the FastStore code project.\n2. Navigate to the `package.json` file.\n3. Find the `@faststore/core` package and change its version to `2.1.82`.\n4. In your terminal, run `yarn install` to update the package in the project.\n\n### Verify compatibility with Partytown\n\nFastStore uses [Partytown](https://read.calvincode.net/reader?url=https://partytown.builder.io/) for script execution. Not all third-party scripts may be compatible with Partytown, so we strongly recommend testing third-party scripts with Partytown before implementing them. If any issues occur, avoid using those particular scripts.\n\n---\n\n## Instructions\n\n1. In your FastStore project, navigate to the `src` folder and create a folder named `scripts`.\n2. Within the `src/scripts` folder, create the `ThirdPartyScripts.tsx` file.\n3. In the `ThirdPartyScripts.tsx` file, add your script as the example below: \nsrc/scripts/ThirdPartyScripts.tsx \n`1 \nconst ThirdPartyScripts = () => { \n2 \n return ( \n3 \n <script \n4 \n type=\"text/partytown\" \n5 \n dangerouslySetInnerHTML={{ \n6 \n // Add your script here and remove the console.log example \n7 \n __html: \"console.log('🚀 Hello from a third-party script!')\", \n8 \n }} \n9 \n /> \n10 \n ) \n11 \n} \n12 \n \n13 \nexport default ThirdPartyScripts \n`\n4. Run `yarn dev` in the terminal to start the development server and execute the script you have added.\n5. Access the provided localhost URL in your browser, open the Developer Tools, and go to the `Console` tab. You should be able to see the message: `🚀Hello from a third-party script!`: \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/components/storefront-features/handling-third-party-scripts.mdx)\n\n[Implementing storefront features« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/storefront-features-overview)[Building navigation menusNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/storefront-features-building-navigation-menus)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/storefront-features-handling-third-party-scripts%23before-you-begin)\n\n[Choose essential third-party scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/storefront-features-handling-third-party-scripts%23choose-essential-third-party-scripts)[Update the @faststore/core version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/storefront-features-handling-third-party-scripts%23update-the-faststorecore-version)[Verify compatibility with Partytown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/storefront-features-handling-third-party-scripts%23verify-compatibility-with-partytown)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/storefront-features-handling-third-party-scripts%23instructions)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/storefront-features/handling-third-party-scripts.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/storefront-features-handling-third-party-scripts%23before-you-begin)\n\n[Choose essential third-party scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/storefront-features-handling-third-party-scripts%23choose-essential-third-party-scripts)[Update the @faststore/core version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/storefront-features-handling-third-party-scripts%23update-the-faststorecore-version)[Verify compatibility with Partytown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/storefront-features-handling-third-party-scripts%23verify-compatibility-with-partytown)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-handling-third-party-scripts/docs/guides/faststore/storefront-features-handling-third-party-scripts%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_242ec2d8
|
[
{
"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 engineering guidelines 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-engineering-guidelines/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-engineering-guidelines/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-engineering-guidelines/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-engineering-guidelines/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-engineering-guidelines/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-engineering-guidelines/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-engineering-guidelines/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-engineering-guidelines/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-engineering-guidelines/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-engineering-guidelines/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-engineering-guidelines/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-engineering-guidelines/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/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-engineering-guidelines/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-engineering-guidelines/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-engineering-guidelines/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-engineering-guidelines/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-engineering-guidelines/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/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-engineering-guidelines/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-io-documentation-engineering-guidelines/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-io-documentation-engineering-guidelines/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-io-documentation-engineering-guidelines/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-io-documentation-engineering-guidelines/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-io-documentation-engineering-guidelines/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-io-documentation-engineering-guidelines/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-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store)\n\n[App monetization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-business-guidelines-app-monetization)\n\n[Marketing guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets)\n\n[User Experience guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-design-guidelines)\n\n[Engineering guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines)\n\n[Documentation guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-docs-guidelines)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/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-engineering-guidelines/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-engineering-guidelines/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/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-engineering-guidelines/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-engineering-guidelines/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-engineering-guidelines/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-engineering-guidelines/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-engineering-guidelines/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/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-engineering-guidelines/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-engineering-guidelines/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-engineering-guidelines/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-engineering-guidelines/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-engineering-guidelines/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/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-engineering-guidelines/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-io-documentation-engineering-guidelines/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-io-documentation-engineering-guidelines/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-io-documentation-engineering-guidelines/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-io-documentation-engineering-guidelines/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-io-documentation-engineering-guidelines/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-io-documentation-engineering-guidelines/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-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store)\n\n[App monetization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-business-guidelines-app-monetization)\n\n[Marketing guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets)\n\n[User Experience guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-design-guidelines)\n\n[Engineering guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines)\n\n[Documentation guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-docs-guidelines)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/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-engineering-guidelines/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-engineering-guidelines/docs/app-development)\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-app-store)\n\n[App Store Guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store)\n\n[Engineering guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines)\n\nEngineering best practices\n\nRefer to the following guidelines to guarantee the quality and usability of your VTEX IO app during development.\n\n> Notice that you must respect these guidelines if you aim to publish your app at the VTEX App Store.\n\n## Scalability and performance\n\nUse the [VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io) infrastructure to build and deploy your extensions. The VTEX IO development platform uses cloud computing to ensure that your app runs without bottlenecks 24/7.\n\n### Using APIs efficiently\n\nEfficiently utilizing APIs is paramount for optimal performance in your application. Whenever possible, leverage our pre-built [VTEX IO Clients](https://read.calvincode.net/reader?url=https://github.com/vtex/io-clients) to harness the following advantages:\n\n* **Standardized code:** VTEX IO Clients streamline interfacing with various services, providing standardized code across all applications.\n* **Automatic updates:** VTEX consistently updates VTEX IO Clients, delivering new features, resolving bugs, and ensuring compatibility with the latest technologies.\n* **Simplified maintenance:** By relying on VTEX IO Clients, you eliminate the need for extensive code maintenance.\n\nAvoid unnecessary or excessive API calls and ensure they are fast and scalable. Excessive API calls can degrade your app's performance, increasing response times. Unnecessary API calls or lack of proper use of our Clients can lead to security issues. For more information, see our [Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-how-to-create-and-use-clients) documentation.\n\n> **Performance of external systems**\n> \n> When you offer your app on the VTEX App Store, your app may become available to brands of all sizes across different time zones and business calendars. In this context, relying on a manual system with on-demand scalability can become a huge risk in terms of performance.\n\n### Using the latest builders\n\n[Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders) work as an API responsible for configuring other IO services in your app. For developing and publishing apps for the VTEX App Store, the following builders must be up-to-date in your app's code:\n\n* Node builder - version 7.x.\n* React builder - version 3.x.\n* Admin builder - version 1.x.\n* Messages builder - version 1.x.\n* Docs builder- version 0.x.\n* Graphql builder -version 1.x.\n\n## Versioning\n\nWhen releasing a new version of your app, it's crucial to adhere to best practices. There are various types of versions to consider, including major, minor, and patch, as well as stable and beta releases. Select the appropriate version type based on the nature of the implemented changes. Special attention is required for breaking changes, which should always result in a new major version.\n\nFor more information, refer to the [SemVer standard](https://read.calvincode.net/reader?url=https://semver.org/) and our guide on [Releasing a new app version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-releasing-a-new-app-version).\n\n## Security\n\nTo ensure that all points of contact between our retailers, their customers, and other parts of the ecosystem are protected and secure, we test if your app respects regulations on data traffic, usage, and storage worldwide.\n\n### Handling security breaches\n\nNevertheless, if you identify any security breaches after publishing your app, take the following measures:\n\n1. [Open a ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/opening-tickets-to-vtex-support--16yOEqpO32UQYygSmMSSAM) requesting to remove your app from the VTEX App Store and avoid further installations of the unstable version.\n2. [Open a support ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/opening-tickets-to-vtex-support--16yOEqpO32UQYygSmMSSAM) and notify us of the issue so that we can support retailers operating with this version and guide them on removing it from their stores.\n3. Fix the security flaw and resubmit your application for homologation.\n\nOnce the new version is approved, the app will be available again in the VTEX App Store.\n\n### Hardcoding VTEX appKey/appToken\n\nHaving an appKey/appToken exposed in your code can cause serious security issues, like unwanted access. Instead of using a VTEX appKey/appToken pair, apps should use the existing tokens (`ctx.authToken`, `ctx.vtex.storeUserAuthToken` or `ctx.vtex.adminUserAuthToken`). For more information, see [Connecting to VTEX Core Commerce APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io%23steps).\n\n### Using an app token for a user-initiated action\n\nFor user-initiated actions, apps should use either `ctx.vtex.storeUserAuthToken` or `ctx.vtex.adminUserAuthToken` (as opposed to `ctx.authToken`). For more information, see [Connecting to VTEX Core Commerce APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io%23steps).\n\n### Declaring broad policies\n\nOutbound access policies (`outbound-access`) to VTEX resources should follow the [principle of least privilege](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/Principle%5Fof%5Fleast%5Fprivilege). In short, you only give access to what is really needed. For instance, the `path` should not be configured as `*`. See an example [here](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-graphql/blob/684dcbbbd6e9cdbd121afd7802200856cb952d2b/manifest.json%23L107-L112) of how it should be done.\n\n### Do not expose private information through public routes\n\nAs the name suggests, public routes do not require authentication when accessed from the frontend. Consequently, they should never reveal data sourced from private APIs, such as displaying a list of orders directly to the frontend. In this sense, a common mistake is failing to restrict routes intended exclusively for Admin usage. Additionally, keep in mind that GraphQL APIs are public by default, necessitating cautious schema design to avoid queries that inadvertently expose confidential information.\n\nAccess to REST APIs should be restricted using [policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies%23resource-based-policies). Access to GraphQL APIs should be restricted using directives, either [@auth](https://read.calvincode.net/reader?url=https://github.com/vtex/node-vtex-api/blob/08ea11d380997f5abf02455487b342caa74b2001/src/service/worker/runtime/graphql/schema/schemaDirectives/Auth.ts%23L66-L75) or a custom-made one.\n\n### Isolate data between tenants\n\nSingle-tenant external systems should be used carefully. Data from one tenant must always be isolated from data from another tenant to prevent leakage and unwanted access. The isolation method will depend on the external system. One possible solution is to use the name (or other identifier) of the tenant in routes or as a parameter for access control or to define how the data is managed.\n\n## Data privacy\n\n### Persisting PII within VTEX\n\nIf using Master Data or VBase to store Personal Identifiable Information (PII), a mechanism must be in place to ensure compliance with the [Right to be Forgotten](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/Right%5Fto%5Fbe%5Fforgotten) or other similar data-protection practices. Possible solutions are to provide an option or endpoint in the app that erases the data, for instance, by using a delete operation with our Clients ([Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app%23delete), [VBase](https://read.calvincode.net/reader?url=https://github.com/vtex/node-vtex-api/blob/1b3c54976aa974619d0728fae4ed2fe076dbb551/src/clients/infra/VBase.ts%23L178)) or through the API ([Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23delete-/api/dataentities/-acronym-/documents/-id-), [Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23delete-/api/dataentities/-dataEntityName-/documents/-id-)).\n\n### Sending PII to external service\n\nWe should ensure that all PII being shared externally is strictly necessary for the app to work. If you have any questions, reach out to us [via ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/opening-tickets-to-vtex-support--16yOEqpO32UQYygSmMSSAM).\n\n## Usability\n\n### Implementing internationalization (i18n) correctly\n\nEnsure that all messages are [internationalized](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores%23storefront-content-internationalization) using the `messages` builder. Also, i18n keys should start with the domain (`store/` for storefront and `admin/` for Admin) where they are used. Otherwise, they will not render properly. For more information, see our [reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-translating-the-component) for translating components.\n\n### Avoid declaring routes with collision-prone paths\n\nWhen declaring [routes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-routes), generic paths (e.g., `/_v/orders/`, `/_v/settings`) should be avoided to reduce chances of collision with other apps.\n\nTo mitigate this risk, consider adopting a naming convention that includes a distinctive prefix, typically the name of your app, when defining routes. This simple practice effectively reduces the chances of conflicts and ensures that your app's routes remain uniquely identifiable and isolated from others.\n\n### Creating custom Admin settings form\n\nOur primary recommendation for defining the Admin settings form of your app is to leverage the [settingsSchema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-manifest%23settingsschema) structure, as it caters to the majority of use cases effectively.\n\nHowever, for more specific cases where the schema is insufficient, you can create your form as a page of an [Admin app](https://read.calvincode.net/reader?url=https://learn.vtex.com/docs/course-admin-lang-en). In such cases, our team will evaluate your requirements during the homologation process.\n\n## Plug&Play\n\nFor homologation approval, your app must be plug-and-play. Those interested in your app should:\n\n* Be able to install and configure it using only the VTEX Admin panel.\n* Not considered external assistance to support the app implementation process.\n\n## Support channel\n\nEvery app in the VTEX App Store must:\n\n* Provide a direct support channel for retailers who install it, such as email, phone, ticketing tool, or a combination of these options.\n* Have the first response time up to eight business hours in the developer's time zone. This requirement aims to ensure that store operations will not be affected by errors in third-party applications.\n\n## Documentation\n\nWhile [developing your app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-an-app) and [preparing the app for distribution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-preparing-your-app-distribution), make sure to provide official documentation that supports future users in implementing and understanding your app.\n\nThe app documentation should include:\n\n* Technical and commercial requirements for the app's operation.\n* Installation and configuration guides.\n* Answers to frequently asked questions.\n\nFor more information on the best practices for creating documentation, refer to [Documentation guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines).\n\nContributors\n\n2\n\n[](https://github.com/henriquessb)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Perks/vtex-io-documentation-homologation-requirements-for-vtex-app-store/vtex-io-documentation-engineering-guidelines.md)\n\n[User Experience guidelines« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines//docs/guides/vtex-io-documentation-design-guidelines)[Documentation guidelinesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines//docs/guides/vtex-io-documentation-docs-guidelines)\n\nContributors\n\n2\n\n[](https://github.com/henriquessb)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Scalability and performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23scalability-and-performance)\n\n[Using APIs efficiently](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23using-apis-efficiently)[Using the latest builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23using-the-latest-builders)\n\n[Versioning](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23versioning)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23security)\n\n[Handling security breaches](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23handling-security-breaches)[Hardcoding VTEX appKey/appToken](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23hardcoding-vtex-appkeyapptoken)[Using an app token for a user-initiated action](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23using-an-app-token-for-a-user-initiated-action)[Declaring broad policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23declaring-broad-policies)[Do not expose private information through public routes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23do-not-expose-private-information-through-public-routes)[Isolate data between tenants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23isolate-data-between-tenants)\n\n[Data privacy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23data-privacy)\n\n[Persisting PII within VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23persisting-pii-within-vtex)[Sending PII to external service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23sending-pii-to-external-service)\n\n[Usability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23usability)\n\n[Implementing internationalization (i18n) correctly](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23implementing-internationalization-i18n-correctly)[Avoid declaring routes with collision-prone paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23avoid-declaring-routes-with-collision-prone-paths)[Creating custom Admin settings form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23creating-custom-admin-settings-form)\n\n[Plug&Play](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23plugplay)\n\n[Support channel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23support-channel)\n\n[Documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23documentation)\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/Perks/vtex-io-documentation-homologation-requirements-for-vtex-app-store/vtex-io-documentation-engineering-guidelines.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Scalability and performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23scalability-and-performance)\n\n[Using APIs efficiently](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23using-apis-efficiently)[Using the latest builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23using-the-latest-builders)\n\n[Versioning](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23versioning)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23security)\n\n[Handling security breaches](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23handling-security-breaches)[Hardcoding VTEX appKey/appToken](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23hardcoding-vtex-appkeyapptoken)[Using an app token for a user-initiated action](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23using-an-app-token-for-a-user-initiated-action)[Declaring broad policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23declaring-broad-policies)[Do not expose private information through public routes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23do-not-expose-private-information-through-public-routes)[Isolate data between tenants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23isolate-data-between-tenants)\n\n[Data privacy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23data-privacy)\n\n[Persisting PII within VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23persisting-pii-within-vtex)[Sending PII to external service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23sending-pii-to-external-service)\n\n[Usability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23usability)\n\n[Implementing internationalization (i18n) correctly](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23implementing-internationalization-i18n-correctly)[Avoid declaring routes with collision-prone paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23avoid-declaring-routes-with-collision-prone-paths)[Creating custom Admin settings form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23creating-custom-admin-settings-form)\n\n[Plug&Play](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23plugplay)\n\n[Support channel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23support-channel)\n\n[Documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines/docs/guides/vtex-io-documentation-engineering-guidelines%23documentation)\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_eae5a2ac
|
[
{
"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 rewriter 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/rewriter/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/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/rewriter/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/rewriter/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/rewriter/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/rewriter/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/rewriter/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/updates/release-notes)\n\nRewriter\n\nRewriter is the VTEX IO app responsible for managing the following three main types of [routes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-routes): product, search, and navigation routes.\n\nThe first two are first-class entities in Rewriter, meaning Rewriter identifies these routes and directly forwards them to the rendering pipeline.\n\nNavigation routes, in turn, are client-side defined routes related to custom paths and VTEX IO pre-defined templates, such as department, brand, and category routes. These routes can have a canonical path and a search query string.\n\nIn Rewriter, navigation routes are identified by the **internal** type, and routes used to redirect a route from one path to another are identified by the **redirect** type.\n\nRewriter includes functionalities to:\n\n* Create an internal route.\n* Create a canonical path related to an internal route.\n* Create a redirect route.\n* Delete a canonical path related to an internal route.\n* Delete an internal route.\n* Delete a redirect route.\n* Create translated URLs for cross-border stores.\n\n# Schema overview\n\n## Query\n\n Query version: String [ redirect: ](#redirect) [ QueryRedirect!](#queryredirect) [internal:](#internal) [QueryInternal!](#queryinternal) QueryRedirect get(path:String!, locator:[RouteLocator](#routelocator)): [Redirect](#redirect) listRedirects(limit:Int, next:String): [ListRedirectsResponse!](#listredirectsresponse) Query: redirect QueryInternal get(path:String!, locator:[RouteLocator](#routelocator)): [Internal](#internal) listInternals(limit:Int, next:String): [ListInternalsResponse!](#listinternalsresponse) routes(locator:[EntityLocator](#entitylocator)): [\\[RoutesByBinding!\\]](#routesbybinding) Query: internal Redirect from: String! to: String! endDate: String type: [RedirectTypes!](#redirecttypes) binding: String! origin: String QueryRedirect: get ListRedirectsResponse routes: [\\[Redirect!\\]](#redirect) next: String QueryRedirect: listRedirects Internal from: String! declarer: String! type: String! id: String! query: JSON binding: String! endDate: String imagePath: String imageTitle: String routesVersion: Float resolveAs: String origin: String disableSitemapEntry: Boolean QueryInternal: get ListInternalsResponse routes: [\\[Internal!\\]](#internal) next: String QueryInternal: listInternals RoutesByBinding binding: String! route: String! QueryInternal: routes ListRedirectsResponse: routes ListInternalsResponse: routes \n\n| Field | Type | Description |\n| ------------ | -------------------------------- | ------------------------------------------------------------------------------------------------------ |\n| **redirect** | [QueryRedirect](#queryredirect)! | Provides _redirect_ routes data.Redirect routes are used to redirect a route from one path to another. |\n| **internal** | [QueryInternal](#queryinternal)! | Provides _internal_ routes data.Internal routes are navigation routes. |\n\n## Mutation\n\nMutation Mutation [redirect](#redirect) [ MutateRedirect!](#mutateredirect) [internal:](#internal) [ MutateInternal!](#mutateinternal) MutateRedirect MutateRedirect save(route: [RedirectInput](#redirectinput)!): [Redirect](#redirect) saveMany(routes: \\[[RedirectInput](#redirectinput)!\\]!): Boolean! delete(path: String! locator: [RouteLocator](#routelocator)): [Redirect](#redirect) deleteMany(paths: \\[String!\\]! locators: \\[[RouteLocator](#routelocator)!\\]): Boolean! Mutation:redirectport->MutateRedirect Mutation: redirect MutateInternal MutateInternal save(route: [InternalInput](#internalinput)!): [Internal](#internal) saveMany(routes: \\[[InternalInput](#internalinput)!\\]!): Boolean! delete(path: String! locator: [RouteLocator](#routelocator)): [Internal](#internal) deleteMany(paths: \\[String!\\]! locators: \\[[RouteLocator](#routelocator)!\\]): Boolean! Mutation:internalport->MutateInternal Mutation: internal Redirect from: String! to: String! endDate: String type: [RedirectTypes!](#redirecttypes) binding: String! origin: String MutateRedirect:deleteport-Redirect MutateRedirect: delete Internal from: String! declarer: String! type: String! id: String! query: JSON binding: String! endDate: String imagePath: String imageTitle: String routesVersion: Float resolveAs: String origin: String disableSitemapEntry: Boolean MutateInternal:saveport-Internal MutateInternal: save MutateInternal:deleteport-Internal MutateInternal: delete MutateRedirect:saveport-Redirect MutateRedirect: save \n\n| Field | Type | Description |\n| ------------ | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **redirect** | [MutateRedirect](#mutateredirect)! | Updates or deletes _redirect_ routes data according to the provided arguments.Redirect routes are used to redirect a route from one path to another. |\n| **internal** | [MutateInternal](#mutateinternal)! | Updates or deletes _internal_ routes data according to the provided arguments.Internal routes are navigation routes. |\n\n# Schema description\n\n> Arguments must be provided by the user. The exclamation mark `!` indicates that a type cannot be nullable.\n\n## QueryRedirect\n\n| Field | (argument) | Type | Description |\n| ----------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |\n| **get** | [Redirect](#redirect) | Returns information regarding a specific redirect route, given its related _path_ and _locator_. | |\n| path | **String!** | The path of the desired route to fetch data. | |\n| locator | [RouteLocator](#routelocator) | The _RouteLocator_ object, containing information about the store locale and route origin. | |\n| **listRedirects** | [ListRedirectsResponse](#listredirectsresponse)! | Lists all redirect routes. | |\n| limit | Int | The number of _ListRedirectsResponse_ objects to be displayed at once. | |\n| next | String | The argument used to fetch more internal routes from _ListRedirectsResponse_.It must be empty in the first query and, in the following, filled in with the string previously obtained from the _ListRedirectsResponse_ object. | |\n\n[Query](#query) 🔼\n\n## QueryInternal\n\n| Field | (argument) | Type | Description |\n| ----------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |\n| **get** | [Internal](#internal) | Returns information regarding a specific internal route, given its related _path_ and _locator_ | |\n| path | String! | The path of the desired route to fetch data. | |\n| locator | [RouteLocator](#routelocator) | The _RouteLocator_ object, containing information about the store locale and route origin. | |\n| **listInternals** | [ListInternalsResponse](#listinternalsresponse)! | Lists all internal routes. | |\n| limit | Int | The number of _ListInternalsResponse_ objects to be displayed at once. | |\n| next | String | The argument used to fetch more internal routes from _ListInternalsResponse_.It must be empty in the first query and, in the following, filled in with the string previously obtained from the _ListInternalsResponse_ object. | |\n| **routes** | \\[[RoutesByBinding](#routesbybinding)!\\] | Lists all internal routes of a specific type (e.g. deparment routes, category routes, etc.) and its related _binding_, which is an identifier for each store locale. | |\n| locator | [EntityLocator](#entitylocator) | The _EntityLocator_ object, containing information about the entity type of the routes to be listed. | |\n\n[Query](#query) 🔼\n\n## MutateRedirect\n\n| Field | (argument) | Type | Description |\n| -------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------ | ----------- |\n| **save** | [Redirect](#redirect) | Creates or updates a redirect route according to the provided arguments. | |\n| route | [RedirectInput](#redirectinput)! | The data regarding the redirect route to be created or updated. | |\n| **saveMany** | Boolean! | Creates or updates many redirect routes according to the provided arguments. | |\n| routes | \\[[RedirectInput](#redirectinput)!\\]! | The data regarding the redirect routes to be created or updated. | |\n| **delete** | [Redirect](#redirect) | Deletes a redirect route according to the provided arguments. | |\n| path | String! | The path of the route to be deleted. | |\n| locator | [RouteLocator](#routelocator) | The _EntityLocator_ object, containing information about the entity type of the route to be deleted. | |\n| **deleteMany** | Boolean! | Deletes many redirect route according to the provided arguments. | |\n| paths | \\[String!\\]! | The paths of the routes to be deleted. | |\n| locators | \\[[RouteLocator](#routelocator)!\\] | The _EntityLocator_ objects, containing information about the entity type of the routes to be deleted. | |\n\n[Mutation](#mutation) 🔼\n\n## MutateInternal\n\n| Field | (argument) | Type | Description |\n| -------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------ | ----------- |\n| **save** | [Internal](#internal) | Creates or updates an internal route according to the provided arguments. | |\n| route | [InternalInput](#internalinput)! | The data regarding the internal route to be created or updated. | |\n| **saveMany** | Boolean! | Creates or updates many internal routes according to the provided arguments. | |\n| routes | \\[[InternalInput](#internalinput)!\\]! | The data regarding the internal routes to be created or updated. | |\n| **delete** | [Internal](#internal) | Deletes an internal route according to the provided arguments. | |\n| path | String! | The path of the route to be deleted. | |\n| locator | [RouteLocator](#routelocator) | The _EntityLocator_ object, containing information about the entity type of the route to be deleted. | |\n| **deleteMany** | Boolean! | Deletes many internal routes according to the provided arguments. | |\n| paths | \\[String!\\]! | The paths of the routes to be deleted. | |\n| locators | \\[[RouteLocator](#routelocator)!\\] | The _EntityLocator_ objects, containing information about the entity type of the routes to be deleted. | |\n\n[Mutation](#mutation) 🔼\n\n## Internal\n\n| Field | Type | Description |\n| ----------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **from** | String! | The route path. |\n| **declarer** | String! | The app that originally defined the route in a routes.json file. For VTEX IO pre-defined routes, the declarer value is [vtex.store@2.x](mailto:vtex.store@2.x). |\n| **type** | String! | The route entity type defined in the declarer app, which can be: department, category, subcategory, brand, etc. |\n| **id** | String! | The entity type id. For example, a deparment id. |\n| **query** | JSON | The query string parameters of a route. |\n| **binding** | String! | The id of the _binding_ which the route is available._Keep in mind: Every store has a binding id related to its store locale. Hence, cross-border stores always have more than one binding, while accounts with a single storefront have only one binding id._ |\n| **endDate** | String | The date a route stops being valid._Keep in mind: The endDate value for permanent routes is null._ |\n| **imagePath** | String | |\n| **imageTitle** | String | |\n| **routesVersion** | Float | The current routes version._Keep in mind: If the routesVersion value is null or different from the current version, the route is not currently available in the store._ |\n| **resolveAs** | String | Alias paths of a route, meaning that the route will resolve the paths defined in the resolveAs field _Keep in mind: The resolveAs parameter must always be defined in the catalog's default language._ |\n| **origin** | String | A string that defines the origin of the route, for example: user-canonical |\n| **disableSitemapEntry** | Boolean | The boolean value that indicates if a route is included (False) or not (True) in the store's sitemap. |\n\n[QueryInternal](#queryinternal) 🔼\n\n[MutateInternal](#mutateinternal) 🔼\n\n[ListInternalsResponse](#listinternalsresponse) 🔼\n\n## ListInternalsResponse\n\n| Field | Type | Description |\n| ---------- | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **routes** | \\[[Internal](#internal)!\\] | Returns the demanded information from the _Internal_ object for each route. |\n| **next** | String | Returns a string to be used as the _next_ argument of the succeeding _listInternals_ query to fetch more data.When _next_ returns _null_, all data have already been fetched. |\n\n[QueryInternal](#queryinternal) 🔼\n\n## RoutesByBinding\n\n| Field | Type | Description |\n| ----------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **binding** | String! | The id of the _binding_ which the route is available. _Keep in mind: Every store has a binding id related to its store locale. Hence, cross-border stores always have more than one binding, while accounts with a single storefront have only one binding id._ |\n| **route** | String! | Returns the route path. |\n\n[QueryInternal](#queryinternal) 🔼\n\n## Redirect\n\n| Field | Type | Description |\n| ----------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **from** | String! | The original route path. |\n| **to** | String! | The route redirect path. |\n| **endDate** | String | The date a redirect route stops being valid. _Keep in mind: The endDate value for permanent routes is null._ |\n| **type** | [RedirectTypes](#redirecttypes)! | The route type: temporary or permanent. |\n| **binding** | String! | The id of the _binding_ which the route is available. _Keep in mind: Every store has a binding id related to its store locale. Hence, cross-border stores always have more than one binding, while accounts with a single storefront have only one binding id._ |\n| **origin** | String | A string that defines the origin of the route, for example: user-canonical |\n\n[QueryRedirect](#queryredirect) 🔼\n\n[MutateRedirect](#mutateredirect) 🔼\n\n## ListRedirectsResponse\n\n| Field | Type | Description |\n| ---------- | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **routes** | \\[[Redirect](#redirect)!\\] | Returns the demanded information from the _Redirect_ object for each route. |\n| **next** | String | Returns a string to be used as the _next_ argument of the succeeding _listInternals_ query to fetch more data.When _next_ returns _null_, all data have already been fetched. |\n\n[QueryRedirect](#queryredirect) 🔼\n\n## EntityLocator\n\n| Field | Type | Description |\n| -------- | ------- | ----------------------------------------------------------------------------------- |\n| **id** | String! | The entity type id. For example, a deparment id. |\n| **type** | String! | The route entity type, which can be: department, category, subcategory, brand , etc |\n\n[QueryInternal](#queryinternal) 🔼\n\n## InternalInput\n\n| Field | Type | Description |\n| ----------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **from** | String! | The route path. |\n| **declarer** | String! | The app that originally defined the route in a routes.json file. For VTEX IO pre-defined routes, the declarer value is [vtex.store@2.x](mailto:vtex.store@2.x). |\n| **type** | String! | The route entity type, which can be: department, category, subcategory, brand , etc |\n| **id** | String! | The entity type id. For example, a deparment id. |\n| **query** | JSON | The query string parameters of a route. |\n| **binding** | String | The id of the _binding_ which the route is available._Keep in mind: Every store has a binding id related to its store locale. Hence, cross-border stores always have more than one binding, while accounts with a single storefront have only one binding id._ |\n| **endDate** | String | The date a route stops being valid._Keep in mind: The endDate value for permanent routes is null._ |\n| **imagePath** | String | |\n| **imageTitle** | String | |\n| **resolveAs** | String | Alias paths of a route, meaning that the route will resolve the paths defined in the resolveAs field. _Keep in mind: The resolveAs parameter must always be defined in the catalog's default language._ |\n| **origin** | String | A string that defines the origin of the route, for example: user-canonical |\n| **disableSitemapEntry** | Boolean | The boolean value that indicates if a route is included (False) or not (True) in the store's sitemap. |\n\n[MutateInternal](#mutateinternal) 🔼\n\n## RedirectInput\n\n| Field | Type | Description |\n| ----------- | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **from** | String! | The original route path. |\n| **to** | String! | The route redirect path. |\n| **endDate** | String | The date a route stops being valid._Keep in mind: The endDate value for permanent routes is null._ |\n| **type** | [RedirectTypes](#redirecttypes)! | The route type: temporary or permanent. |\n| **binding** | String | The id of the _binding_ which the route is available._Keep in mind: Every store has a binding id related to its store locale. Hence, cross-border stores always have more than one binding, while accounts with a single storefront have only one binding id._ |\n| **origin** | String | A string that defines the origin of the route, for example: user-canonical |\n\n[MutateRedirect](#mutateredirect) 🔼\n\n## RouteLocator\n\n| Field | Type | Description |\n| ----------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **from** | String! | The original route path. |\n| **binding** | String! | The id of the _binding_ which the route is available._Keep in mind: Every store has a binding id related to its store locale. Hence, cross-border stores always have more than one binding, while accounts with a single storefront have only one binding id._ |\n\n[QueryRedirect](#queryredirect) 🔼\n\n[QueryInternal](#queryinternal) 🔼\n\n[MutateRedirect](#mutateredirect) 🔼\n\n[MutateInternal](#mutateinternal) 🔼\n\n## RedirectTypes\n\n| Value | | **PERMANENT** |\n| ------------- | ---------------- |\n| **TEMPORARY** | |\n\n[Redirect](#redirect) 🔼\n\n[RedirectInput](#redirectinput) 🔼\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/graphql-apis/rewriter.md)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Schema overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23schema-overview)\n\n[Query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23query)\n\n[Mutation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23mutation)\n\n[Schema description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23schema-description)\n\n[QueryRedirect](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23queryredirect)\n\n[QueryInternal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23queryinternal)\n\n[MutateRedirect](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23mutateredirect)\n\n[MutateInternal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23mutateinternal)\n\n[Internal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23internal)\n\n[ListInternalsResponse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23listinternalsresponse)\n\n[RoutesByBinding](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23routesbybinding)\n\n[Redirect](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23redirect)\n\n[ListRedirectsResponse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23listredirectsresponse)\n\n[EntityLocator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23entitylocator)\n\n[InternalInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23internalinput)\n\n[RedirectInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23redirectinput)\n\n[RouteLocator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23routelocator)\n\n[RedirectTypes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23redirecttypes)\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/graphql-apis/rewriter.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Schema overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23schema-overview)\n\n[Query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23query)\n\n[Mutation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23mutation)\n\n[Schema description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23schema-description)\n\n[QueryRedirect](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23queryredirect)\n\n[QueryInternal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23queryinternal)\n\n[MutateRedirect](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23mutateredirect)\n\n[MutateInternal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23mutateinternal)\n\n[Internal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23internal)\n\n[ListInternalsResponse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23listinternalsresponse)\n\n[RoutesByBinding](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23routesbybinding)\n\n[Redirect](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23redirect)\n\n[ListRedirectsResponse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23listredirectsresponse)\n\n[EntityLocator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23entitylocator)\n\n[InternalInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23internalinput)\n\n[RedirectInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23redirectinput)\n\n[RouteLocator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23routelocator)\n\n[RedirectTypes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter/docs/guides/rewriter%23redirecttypes)\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_16e82885
|
[
{
"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 ProductSummaryBuyButton 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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryBuyButton/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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/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/ProductSummaryBuyButton/docs/vtex-io-apps)\n\nProduct Summary Buy Button\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\nProduct Summary Buy Button is the block exported by the [Product Summary app](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-product-summary) responsible for rendering a Buy Button in the [Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-product-summary-productsummaryshelf) block.\n\n\n\n> **The Product Summary Buy Button only effectively adds products to the Minicart if the store still uses the [Minicart v1](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/minicart/blob/383d7bbd3295f06d1b5854a0add561a872e1515c/docs/README.md)**. If the store uses the [Minicart v2](https://read.calvincode.net/reader?url=https://vtex.io/docs/components/all/vtex.minicart/), please configure the [Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-add-to-cart-button/) in the `product-summary.shelf` block instead.\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-buy-button` block as a children of the `product-summary.shelf` block:\n\n`1\n\n { \n\n2\n\n \"product-summary.shelf\": { \n\n3\n\n \"children\": [ \n\n4\n\n \"product-summary-image\", \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 } \n\n`\n\n1. Then, declare the `product-summary-buy-button` and configure its behavior using the props stated below.\n\n`1\n\n{ \n\n2\n\n \"product-summary-buy-button\": { \n\n3\n\n \"props\": { \n\n4\n\n \"isOneClickBuy\": false \n\n5\n\n } \n\n6\n\n } \n\n7\n\n} \n\n`\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| ----------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |\n| isOneClickBuy | boolean | Whether the user should be redirected to Checkout after clicking on the Buy Button (true) or not (false). | false |\n| buyButtonText | string | Custom text that overwrites the default Buy Button text. | undefined |\n| displayBuyButton | enum | Sets the Buy Button display mode. Possivle values are: displayButtonAlways (it will always be displayed), displayButtonHover (only displayed on hover), or displayButtonNone (it will be hidden for users). | displayButtonAlways |\n| customToastURL | string | Defines a redirect link to the Toast displayed when an item is added to your cart. | /checkout/#/cart |\n| buyButtonBehavior | enum | Sets the Buy Button behavior when it is clicked on. Possible values are: alwaysGoToProduct (redirect users to the product page), default (redirect users to the minicart), or alwaysAddToTheCart (add the selected SKU to the minicart). When choosing this last option, be careful: use it only if there are SKU Selectors for each product variation. This way, users can properly select their desired SKU. | default |\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| buyButtonContainer |\n| buyButton |\n| isHidden |\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/ProductSummaryBuyButton/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[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryBuyButton/docs/apps/vtex.product-summary@2.91.0/ProductSummaryBuyButton%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryBuyButton/docs/apps/vtex.product-summary@2.91.0/ProductSummaryBuyButton%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryBuyButton/docs/apps/vtex.product-summary@2.91.0/ProductSummaryBuyButton%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_64c73458
|
[
{
"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 telemarketing 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-telemarketing/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-telemarketing/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-telemarketing/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-telemarketing/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-telemarketing/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-telemarketing/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-telemarketing/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-telemarketing/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-telemarketing/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-telemarketing/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-telemarketing/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-telemarketing/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-telemarketing/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-telemarketing/updates/release-notes)\n\nVTEX Telemarketing\n\nThe Telemarketing app is a store component that enables a [call center operator](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tutorial/como-criar-um-usuario-de-televendas--frequentlyAskedQuestions%5F4227) to represent a customer in the store and shop on their behalf.\n\n\n\n> Learn more about this feature in our [Telesales toolbar](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/toolbar-de-televendas--tutorials%5F5500) article.\n\n## Configuration\n\n1. In your theme's `manifest.json`, add the Telemarketing app as a dependency:\n\n`1\n\n dependencies: { \n\n2\n\n+ \"vtex.telemarketing\": \"2.x\" \n\n3\n\n } \n\n`\n\n1. Add the `telemarketing` block in your store's header. For example:\n\n`1\n\n{ \n\n2\n\n \"header\": { \n\n3\n\n \"blocks\": [\"header-layout.desktop\", \"header-layout.mobile\"] \n\n4\n\n }, \n\n5\n\n \"header.full\": { \n\n6\n\n \"blocks\": [\"header-layout.desktop\", \"header-layout.mobile\"] \n\n7\n\n }, \n\n8\n\n \"header-layout.desktop\": { \n\n9\n\n \"children\": [ \n\n10\n\n \"flex-layout.row#1-desktop\", \n\n11\n\n \"flex-layout.row#2-desktop\", \n\n12\n\n \"flex-layout.row#3-desktop\", \n\n13\n\n \"sticky-layout#4-desktop\" \n\n14\n\n ] \n\n15\n\n }, \n\n16\n\n \n17\n\n \"flex-layout.row#1-desktop\": { \n\n18\n\n \"children\": [\"telemarketing\"], \n\n19\n\n \"props\": { \n\n20\n\n \"fullWidth\": true \n\n21\n\n } \n\n22\n\n }, \n\n`\n\nOnce you have added the block to the header, the Telemarketing component is ready to be rendered, since it does not require props.\n\n> The telemarketing bar is accessed via browser by the following URL, where `{accountName}` should be replaced by the name of your account: `{accountName}.myvtex.com`\n\n## Modus Operandi\n\nThis component will only be displayed and properly work for users whose role is `2 - Televendas (Call center operator)` in their access profile.\n\nTo understand how the permissions work for your account, including the call center operator permission, access the learning track on [Accounts & Permissions](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/contas-e-permissoes--5PxyAgZrtiYlaYZBTlhJ2A/4T2vusW9RRUmVjGSuKNO2H) on VTEX Help Center.\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://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization).\n\n| CSS Handles |\n| ----------------------- |\n| clientName |\n| clientNameBar |\n| container |\n| emailInput |\n| login |\n| loginForm |\n| loginFormMessage |\n| logout |\n| logoutForm |\n| popoverArrowUp |\n| popoverBox |\n| popoverContentContainer |\n| popoverContainer |\n| popoverHeaderIcon |\n| popoverHeaderEmail |\n\n## Related articles\n\n* [Telesales toolbar](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/toolbar-de-televendas--tutorials%5F5500)\n* [Telesales features](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/funcionalidades-de-televendas--UqhiccIRIK2KD0OqkzJaS)\n* [Configuring telesales features](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/como-configurar-as-funcionalidades-de-televendas--76FNgQP2Glc4umMJ5Yr50R)\n* [Accounts & Permissions](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/contas-e-permissoes--5PxyAgZrtiYlaYZBTlhJ2A/4T2vusW9RRUmVjGSuKNO2H)\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-telemarketing.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-telemarketing/docs/guides/vtex-telemarketing%23configuration)\n\n[Modus Operandi](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-telemarketing/docs/guides/vtex-telemarketing%23modus-operandi)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-telemarketing/docs/guides/vtex-telemarketing%23customization)\n\n[Related articles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-telemarketing/docs/guides/vtex-telemarketing%23related-articles)\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-telemarketing.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-telemarketing/docs/guides/vtex-telemarketing%23configuration)\n\n[Modus Operandi](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-telemarketing/docs/guides/vtex-telemarketing%23modus-operandi)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-telemarketing/docs/guides/vtex-telemarketing%23customization)\n\n[Related articles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-telemarketing/docs/guides/vtex-telemarketing%23related-articles)\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_e67555de
|
[
{
"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 using several service workers in your 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-io-documentation-using-several-service-workers-in-your-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-io-documentation-using-several-service-workers-in-your-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-io-documentation-using-several-service-workers-in-your-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-io-documentation-using-several-service-workers-in-your-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-io-documentation-using-several-service-workers-in-your-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-io-documentation-using-several-service-workers-in-your-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-io-documentation-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/docs/guides/store-framework-routing)\n\n[Adding custom headers to your Store Framework store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store)\n\n[Best practices for associating a custom page with a content type](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type)\n\n[Customizing your 404 page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store/docs/guides/vtex-io-documentation-customizing-your-404-page)\n\n[Enabling 404 pages for invalid single-segment paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store/docs/guides/vtex-io-documentation-enabling-404-pages-for-invalid-single-segment-paths)\n\n[Managing URL redirects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store/docs/guides/vtex-io-documentation-managing-url-redirects)\n\n[Using several service workers in your store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/docs/guides/store-framework-routing)\n\n[Adding custom headers to your Store Framework store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store)\n\n[Best practices for associating a custom page with a content type](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type)\n\n[Customizing your 404 page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store/docs/guides/vtex-io-documentation-customizing-your-404-page)\n\n[Enabling 404 pages for invalid single-segment paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store/docs/guides/vtex-io-documentation-enabling-404-pages-for-invalid-single-segment-paths)\n\n[Managing URL redirects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store/docs/guides/vtex-io-documentation-managing-url-redirects)\n\n[Using several service workers in your store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/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-using-several-service-workers-in-your-store/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store/docs/guides/store-framework)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store/docs/guides/store-framework-routing)\n\n[Using several service workers in your store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store)\n\nUsing several service workers in your store\n\nLearn how to leverage the Service Worker builder to provide users with uninterrupted access to your web applications.\n\nThe Service Worker builder is responsible for fetching service workers exported by the account's installed apps and bundling them into a single file.\n\nService Workers function as JavaScript intermediaries, facilitating interactions between web apps, browsers, and the network. By intercepting, caching, and modifying navigation, they enable efficient offline experiences and enhance the overall performance of web applications.\n\nThis article explores how to leverage the Service Worker builder to bundle multiple service workers into a single file for your store. This feature allows stores to work simultaneously with several service workers, eliminating the constraints of being limited to just one.\n\nA's service worker\n\nB's service worker\n\nC's service worker\n\nService workers package\n\nApp A\n\nService worker builder\n\nApp B\n\nApp C\n\nStore\n\n## Instructions\n\nFollow these instructions to create an app using the Service Worker builder. If you are editing an already-existing app, ensure the Service Worker builder is declared in the `manifest.json`'s builders list, as shown below.\n\n`1\n\n \"builders\": { \n\n2\n\n \"docs\": \"0.x\", \n\n3\n\n+ \"service-worker\": \"0.x\" \n\n`\n\n1. Run the `vtex init` command in your terminal, using the VTEX IO CLI:\n\n`1\n\nvtex init \n\n`\n\n1. Select the `service-worker-example` option and confirm that you want to download the app to the destination you just chose: \n\n\n> Once you select the `service-worker-example` option, the CLI will prompt you for important information about the app, such as a value for the `vendor`, `name`, `title`, and `description`.\n\n1. Open the Service Worker Example app in your preferred code editor.\n2. In the `service-workers` folder, declare your app's desired event handlers in the appropriate files. If the folder does not exist, create it. You can find more information regarding which event handler each file expects to receive in the [Service Worker Example app's documentation](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/service-worker-example/blob/main/docs/README.md) (README file). For example:\n\n`1\n\nfunction exampleSWInstall() { \n\n2\n\n // eslint-disable-next-line no-console \n\n3\n\n console.log('[example-sw] Install of service worker') \n\n4\n\n} \n\n5\n\n \n6\n\nexport default \n\n`\n\n1. [Link your app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app).\n2. Open the store website on your browser and inspect it.\n3. In the `Console` tab, check if a message similar to `[service-worker-example] Install of service worker` is displayed. If you see this message, the app's service worker development was successful.\n4. [Deploy your app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available%23validating-the-deploy) once you are satisfied with the changes made.\n\nYour app's service worker will be automatically fetched and bundled with others exported by the apps installed in your VTEX account that also use the Service Worker builder.\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/pages/vtex-io-documentation-using-several-service-workers-in-your-store.md)\n\n[Managing URL redirects« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store//docs/guides/vtex-io-documentation-managing-url-redirects)[Managing performanceNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store//docs/guides/store-framework-managing-performance)\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-using-several-service-workers-in-your-store/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store%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/pages/vtex-io-documentation-using-several-service-workers-in-your-store.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-using-several-service-workers-in-your-store/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store%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_890d0be1
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides store framework styling in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/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/store-framework-styling/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/store-framework-styling/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/store-framework-styling/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/store-framework-styling/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/store-framework-styling/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/store-framework-styling/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/store-framework-styling/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/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/store-framework-styling/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/store-framework-styling/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/store-framework-styling/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/store-framework-styling/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/store-framework-styling/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/store-framework-styling/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/store-framework-styling/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework-styling)\n\nStyling\n\nDiscover how to customize your store layout with Store Framework.\n\nStyling directly impacts user experience and brand perception. A well-styled store attracts visitors and keeps them engaged, encouraging navigation and interaction with your site.\n\nIn [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework), styling is flexible and customizable, allowing you to create a visual identity that aligns with your brand. Whether you need to make minor adjustments or comprehensive changes, Store Framework’s tools enable you to tailor each visual element to meet specific business needs.\n\nIn this section, you will learn how to leverage our styling tools to customize your store.\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 [Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3) tutorial.\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* [styles builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-styles-builder): Exports CSS configurations for Store Framework blocks.\n\n### Create store pages\n\nDevelop your store pages by following the [Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/building-pages) guides.\n\n## Essential concepts\n\nTo better understand the styling process in Store Framework, you should know the concept of CSS Handle, which is a CSS class that maps to an HTML element. It serves as a layout-building assistant for your store, allowing you to customize any block by applying CSS classes within the Store Theme’s code. Therefore, CSS Handles streamline the layout customization of your store by targeting specific elements in your custom CSS.\n\nEach VTEX component is preconfigured with unique CSS Handles, allowing you to apply styles to specific parts of a component without changing its structure.\n\n## Guides in this section\n\n[Using CSS handles for store customizationsTarget and style specific elements within your store using CSS Handles.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization)[Contributing with new CSS HandlesEnhance the styling options available for VTEX IO components.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-contributing-with-new-css-handles)[Customizing your store's iconsReplace or customize the icons used across your store.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-icons)[Customizing your store’s typographyAdjust the typography in your store to create a cohesive design.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography)[Interactively inspecting storefront blocksInspect and identify block elements in your store for targeted customization.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store)[Using the Markers prop to customize a block's messageCustomize the messaging and appearance of blocks in your store using the markers prop.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message)\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-styling.md)\n\n[Site Editor schema examples« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling//docs/guides/vtex-io-documentation-site-editor-schema-examples)[Using CSS Handles for store customizationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling//docs/guides/vtex-io-documentation-using-css-handles-for-store-customization)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework-styling%23before-you-begin)\n\n[Develop your Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework-styling%23develop-your-store-theme)[Check the builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework-styling%23check-the-builders)[Create store pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework-styling%23create-store-pages)\n\n[Essential concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework-styling%23essential-concepts)\n\n[Guides in this section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework-styling%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-styling.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework-styling%23before-you-begin)\n\n[Develop your Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework-styling%23develop-your-store-theme)[Check the builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework-styling%23check-the-builders)[Create store pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework-styling%23create-store-pages)\n\n[Essential concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework-styling%23essential-concepts)\n\n[Guides in this section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-styling/docs/guides/store-framework-styling%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_85eb1f76
|
[
{
"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 configuring an edition app in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/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-configuring-an-edition-app/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/managing-edition-apps)\n\n[Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-edition-app)\n\n[Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-sponsor-account)\n\n[Becoming a Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-becoming-a-sponsor-account)\n\n[Developing an Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-configuring-an-edition-app)\n\n[Updating Edition apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-updating-edition-apps)\n\n[Seller Portal Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/seller-portal-edition-app)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/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-configuring-an-edition-app/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/managing-edition-apps)\n\n[Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-edition-app)\n\n[Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-sponsor-account)\n\n[Becoming a Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-becoming-a-sponsor-account)\n\n[Developing an Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-configuring-an-edition-app)\n\n[Updating Edition apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-updating-edition-apps)\n\n[Seller Portal Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/seller-portal-edition-app)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/app-development)\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/managing-edition-apps)\n\n[Developing an Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-configuring-an-edition-app)\n\nDeveloping an Edition App\n\nLearn now how to develop your own Edition Apps.\n\nIf you belong to a complex VTEX account family under the same brand or holding, creating an [Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/) can streamline the setup process of your accounts. This guide will walk you through the entire process of developing your Edition App and installing it on your child accounts.\n\n## Before you begin\n\nBefore you dive into the development process, ensure that you have already [enabled the Sponsor Account behavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account) on one of your accounts.\n\n## Instructions\n\nTo create a new Edition App, you'll initiate the development of a VTEX IO app. In this app, you will specify an Edition App dependency and define the apps to be included within the new Edition App.\n\n### Step 1 - Creating an Edition app\n\n1. Open the terminal and use [VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference) to log in to your Sponsor Account.\n2. Run the `vtex init` command to start a new VTEX IO app project.\n3. Select the `edition app` option when prompted. This will create a boilerplate repository in your local files.\n4. Change to the `edition-app` folder and open the `manifest.json` file. It should look something like this: \n`1 \n{ \n2 \n \"vendor\": \"vtex\", \n3 \n \"name\": \"edition-hello\", \n4 \n \"version\": \"0.1.1\", \n5 \n \"title\": \"Getting Started with VTEX Edition Apps\", \n6 \n \"description\": \"A sample edition app with a blank apps.json\", \n7 \n \"builders\": { \n8 \n \"edition\": \"0.x\" \n9 \n }, \n10 \n \"dependencies\": { \n11 \n \"vtex.edition-business\": \"0.x\" \n12 \n }, \n13 \n \"$schema\": \"https://raw.githubusercontent.com/vtex/node-vtex-api/master/gen/manifest.schema\" \n14 \n} \n`\n5. Customize the `manifest.json` file as follows: \n * Replace the `vendor` value with the name of your Sponsor Account. \n * Replace the `name` value with one of your choosing, using the `edition-` prefix for easier identification. \n * Set your app's `version`, `title`, and `description`.\n\n### Step 2 - Setting the Edition dependencies\n\nAn Edition App inherits its dependencies, encompassing all associated apps and configurations. It's crucial to understand that every Edition app must define a dependency, which must either be a native Edition App (`vtex.edition-business` or `vtex.edition-store`) or a previously developed Edition App from the same `vendor`.\n\n1. In the `manifest.json` file, go to the `dependecies` section.\n2. Change the `dependencies` declaration according to your needs: \n * If you use [Legacy CMS Portal](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/o-que-e-o-cms--EmO8u2WBj2W4MUQCS8262) and this is your first Edition App, set the `\"vtex.edition-business\": \"0.x\"` as a dependency. \n * If you use [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-store-framework) and this is your first Edition App, set the `\"vtex.edition-store\": \"5.x\"` as a dependency. \n * If you have more complex inheritance needs, change it to a previously developed Edition App from your `vendor`.\n3. Save your changes.\n\n### Step 3 - Declaring apps\n\nAfter setting up the initial configurations for your Edition App, you can declare the bundle of apps and configurations it will include. Note that a Edition App can only contain apps exclusively developed by the same `vendor` responsible for its release.\n\n1. Open the `edition/apps.json` file.\n2. In the `apps` section, add all the apps and settings you want to install in the child accounts as in the following: \n`1 \n{ \n2 \n \"apps\": { \n3 \n+ \"vtex.vtex-graphql-service\": { \n4 \n+ \"defaultMajor\": 1, \n5 \n+ \"allowedMajors\": [0, 2], \n6 \n+ \"allowsUninstall\": false, \n7 \n+ \"settings\": {} \n8 \n+ } \n9 \n } \n10 \n} \n` \n * `defaultMajor` or `major` \\- determines the major of the app. \n * (Optional) `allowedMajors` \\- specifies alternative majors that can be used by child accounts using the Edition App. If omitted, only the default major is allowed and cannot be changed. \n * (Optional) `allowsUninstall` \\- allows users to uninstall the app from the Edition manually using VTEX IO CLI (`vtex uninstall`). If omitted, it defaults to `false`, preventing app uninstallation by the child account. \n * (Optional) `settings` \\- defines the initial app settings when the app is installed in a child account. If omitted, which is recommended for most cases, no setting changes are made when installing the app. \nNote that the parent Edition always takes priority if any conflicts arise from declaring divergent app versions. This means you cannot change any inherited apps or configurations; you can only extend them.\n3. Save your changes.\n\n### Step 4 - Deploying the Edition App\n\nOnce you are sure of all the changes made, [publish and deploy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app) your Edition App.\n\n### Step 5 - Installing the Edition App on a child account\n\n[Open a ticket](https://read.calvincode.net/reader?url=https://help-tickets.vtex.com/smartlink/sso/login/zendesk) with the VTEX Support team, requesting the installation of your new Edition App on the desired child accounts.\n\nFrom the child accounts' perspective, the apps specified in an Edition App are immutable. That means they cannot modify or uninstall apps installed by a Sponsor Account.\n\nIf you need to modify any app or configuration of your Edition App, you must launch a new version with these changes. For more information, see the [Updating Edition apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps) guide.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/managing-edition-apps/vtex-io-documentation-configuring-an-edition-app.md)\n\n[Becoming a Sponsor Account« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app//docs/guides/vtex-io-documentation-becoming-a-sponsor-account)[Updating Edition appsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app//docs/guides/vtex-io-documentation-updating-edition-apps)\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-configuring-an-edition-app/docs/guides/vtex-io-documentation-configuring-an-edition-app%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-configuring-an-edition-app%23instructions)\n\n[Step 1 - Creating an Edition app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-configuring-an-edition-app%23step-1-creating-an-edition-app)[Step 2 - Setting the Edition dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-configuring-an-edition-app%23step-2-setting-the-edition-dependencies)[Step 3 - Declaring apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-configuring-an-edition-app%23step-3-declaring-apps)[Step 4 - Deploying the Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-configuring-an-edition-app%23step-4-deploying-the-edition-app)[Step 5 - Installing the Edition App on a child account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-configuring-an-edition-app%23step-5-installing-the-edition-app-on-a-child-account)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/managing-edition-apps/vtex-io-documentation-configuring-an-edition-app.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-configuring-an-edition-app%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-configuring-an-edition-app%23instructions)\n\n[Step 1 - Creating an Edition app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-configuring-an-edition-app%23step-1-creating-an-edition-app)[Step 2 - Setting the Edition dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-configuring-an-edition-app%23step-2-setting-the-edition-dependencies)[Step 3 - Declaring apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-configuring-an-edition-app%23step-3-declaring-apps)[Step 4 - Deploying the Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-configuring-an-edition-app%23step-4-deploying-the-edition-app)[Step 5 - Installing the Edition App on a child account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app/docs/guides/vtex-io-documentation-configuring-an-edition-app%23step-5-installing-the-edition-app-on-a-child-account)\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_8f92964b
|
[
{
"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 2 prerequesites 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-2-prerequesites/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-2-prerequesites/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-2-prerequesites/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-2-prerequesites/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-2-prerequesites/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-2-prerequesites/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-2-prerequesites/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-2-prerequesites/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-2-prerequesites/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/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-2-prerequesites/docs/guides/getting-started-3)\n\n[1\\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/docs/guides/vtex-io-documentation-1-basicsetup)\n\n[2\\. Configuring your account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/docs/guides/vtex-io-documentation-2-prerequesites)\n\n[3\\. Creating a Store Theme project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/docs/guides/vtex-io-documentation-3-settingyourstoretheme)\n\n[4\\. Configuring templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/docs/guides/vtex-io-documentation-4-configuringtemplates)\n\n[5\\. Defining styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/docs/guides/vtex-io-documentation-5-definingstyles)\n\n[6\\. Building your own store theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/docs/guides/vtex-io-documentation-6-buildingyourownstoretheme)\n\n[7\\. Making your store theme public](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/docs/guides/vtex-io-documentation-making-your-theme-content-public)\n\n[Glossary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/docs/guides/store-framework-glossary)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/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-2-prerequesites/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-2-prerequesites/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-2-prerequesites/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-2-prerequesites/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-2-prerequesites/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-2-prerequesites/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-2-prerequesites/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-2-prerequesites/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-2-prerequesites/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/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-2-prerequesites/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-2-prerequesites/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-2-prerequesites/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-2-prerequesites/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-2-prerequesites/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/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-2-prerequesites/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-2-prerequesites/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/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-2-prerequesites/docs/guides/getting-started-3)\n\n[1\\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/docs/guides/vtex-io-documentation-1-basicsetup)\n\n[2\\. Configuring your account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/docs/guides/vtex-io-documentation-2-prerequesites)\n\n[3\\. Creating a Store Theme project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/docs/guides/vtex-io-documentation-3-settingyourstoretheme)\n\n[4\\. Configuring templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/docs/guides/vtex-io-documentation-4-configuringtemplates)\n\n[5\\. Defining styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/docs/guides/vtex-io-documentation-5-definingstyles)\n\n[6\\. Building your own store theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/docs/guides/vtex-io-documentation-6-buildingyourownstoretheme)\n\n[7\\. Making your store theme public](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/docs/guides/vtex-io-documentation-making-your-theme-content-public)\n\n[Glossary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/docs/guides/store-framework-glossary)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/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-2-prerequesites/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-2-prerequesites/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-2-prerequesites/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-2-prerequesites/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-2-prerequesites/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-2-prerequesites/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-2-prerequesites/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-2-prerequesites/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-2-prerequesites/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/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-2-prerequesites/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-2-prerequesites/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-2-prerequesites/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-2-prerequesites/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-2-prerequesites/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/docs/guides/store-framework)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/docs/guides/getting-started-3)\n\n[2\\. Configuring your account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/docs/guides/vtex-io-documentation-2-prerequesites)\n\n2\\. Configuring your account\n\nSet up your account Edition to get started with Store Framework.\n\nAfter setting up your development workspace, configure your account to fully leverage the VTEX Store Framework. This guide will walk you through two essential prerequisites:\n\n* [Setting up your account's Edition app](#step-1---setting-your-accounts-edition-app)\n* [Implementing VTEX Intelligent Search](#step-2---implementing-the-vtex-intelligent-search)\n\n## Instructions\n\n### Step 1 - Setting your account's Edition app\n\nThe [Edition app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/) is essential to your VTEX account, as it installs a bundle of settings and basic configurations. To check the current version of the Edition app installed in your account, use the following command:\n\n`1\n\nvtex edition get \n\n`\n\nIf the current edition differs from or is older than `vtex.edition-store@3.x`, [open a support ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/support?/cultureInfo=en-us) and request the installation of the `vtex.edition-store@3.x` or a newer one in your VTEX account.\n\nLearn more about the available versions and find the one that best fits your needs in the [Edition app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app) guide.\n\n> Both new VTEX accounts and those previously using the [Legacy CMS Portal](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/what-is-cms--EmO8u2WBj2W4MUQCS8262) must formally request the installation of the `vtex.edition-store@3.x` or a more recent version of the Edition app. This is necessary as every VTEX account is configured by default with the `vtex.edition-business` version, which is the Legacy CMS Portal Edition app.\n\n### Step 2 - Implementing the VTEX Intelligent Search\n\nBefore you start building your storefront with Store Framework, configure [Intelligent Search](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb) — an advanced search engine designed to assist shoppers throughout their entire purchasing journey.\n\nIt's an alternative to the platform's legacy native search engine but requires installing two apps on your VTEX account:\n\n* `admin-search`: Allows stores to configure every feature provided by the search solution, including initial catalog indexing.\n* `search-resolver`: Serves as the main backend app for Intelligent Search, handling all search queries.\n\n> If you use the `vtex.edition-store@3.x` version, you must also [install the Search apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites%23step-2---implementing-the-vtex-intelligent-search). If you use the `vtex.edition-store@5.x`, you must start the Search Integration process directly, as Intelligent Search is configured by default in this version.\n\n#### Installing the Search apps\n\n1. Open the terminal and log in to your VTEX account: \n`1 \nvtex login {accountName} \n`\n\n> Replace `{accountName}` with the name of your account.\n\n1. After successfully logging in, run the following command to install the `admin-search` and `search-resolver` apps at the `master` workspace: \n`1 \nvtex install vtex.admin-search vtex.search-resolver@1.x \n`\n\n#### Starting the Search Integration process\n\nAfter installing the Intelligent Search apps, follow these steps to index your store's catalog and integrate it with Intelligent Search:\n\n1. In the VTEX Admin, go to **Store Settings > Intelligent Search > Integrations**.\n2. Click `Start integration`. \n\n\nThe indexing process will start, and you'll receive a link to the Indexing Status page. Once completed, your store will be fully ready to use the Store Framework effectively.\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/Getting-Started/getting-started-3/vtex-io-documentation-2-prerequesites.md)\n\n[1\\. Setting up your development environment« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites//docs/guides/vtex-io-documentation-1-basicsetup)[3\\. Creating a Store Theme projectNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites//docs/guides/vtex-io-documentation-3-settingyourstoretheme)\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-2-prerequesites/docs/guides/vtex-io-documentation-2-prerequesites%23instructions)\n\n[Step 1 - Setting your account's Edition app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/docs/guides/vtex-io-documentation-2-prerequesites%23step-1-setting-your-accounts-edition-app)[Step 2 - Implementing the VTEX Intelligent Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/docs/guides/vtex-io-documentation-2-prerequesites%23step-2-implementing-the-vtex-intelligent-search)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Getting-Started/getting-started-3/vtex-io-documentation-2-prerequesites.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-2-prerequesites/docs/guides/vtex-io-documentation-2-prerequesites%23instructions)\n\n[Step 1 - Setting your account's Edition app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/docs/guides/vtex-io-documentation-2-prerequesites%23step-1-setting-your-accounts-edition-app)[Step 2 - Implementing the VTEX Intelligent Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites/docs/guides/vtex-io-documentation-2-prerequesites%23step-2-implementing-the-vtex-intelligent-search)\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_4e1283da
|
[
{
"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 1.0.8 DidYouMean app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/vtex-io-apps)\n\nDidYouMean\n\n[vtex.search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search)\n\nVersion: 1.0.8\n\nLatest version: 2.18.8\n\n> This page is about version **1.0.8** of the app, which is not the most recent version. The latest stable version is **2.18.8**.\n\n`DidYouMean` is a component used to suggest a possible misspelling correction to the current query.\n\n## Usage\n\nAdd the `did-you-mean` block to the `search-result-layout.desktop` or `search-result-layout.mobile`. For example:\n\n`1\n\n\"search-result-layout.desktop\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"flex-layout.row#didyoumean\", \n\n4\n\n ], \n\n5\n\n \"flex-layout.row#didyoumean\": { \n\n6\n\n \"children\": [\"did-you-mean\"] \n\n7\n\n } \n\n8\n\n} \n\n`\n\n## Customization\n\nIn order to apply CSS customizations in this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization).\n\n| CSS Handles |\n| ---------------- |\n| didYouMeanPrefix |\n| didYouMeanTerm |\n\nSee also\n\n[Vtex.searchVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/apps/vtex.search)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/apps/vtex.search@1.0.8/DidYouMean%23usage)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search@1.0.8/DidYouMean/docs/apps/vtex.search@1.0.8/DidYouMean%23customization)\n\nWas this helpful?\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_4074a564
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore storefront features implementing live shopping for faststore previous versions in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-overview)\n\n[Adding third-party scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-handling-third-party-scripts)\n\n[Building navigation menus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-building-navigation-menus)\n\n[Displaying content for authenticated users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users)\n\n[Implementing regionalization features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-regionalization-features)\n\n[Implementing search features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-search-features)\n\n[Managing product images in specific contexts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-managing-product-images-in-specific-contexts)\n\n[Implementing Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/delivery-promise-implementation)\n\n[Implementing Live Shopping for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore)\n\n[Implementing Live Shopping for FastStore previous versions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-overview)\n\n[Adding third-party scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-handling-third-party-scripts)\n\n[Building navigation menus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-building-navigation-menus)\n\n[Displaying content for authenticated users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users)\n\n[Implementing regionalization features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-regionalization-features)\n\n[Implementing search features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-search-features)\n\n[Managing product images in specific contexts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-managing-product-images-in-specific-contexts)\n\n[Implementing Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/delivery-promise-implementation)\n\n[Implementing Live Shopping for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore)\n\n[Implementing Live Shopping for FastStore previous versions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-overview)\n\n[Implementing Live Shopping for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore)\n\nImplementing Live Shopping for FastStore previous versions\n\n> This is an experimental feature.\n\n**Live Shopping for FastStore** adds a customizable player on your storefront to transmit [Live Shopping](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-live-shopping-getting-started--3eCHNCIx8XhZOSmX0sQT3U) events. This guide explains how to integrate **Live Shopping** into a [FastStore v1 or v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels) project. After the implementation, you will be able to [configure and manage](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-live-shopping-getting-started--3eCHNCIx8XhZOSmX0sQT3U/125yr6jAfwiiz84JP4ppfO) event transmissions via VTEX Admin.\n\n> If you use the latest version of [FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore), refer to the guide [Implementing Live Shopping for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore).\n\n## Before you begin\n\nBefore installing **Live Shopping** for [FastStore previous versions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-faststore-versions-and-support-levels), make sure you've installed the Headless CMS on your page to be able to customize it via VTEX Admin, as described in the [FastStore documentation](https://read.calvincode.net/reader?url=https://www.faststore.dev/how-to-guides/cms/vtex).\n\n## Getting the Live Shopping app\n\nFollow the steps below:\n\n1. Access [VTEX Live Shopping](https://read.calvincode.net/reader?url=https://apps.vtex.com/vtexventures-livestreaming/p) on VTEX App Store. You can also access it via the VTEX Admin through **Apps > App Store > VTEX Live Shopping**.\n2. Click `Get app` to install the app. Log in to your VTEX account if necessary.\n3. Click `Place order`.\n4. Click `Go to install page`.\n5. Click `Install`.\n6. Agree to the Terms of Service by clicking `Install`.\n\n## Configuring the Live Shopping component\n\nOnce you have the **Live Shopping** app on your store project, follow the instructions to integrate the component:\n\n1. [Create the component](#creating-the-component)\n2. [Connect the component to the CMS](#connecting-the-component-to-the-cms)\n3. [Configure CMS sections](#configuring-cms-sections)\n\n### Creating the component\n\nTo create the **Live Shopping** component, follow the steps below:\n\n1. In your FastStore project, go to `src/components/sections`.\n2. Create a new folder named `LiveShopping`.\n3. Inside this folder, create the following files:\n\n`index.tsx`\n\n`1\n\nexport { default } from './LiveShopping' \n\n2\n\nexport type { LiveShoppingProps } from './LiveShopping' \n\n`\n\n`LiveShopping.tsx`\n\n`` 1\n\nimport Section from '../Section' \n\n2\n\n \n3\n\n \n4\n\nexport interface LiveShoppingProps { \n\n5\n\n script: string \n\n6\n\n} \n\n7\n\n \n8\n\n \n9\n\nfunction LiveShopping(section: LiveShoppingProps) { \n\n10\n\n return ( \n\n11\n\n section?.script && ( \n\n12\n\n <Section className=\"liveshopping__section\"> \n\n13\n\n <div id=\"nz-player\" /> \n\n14\n\n \n15\n\n \n16\n\n <script \n\n17\n\n key=\"nz-player-script\" \n\n18\n\n id=\"nz-player-script\" \n\n19\n\n type=\"module\" \n\n20\n\n async \n\n21\n\n src={`${section?.script}&originOfProducts=faststore`} \n\n22\n\n /> \n\n23\n\n </Section> \n\n24\n\n ) \n\n25\n\n ) \n\n26\n\n} \n\n27\n\n \n28\n\nexport default LiveShopping \n\n ``\n\nOnce you're done, your directory structure should look like the one below:\n\n`1\n\nsrc/ \n\n2\n\n └── components/ \n\n3\n\n └── sections/ \n\n4\n\n └── LiveShopping/ \n\n5\n\n ├── index.tsx \n\n6\n\n └── LiveShopping.tsx \n\n`\n\n### Connecting the component to the CMS\n\nTo connect the component to the CMS, follow the steps below:\n\n1. Locate the CMS renderer file (usually `RenderCMS.tsx`).\n2. Import the previously created component:\n\n`1\n\nimport LiveShopping from 'src/components/sections/LiveShopping' \n\n`\n\n1. Add it to the `COMPONENTS` constant, which contains an object with the components related to sections added to the CMS.\n\n`1\n\nconst COMPONENTS: Record<string, ComponentType<any>> = { \n\n2\n\n LiveShopping, \n\n3\n\n} \n\n`\n\n### Configuring CMS sections\n\n1. Go to `cms/faststore/sections.json`.\n2. Edit the `sections.json` file by adding the following schema:\n\n`1\n\n{ \n\n2\n\n \"name\": \"LiveShopping\", \n\n3\n\n \"schema\": { \n\n4\n\n \"title\": \"LiveShopping\", \n\n5\n\n \"description\": \"Setting LiveShopping\", \n\n6\n\n \"type\": \"object\", \n\n7\n\n \"required\": [\"script\"], \n\n8\n\n \"properties\": { \n\n9\n\n \"script\": { \n\n10\n\n \"type\": \"string\", \n\n11\n\n \"title\": \"Script\" \n\n12\n\n } \n\n13\n\n } \n\n14\n\n } \n\n15\n\n } \n\n`\n\n1. Save changes.\n2. For the **Live Shopping** section to be available on your VTEX Admin, sync your CMS by running the command below:\n\n`1\n\nvtex cms sync \n\n`\n\nYou will be able to add the **Live Shopping** section to the store's CMS:\n\n\n\n## First Live Shopping event\n\nThe first step is to [create an event](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-live-shopping-getting-started--3eCHNCIx8XhZOSmX0sQT3U/5WLXGbOSFmxN7QlzOnfGrv) on VTEX Admin. After that, there will be two other moments that will require configuring the CMS:\n\n* **Start the event:** Place the component to show the player on the storefront.\n* **End the event:** Delete the component to remove the player.\n\n> Be aware that not all **Live Shopping** configurations are available for previous versions of FastStore, as explained in the section [Feature restrictions](#feature-restrictions).\n\n### Placing the component\n\nTo place the component on your project, follow the steps below:\n\n1. In the VTEX Admin, go to **Apps > Live Shopping > Events**, or type **Events** in the search bar at the top of the page.\n2. In the **Action** column, click the arrow button to go to the [Event page](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/live-shopping-events--6aGLiqoKG1UoS30f3FFWch).\n3. In the **CMS Configuration** section, select the `External template` option in **Script for template**.\n4. Copy the `src` attribute value from the `<script>` tag, without the quotation marks.\n\n\n\n1. Go to **Storefront > Headless CMS** and add the LiveShopping section to a page.\n2. On that page, paste the `src` value you've copied on the **LiveShopping** field.\n3. Save changes.\n4. Publish the page.\n\nAfter that, you will be able to [transmit](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-live-shopping-getting-started--3eCHNCIx8XhZOSmX0sQT3U/69PX90vv4oDWQ34nnBkiQt) a **Live Shopping** event. If you don't have the expected result, check [Troubleshooting script not rendering](#troubleshooting-script-not-rendering).\n\n### Removing the component\n\nTo delete the component from your store, follow the steps below:\n\n1. In the VTEX Admin, go to **Storefront > Headless CMS**, or type **Headless CMS** in the search bar at the top of the page.\n2. Select the page where you've added the **Live Shopping** Player.\n3. On the `Sections` tab, in the **Live Shopping Player** section, click **More > Delete**.\n4. Click `Save`.\n5. Click **Publish > Publish Now**.\n6. (Optional) If the page version had been published before and the **Overwrite Published Version** window opens, click `Overwrite`.\n\n## Feature restrictions\n\nSince the **Live Shopping Player** isn't a native solution for FastStore previous versions, there will be some feature limitations. The recommendations you must follow while [configuring a Live Shopping event](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-live-shopping-getting-started--3eCHNCIx8XhZOSmX0sQT3U/125yr6jAfwiiz84JP4ppfO) are listed below:\n\n> Make sure to follow our recommendations on CMS and Settings configurations, as misconfiguration can compromise the transmission of the **Live Shopping** event.\n\n* ❌ **UTM configuration:** Not supported as a native solution, so data tracking isn't available.\n* ❌ **Add to Cart configuration:** Not supported as a native solution, but can be used while presenting a different behavior. When the customer clicks `Add to Cart` on the Live Shopping event, instead of adding the product to the cart, it will open the product details page (PDP) in a new tab, from where the customer can add the item to the cart.\n* ❌ **Quick View configuration:** Not supported as a native solution and mustn't be activated on the CMS section of the [events page](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/live-shopping-events--6aGLiqoKG1UoS30f3FFWch). Otherwise the customer might have cart errors while using the Add to Cart configuration.\n* ❌ **Popup transmission configuration:** Not supported as a native solution and mustn't be activated on the [events page](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/live-shopping-events--6aGLiqoKG1UoS30f3FFWch). Otherwise it may delete the live event itself. It can be found under the Player configuration on the Settings section.\n\n## Troubleshooting script not rendering\n\nAfter [placing the Live Shopping component](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-live-shopping-getting-started--3eCHNCIx8XhZOSmX0sQT3U/4r5uk6XHxdYlOGMr11GFWR) on your FastStore project, if the **Live Shopping** application does not render or display on the storefront, even though the script appears when inspecting elements, try wrapping the **Live Shopping** script in an iframe instead.\n\n### Alternative `LiveShopping.tsx` (with iframe)\n\nAfter doing so, when inspecting the elements you should see something like the following example:\n\n\n\nContributors\n\n1\n\n[](https://github.com/Isabella-Veloso)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/storefront-features/implementing-live-shopping-for-faststore-previous-versions.mdx)\n\n[Implementing Live Shopping for FastStore« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore)[FastStore APINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/faststore-api-overview)\n\nContributors\n\n1\n\n[](https://github.com/Isabella-Veloso)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions%23before-you-begin)\n\n[Getting the Live Shopping app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions%23getting-the-live-shopping-app)\n\n[Configuring the Live Shopping component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions%23configuring-the-live-shopping-component)\n\n[Creating the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions%23creating-the-component)[Connecting the component to the CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions%23connecting-the-component-to-the-cms)[Configuring CMS sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions%23configuring-cms-sections)\n\n[First Live Shopping event](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions%23first-live-shopping-event)\n\n[Placing the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions%23placing-the-component)[Removing the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions%23removing-the-component)\n\n[Feature restrictions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions%23feature-restrictions)\n\n[Troubleshooting script not rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions%23troubleshooting-script-not-rendering)\n\n[Alternative LiveShopping.tsx (with iframe)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions%23alternative-liveshoppingtsx-with-iframe)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/storefront-features/implementing-live-shopping-for-faststore-previous-versions.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions%23before-you-begin)\n\n[Getting the Live Shopping app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions%23getting-the-live-shopping-app)\n\n[Configuring the Live Shopping component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions%23configuring-the-live-shopping-component)\n\n[Creating the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions%23creating-the-component)[Connecting the component to the CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions%23connecting-the-component-to-the-cms)[Configuring CMS sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions%23configuring-cms-sections)\n\n[First Live Shopping event](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions%23first-live-shopping-event)\n\n[Placing the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions%23placing-the-component)[Removing the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions%23removing-the-component)\n\n[Feature restrictions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions%23feature-restrictions)\n\n[Troubleshooting script not rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions%23troubleshooting-script-not-rendering)\n\n[Alternative LiveShopping.tsx (with iframe)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions%23alternative-liveshoppingtsx-with-iframe)\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_4540e02b
|
[
{
"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 creating a regular order with the checkout api in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/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/creating-a-regular-order-with-the-checkout-api/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/creating-a-regular-order-with-the-checkout-api/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/creating-a-regular-order-with-the-checkout-api/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/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/creating-a-regular-order-with-the-checkout-api/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/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/creating-a-regular-order-with-the-checkout-api/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/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/creating-a-regular-order-with-the-checkout-api/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/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/creating-a-regular-order-with-the-checkout-api/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/creating-a-regular-order-with-the-checkout-api/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/creating-a-regular-order-with-the-checkout-api/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/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/creating-a-regular-order-with-the-checkout-api/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/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/creating-a-regular-order-with-the-checkout-api/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/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/creating-a-regular-order-with-the-checkout-api/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/checkout-api-overview)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/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/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api)\n\nCreating a regular order with the Checkout API\n\nLearn how to use VTEX APIs to efficiently handle the placement, payment, and delivery aspects of a regular order.\n\nThis step-by-step guide will walk you through the process of using the [Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api) and [Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api) for handling the placement, payment, and delivery aspects of a regular order, with all responsibilities managed within the scope of a single account. It is divided into the following steps:\n\n1. **Assess cart requirements:** Begin by simulating a cart to assess available delivery and payment options. This step also involves checking whether the provided email address is already associated with an existing customer, which is required to place an order.\n2. **Assemble the cart:** Continue by building the cart, ensuring that all essential order details are properly structured according to the [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) data structure.\n3. **Handle the order:** Place the order on the VTEX platform and send all required payment data to process the payment for the order.\n4. **Process and validate the order:** The process concludes with the processing of order details and a verification procedure to confirm the order's successful placement.\n\n## Before you begin\n\nBefore proceeding any further, ensure that you have a valid `appKey` and `appToken` with the necessary permissions to access the [Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api) and [Payments Gateway](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api) APIs. For more information, refer to the [Roles](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) article.\n\n> Click the steps below to navigate through this article and explore specific topics. Relevant code for each phase or parameter is highlighted on the right side of the screen.\n\n## Step 1 - Assessing cart requirements\n\nIn this step, we will verify that your store can fulfill the cart requirements and collect the essential order details necessary to ensure a smooth order placement process in the subsequent steps.\n\n### Simulating a cart\n\nUse the [Cart simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForms/simulation) endpoint to obtain the available delivery and payment options for the current cart configuration. In this request, you must provide the following information in the request body:\n\n* `items.id`: SKU ID.\n* `items.quantity`: The number of items in the cart.\n* `items.seller`: Seller's ID.\n* `country`: Three-letter ISO code of the country of the shipping address.\n* `postalCode` or `geoCoordinates`: Shipping address's postal code or geocoordinates.\n\nUpon receiving a `200 OK` response, the request will provide a response body containing all information about the cart. Take note of the following information, as it will be used in the following steps:\n\n* `items`\n* `paymentData`\n* `logisticsInfo`\n\n### Checking for existing customer\n\nSend a request to the [Get client by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pub/profiles) endpoint to ensure a customer profile exists in your database associated with the email to be used in the order.\n\nUpon receiving a `200 OK` response, the request will provide a response body containing all information about the customer profile. Take note of the following information, as it will be used in the following steps:\n\n* `availableAddresses`\n* `userProfile`\n\n> If the response body fields are empty in this request, it may indicate that no customer is registered under this email, or that the customer profile is invalid or incomplete. In this case, you can use a different email address or enter data for a new customer when assembling the cart.\n\n## Step 2 - Assembling the cart\n\nIn this step, we will arrange the order details into the specified data format, following the [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) data structure. This formatted cart data will be used as the request body in the following steps.\n\nBelow, we will briefly examine the key elements that make up the [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields), which include:\n\n* `items`\n* `clientProfileData`\n* `shippingData.address`\n* `shippingData.logisticsInfo`\n* `paymentData`\n\n> While an `orderForm` may include various elements, a standard order generally comprises the key components described above.\n\n### `items`\n\n`items` is an array that contains all data pertinent to the SKUs being purchased. Build the `items` array using the `items` array obtained from the [Simulating a cart](#simulating-a-cart) step. For more complex examples, see the [Place order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23put-/api/checkout/pub/orders) API reference.\n\n### `clientProfileData`: New customers\n\n`clientProfileData` is an object that contains information about the customer. If you noted the customer does not exist in your database during the [Checking for existing customer](#checking-for-existing-customer) step, build the `clientProfileData` object with the data of the new customer willing to place the order.\n\n### `clientProfileData`: Existing customers\n\nIf the customer already exists in your database, use the `userProfile.email` obtained in the [Checking for existing customer](#checking-for-existing-customer) step to build the `clientProfileData` object. The email address is enough to register the order to the shopper’s existing account.\n\n### `shippingData.address`: New customers\n\n`shippingData.address` is an object that contains information about the shipping address. If you noted the customer does not exist in your database during the [Checking for existing customer](#checking-for-existing-customer) step, build the `shippingData.address` object with the data of the new customer willing to place the order.\n\n### `shippingData.address`: Existing customers\n\nIf the customer already exists in your database, use the desired `availableAddresses[i].addressId` obtained from the [Checking for existing customer](#checking-for-existing-customer) step to build the `shippingData.address` block.\n\n### `shippingData.logisticsInfo`\n\n`logisticsInfo` is an array that contains logistics information, such as the desired delivery option and freight cost for each item in the `items` array.\n\n* Create the `logisticsInfo` array with the same number of objects as in the `items` array. For each object within the `logisticsInfo` array, define the following elements: \n * `itemIndex` \\- index of the corresponding item in the `items` array. For example, the object referring to the first item in the `items` array has an `itemIndex` of `0`. \n * `selectedSla` \\- desired delivery option. You can find the `id` value of the available options in the `slas` array obtained from the [Simulating a cart](#simulating-a-cart) step. \n * `price` \\- price of the item. You can retrieve this value from the [Simulating a cart](#simulating-a-cart) step. \n * (Optional) If the delivery method is pickup point, add the information `\"selectedDeliveryChannel\": \"pickup-in-point\"`.\n\n### `paymentData.payments`\n\n`paymentData.payments` is an array that contains information regarding the chosen payment method and installment preferences for the order. Build the `paymentData.payments` array considering the response obtained from the [Simulating a cart](#simulating-a-cart) step. For each payment option, define the following elements:\n\n* `paymentSystem` \\- ID of the desired payment system.\n* `referenceValue` \\- reference value used to calculate interest rates. If no interest applies to the order, the `value` and `referenceValue` should be the same.\n* `value` \\- total amount to be paid by the shopper.\n* `installments` \\- number of installments.\n\nFor more complex examples, see the [Place order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23put-/api/checkout/pub/orders) API reference.\n\n## Step 3 - Handling the order\n\nBefore creating the new order, it is necessary to verify that the `orderForm` created in the previous steps has the appropriate structure in a valid JSON format.\n\n### New customer `orderForm`\n\nIf the `orderForm` was created for a new customer (not yet registered in the store's database), it should follow this structure.\n\n### Existing customer `orderForm`\n\nIf the `orderForm` was created for an existing customer who already has a customer profile registered in the store's database, it should follow this structure.\n\n### Placing the order\n\nPlace a new order via the [Place order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23put-/api/checkout/pub/orders) endpoint using the `orderForm` you built as the request body.\n\nUpon receiving a `201 Created` response, take note of these five pieces of information:\n\n* `transactionId` \\- ID of the transaction, which can be found within an object contained in the `merchantTransactions` array.\n* `orderId` \\- ID of the order within VTEX’s Order Management System (OMS). You can find the `orderId` within each object in the `orders` array.\n* `orderGroup` \\- ID that groups all orders related to the same purchase. For example, when an order is fulfilled by multiple sellers, each seller has its own order ID (`v71021570str-01` and `v71021570str-02`), but they share the same order group ID (`v71021570str`).\n* `addressId` \\- ID of the customer address. If you plan to use the same address for both shipping and billing, get the `addressId` from the `orders[].shippingData.address` object.\n* `Vtex_CHKO_Auth` \\- authentication cookie provided in the response.\n\n> If you are using an email from an existing customer, ensure that the corresponding customer account is logged into your store. Otherwise, the process will fail.\n\n### Resolving the order payment\n\nNow, we will communicate the necessary payment data to VTEX to finalize the order payment.\n\n> Starting from the moment the order is placed, you have 5 minutes to submit the payment information and process the order (Step 4). If the payment information and order are not submitted and processed within 5 minutes, the order will be automatically canceled.\n\n* Send a request to the [Send payments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api%23post-/api/payments/transactions/-transactionId-/payments) endpoint, considering the following: \n * Use the `transactionId` value from the previous step as both the path parameter and the value for the `id` field within the `transaction` object. \n * Set the `merchantName` field within the `transaction` object to your account name. \n * Use the `orderId` value from the previous step as a query string parameter. \n * Ensure that the request body is based on the `paymentData` section of your `orderForm`. \n * In the `fields` object, you can: \n * Fill in the credit or debit card information (when applicable). \n * Use the `addressId` field to reference an existing address, or provide a new `address` object for an entirely new address. This type of information is only required if the shopper's address was not previously entered during checkout.\n\n> This request does not return any data in the response body, only a `201 Created` success confirmation message.\n\n## Step 4 - Processing and validating the order\n\nIn this final step, we will process the order.\n\n* Send a request to the [Process order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/gatewayCallback/-orderGroup-) endpoint, using the `orderGroup` value as a path parameter.\n\n> If the payment is processed without any issues, the order should be successfully placed (`204 No Content` status). Otherwise, a `500 Internal Server Error` message might occur.\n\n> Note that this process uses the gateway connectors configured in your VTEX environment. Be careful to prevent any unwanted charges or unexpected payment denials.\n\n### Verifying the order placement\n\nFinally, you can confirm if your order was correctly placed by checking the [Order management](https://read.calvincode.net/reader?url=https://newhelp.vtex.com/docs/tutorials/all-orders) in VTEX Admin. Alternatively, you can use the [Get order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/oms/pvt/orders/-orderId-) and [List orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/oms/pvt/orders) endpoints for this purpose.\n\nShell\n\nPython\n\nNode.js\n\n`1\n\ncurl --request post \\ \n\n2\n\n --url 'https://{accountName}.{environment}.com.br/api/checkout/pub/orderForms/simulation?RnbBehavior=0' \\ \n\n3\n\n --header 'Accept: application/json' \\ \n\n4\n\n --header 'Content-Type: application/json' \\ \n\n5\n\n --header 'X-VTEX-API-AppKey: {appKey}' \\ \n\n6\n\n --header 'X-VTEX-API-AppToken: {appToken}' \\ \n\n7\n\n --data '{\"items\":[{\"id\":\"1\",\"quantity\":1,\"seller\":\"1\"}],\"country\":\"BRA\",\"postalCode\":\"12345-000\",\"geoCoordinates\":[-47.924747467041016]}' \n\n`\n\nResponse\n\n`1\n\n{ \n\n2\n\n \"items\": [], \n\n3\n\n \"ratesAndBenefitsData\": {}, \n\n4\n\n \"paymentData\": {}, \n\n5\n\n \"selectableGifts\": [], \n\n6\n\n \"marketingData\": {}, \n\n7\n\n \"postalCode\": string, \n\n8\n\n \"country\": string, \n\n9\n\n \"logisticsInfo\": [], \n\n10\n\n \"messages\": [], \n\n11\n\n \"purchaseConditions\": {}, \n\n12\n\n \"pickupPoints\": [], \n\n13\n\n \"subscriptionData\": string, \n\n14\n\n \"totals\": [], \n\n15\n\n \"itemMetadata\": {}, \n\n16\n\n \"sellers\": [], \n\n17\n\n \"allowMultipleDeliveries\": boolean, \n\n18\n\n \"minimumOrderValue\": number \n\n19\n\n} \n\n`\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/creating-a-regular-order-with-the-checkout-api.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/guides/Checkout/creating-a-regular-order-with-the-checkout-api.mdx)\n\n[Order Placement« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api//docs/guides/orders-2)[Creating a regular order from an existing cartNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api//docs/guides/creating-a-regular-order-from-an-existing-cart)\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/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23before-you-begin)\n\n[Step 1 - Assessing cart requirements](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23step-1-assessing-cart-requirements)\n\n[Simulating a cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23simulating-a-cart)[Checking for existing customer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23checking-for-existing-customer)\n\n[Step 2 - Assembling the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23step-2-assembling-the-cart)\n\n[items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23items)[clientProfileData: New customers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23clientprofiledata-new-customers)[clientProfileData: Existing customers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23clientprofiledata-existing-customers)[shippingData.address: New customers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23shippingdataaddress-new-customers)[shippingData.address: Existing customers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23shippingdataaddress-existing-customers)[shippingData.logisticsInfo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23shippingdatalogisticsinfo)[paymentData.payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23paymentdatapayments)\n\n[Step 3 - Handling the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23step-3-handling-the-order)\n\n[New customer orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23new-customer-orderform)[Existing customer orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23existing-customer-orderform)[Placing the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23placing-the-order)[Resolving the order payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23resolving-the-order-payment)\n\n[Step 4 - Processing and validating the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23step-4-processing-and-validating-the-order)\n\n[Verifying the order placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23verifying-the-order-placement)\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_c07b01a4
|
[
{
"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 ProductSummaryAttachmentList 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/ProductSummaryAttachmentList/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/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/apps/vtex.product-summary@2.91.0/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/apps/vtex.product-summary@2.91.0/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/apps/vtex.product-summary@2.91.0/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/apps/vtex.product-summary@2.91.0/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/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/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/ProductSummaryAttachmentList/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/ProductSummaryAttachmentList/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/ProductSummaryAttachmentList/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/ProductSummaryAttachmentList/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/ProductSummaryAttachmentList/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/ProductSummaryAttachmentList/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/ProductSummaryAttachmentList/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/ProductSummaryAttachmentList/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/ProductSummaryAttachmentList/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/ProductSummaryAttachmentList/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/ProductSummaryAttachmentList/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/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/ProductSummaryAttachmentList/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/ProductSummaryAttachmentList/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/ProductSummaryAttachmentList/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/ProductSummaryAttachmentList/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/ProductSummaryAttachmentList/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/ProductSummaryAttachmentList/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/ProductSummaryAttachmentList/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/ProductSummaryAttachmentList/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/ProductSummaryAttachmentList/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/ProductSummaryAttachmentList/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/ProductSummaryAttachmentList/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/ProductSummaryAttachmentList/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/ProductSummaryAttachmentList/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/ProductSummaryAttachmentList/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/ProductSummaryAttachmentList/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/ProductSummaryAttachmentList/docs/vtex-io-apps)\n\nProduct Summary Attachment List\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\nProduct Summary Attachment is the block exported by the [Product Summary app](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/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/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization) guide.\n\n| CSS Handles |\n| ------------------------- |\n| attachmentListContainer |\n| attachmentItemContainer |\n| attachmentItem |\n| attachmentItemProductText |\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/ProductSummaryAttachmentList/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[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList%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_9eb85d5c
|
[
{
"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 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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/SKUSelector/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/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/SKUSelector/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/SKUSelector/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/SKUSelector/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/SKUSelector/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/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/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@3.178.5/SKUSelector/docs/apps/vtex.store-components@3.178.5/SKUSelector%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/apps/vtex.store-components@3.178.5/SKUSelector%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/apps/vtex.store-components@3.178.5/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_544d7f01
|
[
{
"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 an app in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n[Installing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-installing-an-app)\n\n[Listing an account’s apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-listing-an-accounts-apps)\n\n[Linking an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-linking-an-app)\n\n[Deprecating an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-deprecating-an-app)\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-installing-an-app/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/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-installing-an-app/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n[Installing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-installing-an-app)\n\n[Listing an account’s apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-listing-an-accounts-apps)\n\n[Linking an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-linking-an-app)\n\n[Deprecating an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-deprecating-an-app)\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-installing-an-app/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/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-installing-an-app/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/app-development)\n\nManaging apps\n\n[Installing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-installing-an-app)\n\nInstalling an app\n\nIn the VTEX IO platform, all code configuration is bundled in what we call _apps_.\n\nTherefore, when using the VTEX Store Framework, you will need to install several applications to your VTEX account in order to properly build the desired storefront.\n\nIn addition to that, if you are developing a new project, installing an app is a fundamental step for testing the reliability of your new code settings. Once your app is already [published](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app), you are able to install it in any workspace you may be working on.\n\n> Remember the following: private apps (apps without the `billingOptions` field in its `manifest.json` file) can only be installed in the VTEX account where it was published. Public apps with free `billingOptions` can be installed in any VTEX account by any admin user. Lastly, public apps with billable `billingOptions` can only be installed by admin users with the License Manager's `BuyApp` permission. Once this installation takes place, the app will be charged by the end of every month in the accounts that installed it.\n\n## Instructions\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), make sure you are logged into the desired account and using the desired workspace.\n2. Then, run one of the following commands according to your needs and scenario:\n* `vtex install {appVendor}.{appName}` or `vtex install {appVendor}.{appName}@x` \\- To install the **latest stable version** of the app;\n* `vtex install {appVendor}.{appName}@{appVersion}` \\- To install a **specific version** of the app;\n* `vtex install {appVendor}.{appName}@ˆ{appVersion}` \\- To install any available version from the `{appVersion}` onwards.\n\nWhen specifying the `{appVersion}`, bear in mind the permitted structures:\n\n* `@8.0.10`\n* `@8.0.10-beta.3`\n* `@8.x`\n* `@^8.0.10`\n* `@^8.0.10-beta.1`\n\n> VTEX IO CLI only interprets installation commands with ranges by majors. This means minors and patches can only be specified in scenarios where one of the structures stated above is being used. App versions as `@8.0.x` or `@8.2` are no longer allowed.\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/configuring-workspaces/vtex-io-documentation-installing-an-app.md)\n\n[Best practices on workspaces management« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app//docs/guides/vtex-io-documentation-workspaces-best-practices)[Listing an account’s appsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app//docs/guides/vtex-io-documentation-listing-an-accounts-apps)\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-installing-an-app/docs/guides/vtex-io-documentation-installing-an-app%23instructions)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/configuring-workspaces/vtex-io-documentation-installing-an-app.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-installing-an-app/docs/guides/vtex-io-documentation-installing-an-app%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_c31cc923
|
[
{
"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 clear orderform message field from 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/clear-orderform-message-field-from-cart/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-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/clear-orderform-message-field-from-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/clear-orderform-message-field-from-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/clear-orderform-message-field-from-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/clear-orderform-message-field-from-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/clear-orderform-message-field-from-cart/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-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/clear-orderform-message-field-from-cart/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-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/clear-orderform-message-field-from-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/clear-orderform-message-field-from-cart/docs/guides/configuration-section-api-quick-start-guides)\n\n[Getting an account orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/get-an-account-orderform-configuration)\n\n[Updating an account orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/update-an-account-orderform-configuration)\n\n[Get and update the seller exchange window](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/get-and-update-the-seller-exchange-window)\n\n[Clear orderForm message field from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/clear-orderform-message-field-from-cart)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-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/clear-orderform-message-field-from-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/clear-orderform-message-field-from-cart/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-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/clear-orderform-message-field-from-cart/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-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/clear-orderform-message-field-from-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/clear-orderform-message-field-from-cart/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-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/clear-orderform-message-field-from-cart/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-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/clear-orderform-message-field-from-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/clear-orderform-message-field-from-cart/docs/guides/configuration-section-api-quick-start-guides)\n\n[Getting an account orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/get-an-account-orderform-configuration)\n\n[Updating an account orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/update-an-account-orderform-configuration)\n\n[Get and update the seller exchange window](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/get-and-update-the-seller-exchange-window)\n\n[Clear orderForm message field from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/clear-orderform-message-field-from-cart)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-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/clear-orderform-message-field-from-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/clear-orderform-message-field-from-cart/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-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/clear-orderform-message-field-from-cart/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-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/clear-orderform-message-field-from-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/clear-orderform-message-field-from-cart/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/checkout-api-overview)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/configuration-section-api-quick-start-guides)\n\n[Clear orderForm message field from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/clear-orderform-message-field-from-cart)\n\nClearing the orderForm message field from the cart\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. It stores a lot of contextual information about the order, which is essential for processing order information, such as order items, customer personal information, delivery address, and shipping information.\n\nThis guide will describe how to remove all messages from the `messages` field of the orderForm, leaving it empty.\n\n## Removing all messages from the orderForm message field\n\nTo remove all messages from the orderForm `messages` field of the shopping cart, you need to use the [Clear orderForm messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForm/-orderFormId-/messages/clear) endpoint. The `orderFormId` information of the shopping cart must be sent through the URL request, as in the example below:\n\n`https://{accountname}.{environment.com.br}/api/checkout/pub/orderForm/ede846222cd44046ba6c638442c3505a/messages/clear`\n\nAdditionally, you need to send the request body containing only two curly brackets, as shown below:\n\n`1\n\n{} \n\n`\n\nAfter sending the request, the endpoint will return the response body containing the shopping cart information and the `messages` field will empty, as in the example below:\n\n`1\n\n \n2\n\n\"messages\": [], \n\n`\n\n> For more information about the meaning of each field available in the shopping cart, please refer to 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 messages in the response body:\n\n### 400 - Bad Request\n\n* **Message error example (code 001)**: `\"Bad Request\"`. This message indicates that information other than `{}` was sent in the request body.\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\": \"Bad request\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"91b68251-1a60-4716-b846-c7c9c31fa565\" \n\n9\n\n} \n\n`\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\": \"5d37a185-bfe6-4686-9d92-aac9482cc63d\" \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\n4\n\n[](https://github.com/GeorgeLimaDev)\n\n[](https://github.com/karenkrieger)\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/configuration-section-api-quick-start-guides/clear-orderform-message-field-from-cart.md)\n\n[Get and update the seller exchange window« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart//docs/guides/get-and-update-the-seller-exchange-window)[FulfillmentNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart//docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\nContributors\n\n4\n\n[](https://github.com/GeorgeLimaDev)\n\n[](https://github.com/karenkrieger)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/ricardoaerobr)\n\nON THIS PAGE\n\n[Removing all messages from the orderForm message field](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/clear-orderform-message-field-from-cart%23removing-all-messages-from-the-orderform-message-field)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/clear-orderform-message-field-from-cart%23error-codes)\n\n[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/clear-orderform-message-field-from-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/clear-orderform-message-field-from-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/configuration-section-api-quick-start-guides/clear-orderform-message-field-from-cart.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Removing all messages from the orderForm message field](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/clear-orderform-message-field-from-cart%23removing-all-messages-from-the-orderform-message-field)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/clear-orderform-message-field-from-cart%23error-codes)\n\n[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/clear-orderform-message-field-from-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/clear-orderform-message-field-from-cart/docs/guides/clear-orderform-message-field-from-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_2d36a782
|
[
{
"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 control to disable the canonical tag in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/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/control-to-disable-the-canonical-tag/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/control-to-disable-the-canonical-tag/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/control-to-disable-the-canonical-tag/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/control-to-disable-the-canonical-tag/docs/guides/setting-up-the-zoom)\n\n[Creating gift lists](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/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/control-to-disable-the-canonical-tag/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/control-to-disable-the-canonical-tag/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/control-to-disable-the-canonical-tag/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/control-to-disable-the-canonical-tag/docs/guides/configure-the-price-history-control)\n\n[Shelf template controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/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/control-to-disable-the-canonical-tag/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/control-to-disable-the-canonical-tag/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/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/control-to-disable-the-canonical-tag/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/control-to-disable-the-canonical-tag/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/control-to-disable-the-canonical-tag/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/control-to-disable-the-canonical-tag/docs/guides/setting-up-the-zoom)\n\n[Creating gift lists](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/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/control-to-disable-the-canonical-tag/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/control-to-disable-the-canonical-tag/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/control-to-disable-the-canonical-tag/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/control-to-disable-the-canonical-tag/docs/guides/configure-the-price-history-control)\n\n[Shelf template controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/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/control-to-disable-the-canonical-tag/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/control-to-disable-the-canonical-tag/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/storefront-development)\n\n(Legacy) CMS Portal\n\n[Control to disable the canonical tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/control-to-disable-the-canonical-tag)\n\nControl to disable the canonical tag\n\n## What is the canonical tag\n\nWhen using the meta tags control, explained in the article [How to use the meta tags control](how-to-use-the-meta-tags-control), one of the tags inserted in the head of the page is the **canonical tag**:\n\n`<link rel=\"canonical\" href=\"http://{AccountName}.com.br/{page}\">`\n\nThe canonical tag allows you to avoid **duplicate content**, that is, scenarios where two pages of the site display identical or almost identical content. An example are the following three URLs:\n\n* {AccountName}.com\n* {AccountName}.com.br\n* {AccountName}.com/\n\nAll of the above URLs display the same content, but for search engines, simply adding a forward slash to the end of the address may characterize a different page, which is bad for **SEO** purposes.\n\nTo avoid scenarios like that, the canonical tag informs search engines what is the preferred version of a web page.\n\nSo a search engine can decide whether two pages have duplicate content and, if it decides they do, transfer the indexing merits to the preferred version.\n\n## Disabling the canonical tag for a page\n\nWhile the canonical tag is useful for SEO purposes, you may not want to use it for specific pages.\n\nBecause it's inserted automatically by the meta tag control, if you are using this control, you must inform the system that it should exclude only the canonical tag. This is done through the following control:\n\n`<vtex.cmc:canonicalPage disable=\"true\"/>`\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/control-to-disable-the-canonical-tag.md)\n\n[Shelf template controls« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag//docs/guides/shelf-template-controls)[Storefront best practicesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag//docs/guides/storefront-best-practices)\n\nContributors\n\n1\n\n[](https://github.com/jumeyermattosarruda)\n\nON THIS PAGE\n\n[What is the canonical tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/control-to-disable-the-canonical-tag%23what-is-the-canonical-tag)\n\n[Disabling the canonical tag for a page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/control-to-disable-the-canonical-tag%23disabling-the-canonical-tag-for-a-page)\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/control-to-disable-the-canonical-tag.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[What is the canonical tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/control-to-disable-the-canonical-tag%23what-is-the-canonical-tag)\n\n[Disabling the canonical tag for a page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/control-to-disable-the-canonical-tag/docs/guides/control-to-disable-the-canonical-tag%23disabling-the-canonical-tag-for-a-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_22468fcf
|
[
{
"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 specification 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.product-specification-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.product-specification-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.product-specification-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.product-specification-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.product-specification-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.product-specification-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.product-specification-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.product-specification-badges/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtexventures.livestreaming)\n\n[PayPal Checkout with Smart Payment Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.product-gifts)\n\n[Product Highlight by VTEX Segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtexarg.product-highlight-by-vtex-segment)\n\n[Product Specification Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.reviews-and-ratings)\n\n[Querying personal MasterData Information with SafeData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.shipping-option-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-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.product-specification-badges/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-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.product-specification-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.product-specification-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.product-specification-badges/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-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.product-specification-badges/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtexventures.livestreaming)\n\n[PayPal Checkout with Smart Payment Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.product-gifts)\n\n[Product Highlight by VTEX Segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtexarg.product-highlight-by-vtex-segment)\n\n[Product Specification Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.reviews-and-ratings)\n\n[Querying personal MasterData Information with SafeData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.shipping-option-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-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.product-specification-badges/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-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.product-specification-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.product-specification-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.product-specification-badges/docs/vtex-io-apps)\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/guides/advanced-components)\n\nVTEX Product Specification Badges\n\nOfficial extension\n\nVersion: 0.4.1\n\nLatest version: 0.4.1\n\n[](#contributors-)\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| blockClass | string | Allows to pass a custom name to be added to component css classes | null |\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| multipleValuesSeparator | string | Define the separator string to be rendered when a specification value has multiple values. | / |\n| orientation | vertical or horizontal | Determines if the group of specifications are showed horizontally or vertically | vertical |\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| 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| 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\n`Option` type:\n\n| Prop name | Type | Description | Default value |\n| ----------------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\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| 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\n**Important note:**\n\nAll 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` 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### CSS API\n\n| CSS class | Description |\n| -------------- | ------------------------------------------- |\n| groupContainer | Container that wrapps the whole badge group |\n| badgeContainer | Container for each badge |\n| badgeText | Text displayed inside badge |\n\nNote: each badge receives a class `badgeContainer` with its specification name slug appended to it. Example: with the specification `On Sale: true` the badge will also have the class `badgeContainer--on-sale`.\n\nNote: each badge receives a class `badgeText` with its specification value slug appended to it. Example: with the specification `Nationality: Brazilian` the badge will also have the class `badgeText--brazilian`.\n\n[Product Highlight by VTEX Segment« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtexarg.product-highlight-by-vtex-segment)[Quantity On CartNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtexarg.quantity-on-cart)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.product-specification-badges%23configuration)\n\n[Example 1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.product-specification-badges%23example-1)[Example 2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.product-specification-badges%23example-2)[Example 3](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.product-specification-badges%23example-3)[Example 4](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.product-specification-badges%23example-4)[Usage tip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.product-specification-badges%23usage-tip)[CSS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-specification-badges/docs/apps/vtex.product-specification-badges%23css-api)\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_21388bfc
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides managing skus in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/updates/release-notes)\n\nManaging SKUs\n\nLearn how to create, update, and activate an SKU with the Catalog API.\n\nThis step-by-step guide will walk you through the process of creating, updating, and activating a [Stock Keeping Unit (SKU)](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/3mJbIqMlz6oKDmyZ2bKJoA%23) within the VTEX platform. An SKU represents a specific item in the inventory that customers can purchase, essentially serving as a unique product variation, such as a \"long sleeve gray size S shirt.\"\n\n## Before you begin\n\nBefore you begin managing your SKUs, make sure you've completed the following steps:\n\n* **Create a Product**: Your SKUs should be associated with an existing product. If you haven't created a product yet, refer to the [Product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/products) for more information.\n* **Obtain API Credentials**: Ensure you have a valid `appKey` and `appToken` with the necessary permissions to access the [Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api). For more information, please refer to the [Roles](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) article.\n\n> Click the steps below to navigate through this article and explore specific topics. Relevant code will be highlighted and focused for your convenience. Additionally, in the code viewer on the right, you can switch between different code files or tabs to view the corresponding code examples.\n\n## Creating an SKU\n\nSend a request to the [Create SKU endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit) to create a new SKU, considering the following points when building the request body:\n\n* `IsActive`: Ensure that `IsActive` is set to `false`. Activating it during creation will result in a `400 Bad Request` error.\n* `ActivateIfPossible`: It's recommended to set `ActivateIfPossible` as `true,` unless you plan to have an internal workflow to [manually activate SKUs](#manual-activation).\n* **Alternate IDs**: Provide at least one of the following IDs in the request body: `RefId` or `EAN`. You can also provide both if necessary.\n\nWhen sending the request body, you can specify the desired SKU `Id` or let VTEX automatically generate it, as presented in the following.\n\n### Custom `Id`: Request body\n\nIf there is a need to create a new SKU with a specific custom `Id`, specify the `Id` (`integer`) in the request body.\n\n### Automatically generated ID: Request body\n\nIf there's no need to specify a custom `Id`, you can omit it from the request body, and VTEX will automatically generate the `Id`.\n\n## Updating an SKU\n\nAfter successfully creating an SKU, you can update its details by sending a request to the [Update SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/stockkeepingunit/-skuId-) endpoint. To update an SKU, provide the SKU's unique `skuId` in the URL and include the updated information in the request body.\n\n## Activating an SKU\n\nActivating an SKU means making it available for purchase in your store, allowing customers to browse, search, and buy the associated product. To be activated, ensure your SKU meets the following requirements:\n\n* **Alternate IDs**: The SKU must have at least one of the following alternate IDs configured: `RefId` or `EAN`.\n* **Image**: The SKU must have at least one image associated with it. Use the [Create SKU file endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit/-skuId-/file) to associate an image to an SKU.\n* **Specifications**: If the SKU has [specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications), they must be filled in.\n* **Kit**: For [kit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/stockkeepingunitkit) SKUs, at least one component must be active.\n* **Product**: The SKU must be associated with an active product, which, in turn, must be related to an active [Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands) and an active [Category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories).\n\nOnce the SKU meets these requirements, you can activate it using one of the following methods: [automatic](#automatic-activation) or [manual](#manual-activation).\n\n### Automatic activation\n\nIf your SKU's `IsActive` is set to `false` and `ActivateIfPossible` is set to `true`, your SKU will automatically become active as soon as it is associated with an image or an active component.\n\nHere's an overview of the necessary steps to implement automatic SKU activation:\n\n1. [Create the SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit), setting `IsActive` as `false` and `ActivateIfPossible` as `true`.\n2. If the SKU is a kit, [create and associate SKU components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunitkit).\n3. [Create and associate SKU files](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit/-skuId-/file).\n\n### Manual activation\n\nIf your SKU's `IsActive` is set to `false` and `ActivateIfPossible` is set to `false`, send a request to the [Update the SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/stockkeepingunit/-skuId-) endpoint, setting `IsActive` as `true`.\n\nHere's an overview of the necessary steps to implement manual SKU activation:\n\n1. [Create the SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit), setting `IsActive` as `false` and `ActivateIfPossible` as `false`.\n2. If the SKU is a kit, [create and associate SKU components](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-post-sku-kit).\n3. [Create and associate SKU files](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit/-skuId-/file).\n4. [Update the SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/stockkeepingunit/-skuId-) as active, setting `IsActive` as `true`.\n\nShell\n\nPython\n\nNode.js\n\n`1\n\ncurl --request post \\ \n\n2\n\n --url https://{accountName}.vtexcommercestable.com.br/api/catalog/pvt/stockkeepingunit \\ \n\n3\n\n --header 'Accept: application/json' \\ \n\n4\n\n --header 'Content-Type: application/json' \\ \n\n5\n\n --header 'X-VTEX-API-AppKey: {appKey}' \\ \n\n6\n\n --header 'X-VTEX-API-AppToken: {appToken}' \\ \n\n7\n\n --data '{body}' \n\n`\n\nBody\n\nResponse\n\n`1\n\n{ \n\n2\n\n \"Id\": 1, \n\n3\n\n \"ProductId\": 310117069, \n\n4\n\n \"IsActive\": false, \n\n5\n\n \"ActivateIfPossible\": true, \n\n6\n\n \"Name\": \"sku test\", \n\n7\n\n \"RefId\": \"125478\", \n\n8\n\n \"Ean\": \"8949461894984\", \n\n9\n\n \"PackagedHeight\": 10, \n\n10\n\n \"PackagedLength\": 10, \n\n11\n\n \"PackagedWidth\": 10, \n\n12\n\n \"PackagedWeightKg\": 10, \n\n13\n\n \"Height\": null, \n\n14\n\n \"Length\": null, \n\n15\n\n \"Width\": null, \n\n16\n\n \"WeightKg\": null, \n\n17\n\n \"CubicWeight\": 0.1667, \n\n18\n\n \"IsKit\": false, \n\n19\n\n \"CreationDate\": null, \n\n20\n\n \"RewardValue\": null, \n\n21\n\n \"EstimatedDateArrival\": null, \n\n22\n\n \"ManufacturerCode\": \"123\", \n\n23\n\n \"CommercialConditionId\": 1, \n\n24\n\n \"MeasurementUnit\": \"un\", \n\n25\n\n \"UnitMultiplier\": 2.0, \n\n26\n\n \"ModalType\": null, \n\n27\n\n \"KitItensSellApart\": false, \n\n28\n\n \"Videos\": [\"https://www.youtube.com/\"] \n\n29\n\n} \n\n`\n\n> Note that additional configurations are necessary for a product and its SKUs to become visible in a store:\n> \n> * Register a price for the SKU in the associated trade policy (sales channel). Refer to the [Pricing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pricing-overview) guide for more information.\n> * Ensure you have at least one unit in stock. Manage your inventory by following the [Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment) guide.\n> * Configure your storefront to display products correctly.\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/Catalog/managing-skus.mdx)\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/managing-skus/docs/guides/managing-skus%23before-you-begin)\n\n[Creating an SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/guides/managing-skus%23creating-an-sku)\n\n[Custom Id: Request body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/guides/managing-skus%23custom-id-request-body)[Automatically generated ID: Request body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/guides/managing-skus%23automatically-generated-id-request-body)\n\n[Updating an SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/guides/managing-skus%23updating-an-sku)\n\n[Activating an SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/guides/managing-skus%23activating-an-sku)\n\n[Automatic activation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/guides/managing-skus%23automatic-activation)[Manual activation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/guides/managing-skus%23manual-activation)\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/Catalog/managing-skus.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/managing-skus/docs/guides/managing-skus%23before-you-begin)\n\n[Creating an SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/guides/managing-skus%23creating-an-sku)\n\n[Custom Id: Request body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/guides/managing-skus%23custom-id-request-body)[Automatically generated ID: Request body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/guides/managing-skus%23automatically-generated-id-request-body)\n\n[Updating an SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/guides/managing-skus%23updating-an-sku)\n\n[Activating an SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/guides/managing-skus%23activating-an-sku)\n\n[Automatic activation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/guides/managing-skus%23automatic-activation)[Manual activation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus/docs/guides/managing-skus%23manual-activation)\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_6208ee7a
|
[
{
"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 condition layout 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-condition-layout/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-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/guides/vtex-condition-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/guides/vtex-condition-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/guides/vtex-condition-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/guides/vtex-condition-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/guides/vtex-condition-layout/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/guides/layout-apps)\n\n[Condition Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/apps/vtex.condition-layout)\n\n[Disclosure Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/apps/vtex.disclosure-layout)\n\n[Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/apps/vtex.flex-layout)\n\n[Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/apps/vtex.modal-layout)\n\n[Overlay Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/apps/vtex.overlay-layout)\n\n[Responsive Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/apps/vtex.responsive-layout)\n\n[Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/apps/vtex.slider-layout)\n\n[Stack Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/apps/vtex.stack-layout)\n\n[Sticky Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/apps/vtex.sticky-layout)\n\n[Tab Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/apps/vtex.tab-layout)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/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-condition-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/guides/vtex-condition-layout/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/guides/layout-apps)\n\n[Condition Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/apps/vtex.condition-layout)\n\n[Disclosure Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/apps/vtex.disclosure-layout)\n\n[Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/apps/vtex.flex-layout)\n\n[Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/apps/vtex.modal-layout)\n\n[Overlay Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/apps/vtex.overlay-layout)\n\n[Responsive Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/apps/vtex.responsive-layout)\n\n[Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/apps/vtex.slider-layout)\n\n[Stack Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/apps/vtex.stack-layout)\n\n[Sticky Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/apps/vtex.sticky-layout)\n\n[Tab Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/apps/vtex.tab-layout)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/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-condition-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/guides/vtex-condition-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/guides/vtex-condition-layout/docs/vtex-io-apps)\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/guides/layout-apps)\n\nCondition Layout\n\nOfficial extension\n\nVersion: 2.8.2\n\nLatest version: 2.8.2\n\n[](#contributors-)\n\nThe Condition Layout app renders a component in your store when predefined conditions are met.\n\n\n\n## Configuration\n\n### Step 1 - Adding the Condition Layout app to your theme dependencies\n\nIn the `manifest.json` file of your theme, add the Condition Layout app as a dependency:\n\n`1\n\n \"dependencies\": { \n\n2\n\n+ \"vtex.condition-layout\": \"2.x\" \n\n3\n\n } \n\n`\n\nYou can now use all blocks exported by the `condition-layout` app. See the full list below:\n\n| Block name | Description |\n| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| condition-layout.product | Defines the condition logic in the product context and the children blocks that will be rendered when the predefined conditions are met. |\n| condition-layout.binding | Defines the condition logic in the current binding and the children blocks that will be rendered when the predefined conditions are met. |\n| condition-layout.category | Defines the condition logic on the current category or department page and the children blocks that will be rendered when the predefined conditions are met. |\n| condition-layout.telemarketing | Defines the condition logic in the user role (telemarketing) and the children blocks that will be rendered when the predefined conditions are met. |\n\n### Step 2 - Adding the `condition-layout.product` block to your theme templates\n\nIn the product theme template, add the `condition-layout.product` block as a child. For example:\n\n`1\n\n{ \n\n2\n\n \"store.product\": { \n\n3\n\n \"children\": [\"condition-layout.product\"] \n\n4\n\n }, \n\n`\n\nOr the `condition-layout.binding` block. For example:\n\n`1\n\n{ \n\n2\n\n \"store.product\": { \n\n3\n\n \"children\": [\"condition-layout.binding\"] \n\n4\n\n } \n\n5\n\n} \n\n`\n\nOr the `condition-layout.category` block. For example:\n\n`1\n\n{ \n\n2\n\n \"store.search#my-category-page\": { \n\n3\n\n \"children\": [\"condition-layout.category\"] \n\n4\n\n } \n\n5\n\n} \n\n`\n\n> Never use `condition-layout` directly. Always use it with a context variant, such as `condition-layout.product`.\n\n### Step 3 - Defining the desired conditions\n\nNow it is time to configure the `condition-layout.product` block!\n\n**Use the block props to define your layout condition**. You can also declare blocks of your choice as children of `condition-layout.product`. These children blocks will be rendered if the condition is met.\n\nFor example:\n\n`1\n\n{ \n\n2\n\n \"store.product\": { \n\n3\n\n \"children\": [\"condition-layout.product#cond1\"] \n\n4\n\n }, \n\n5\n\n \"condition-layout.product#cond1\": { \n\n6\n\n+ \"props\": { \n\n7\n\n+ \"conditions\": [ \n\n8\n\n+ { \n\n9\n\n+ \"subject\": \"productId\", \n\n10\n\n+ \"arguments\": { \n\n11\n\n+ \"id\": \"12\" \n\n12\n\n+ } \n\n13\n\n+ } \n\n14\n\n+ ] \n\n15\n\n+ \"Then\": \"flex-layout.row#custom-pdp-layout-12\", \n\n16\n\n+ \"Else\": \"flex-layout.row#default\" \n\n17\n\n+ } \n\n18\n\n+ } \n\n`\n\nOr for `condition-layout.binding`:\n\n`1\n\n{ \n\n2\n\n \"store.product\": { \n\n3\n\n \"children\": [\"condition-layout.binding#cond42\"] \n\n4\n\n }, \n\n5\n\n \"condition-layout.binding#cond42\": { \n\n6\n\n+ \"props\": { \n\n7\n\n+ \"conditions\": [ \n\n8\n\n+ { \n\n9\n\n+ \"subject\": \"bindingId\", \n\n10\n\n+ \"arguments\": { \n\n11\n\n+ \"id\": \"13fb71d0-binding-code-here-87h9c28h9013\" \n\n12\n\n+ } \n\n13\n\n+ } \n\n14\n\n+ ] \n\n15\n\n+ \"Then\": \"flex-layout.row#just-for-this-binding\", \n\n16\n\n+ \"Else\": \"flex-layout.row#for-other-bindings\" \n\n17\n\n+ } \n\n18\n\n+ } \n\n`\n\nOr for `condition-layout.category`:\n\n`1\n\n{ \n\n2\n\n \"store.product\": { \n\n3\n\n \"children\": [\"condition-layout.category#cond42\"] \n\n4\n\n }, \n\n5\n\n \"condition-layout.category#cond42\": { \n\n6\n\n+ \"props\": { \n\n7\n\n+ \"conditions\": [ \n\n8\n\n+ { \n\n9\n\n+ \"subject\": \"department\", \n\n10\n\n+ \"arguments\": { \n\n11\n\n+ \"ids\": [\"1\", \"42\"] \n\n12\n\n+ } \n\n13\n\n+ } \n\n14\n\n+ { \n\n15\n\n+ \"subject\": \"category\", \n\n16\n\n+ \"arguments\": { \n\n17\n\n+ \"ids\": [\"301\", \"304\"] \n\n18\n\n+ } \n\n19\n\n+ } \n\n20\n\n+ ] \n\n21\n\n+ \"matchType\": \"any\", \n\n22\n\n+ \"Then\": \"flex-layout.row#just-for-this-category-or-department\", \n\n23\n\n+ \"Else\": \"flex-layout.row#for-other-category-or-department\" \n\n24\n\n+ } \n\n25\n\n+ } \n\n`\n\nOr for `condition-layout.telemarketing`:\n\n`1\n\n{ \n\n2\n\n \"store.product\": { \n\n3\n\n \"children\": [\"condition-layout.telemarketing#show-block\"] \n\n4\n\n }, \n\n5\n\n \"condition-layout.telemarketing#show-block\": { \n\n6\n\n+ \"props\": { \n\n7\n\n+ \"conditions\": [ \n\n8\n\n+ { \n\n9\n\n+ \"subject\": \"impersonable\", \n\n10\n\n+ \"arguments\": { \n\n11\n\n+ \"value\": true \n\n12\n\n+ } \n\n13\n\n+ } \n\n14\n\n+ ] \n\n15\n\n+ \"Then\": \"flex-layout.row#just-for-telemarketers\", \n\n16\n\n+ \"Else\": \"flex-layout.row#for-other-user-roles\" \n\n17\n\n+ } \n\n18\n\n+ } \n\n`\n\n> In the example above, whenever users interact with a product whose ID is equal to 12, the `flex-layout.row#custom-pdp-layout-12` block is rendered. If users interact with a product whose ID is not equal to 12, the rendered block is `flex-layout.row#default`.\n\n| Prop name | Type | Description | Default value |\n| ---------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| conditions | object | List of desired conditions. | undefined |\n| matchType | enum | Layout rendering criteria. Possible values are: all (all conditions must be met to render the layout), any (at least one of the conditions must be met to render the layout), or none (no conditions must be met to render the layout). | all |\n| Then | block | Name of the block to be rendered if the conditions are met. If no value is defined, the blocks declared as children of condition-layout.product will be rendered instead. | undefined |\n| Else | block | Name of the block to be rendered if the conditions are not met. | undefined |\n\n* **`conditions` object:**\n\n| Prop name | Type | Description | Default value |\n| --------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| subject | string | Defines, based on the product context where the block is declared, which information is needed from the UI to validate the value chosen in the object prop. See below the possible values for this prop. | undefined |\n| arguments | object | Defines the condition parameters. Note that the value of this prop varies depending on the value set for the subject prop. See below the table with the possible values for the subject prop and their expected arguments. | undefined |\n| toBe | boolean | Determines whether the data fetched in the subject prop must meet the predefined conditions to render the new layout (true) or not (false). | true |\n\nPossible values for `subject` prop of the `condition-layout.product` block:\n\n| Subject | Description | Arguments |\n| ------------------------ | ------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| productId | Product IDs currently displayed on the UI. | { id: string } |\n| categoryId | Category IDs currently displayed on the UI. | { id: string } |\n| brandId | Brand IDs currently displayed on the UI. | { id: string } |\n| selectedItemId | ID of the item currently selected by the user. | { id: string } |\n| productClusters | List of product clusters currently displayed on the UI. | { id: string } |\n| categoryTree | List of categories currently displayed on the UI. **Note:** Only available on the Product Detail Page. | { id: string } |\n| specificationProperties | List of product specifications currently displayed on the UI. | { name: string, value: string }. Note: value is an optional prop. If omitted, only the specification name (name) will be checked. |\n| areAllVariationsSelected | Determines whether all product variations currently available on the UI were selected by the user (true) or not (false). | No arguments are expected. |\n| isProductAvailable | Determines whether the product is available (true) or not (false). | No arguments are expected. |\n| hasMoreSellersThan | Determines whether the number of sellers for a product is greater than the argument passed. | { quantity: number } |\n| hasBestPrice | Whether the product is being given a discount on its list price. | { value: boolean } or no arguments. |\n| sellerId | Whether any of the sellers of the product are included in the list of IDs passed. | { ids: string\\[\\] } |\n\nPossible values for the `subject` prop of the `condition-layout.binding` block:\n\n| Subject | Description | Arguments |\n| --------- | -------------------------------- | -------------- |\n| bindingId | ID of the desired store binding. | { id: string } |\n\nPossible values for the `subject` prop of the `condition-layout.category` block:\n\n| Subject | Description | Arguments |\n| ---------- | --------------------------------------------- | ------------------- |\n| category | Category IDs currently displayed on the UI. | { ids: string\\[\\] } |\n| department | Department IDs currently displayed on the UI. | { ids: string\\[\\] } |\n\nPossible values for the `subject` prop of the `condition-layout.telemarketing` block:\n\n| Subject | Description | Arguments |\n| ------------ | ----------------------------------- | ------------------ |\n| impersonable | Value of the impersonation setting. | { value: boolean } |\n\n## App behavior\n\nThe `condition-layout.product` block mainly uses the `matchType` and `conditions` props to respectively set the criteria and the conditions that blocks must meet to be rendered.\n\nThe `conditions` prop does not rely on any automatic grammar to define the desired conditions. Instead, it relies on its two props, namely `subject` and `arguments`, which together define which condition must be met by using an underlying data validation method (with specific arguments) based on the UI behavior.\n\nLastly, the `matchType` prop decides the necessary number of valid conditions for the layout rendering.\n\n## Customization\n\nThe Condition Layout merely establishes a logic to render other blocks. Therefore, the app does not have its own CSS handles for customization.\n\nInstead, you should use the handles of the child blocks.\n\n[Layout Apps« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/guides/layout-apps)[Disclosure LayoutNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/apps/vtex.disclosure-layout)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)[V1 DOCVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/apps/vtex.condition-layout@2.8.2/v1-DOC)[MIGRATION GUIDEVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/apps/vtex.condition-layout%23configuration)\n\n[Step 1 - Adding the Condition Layout app to your theme dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/apps/vtex.condition-layout%23step-1-adding-the-condition-layout-app-to-your-theme-dependencies)[Step 2 - Adding the condition-layout.product block to your theme templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/apps/vtex.condition-layout%23step-2-adding-the-condition-layoutproduct-block-to-your-theme-templates)[Step 3 - Defining the desired conditions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/apps/vtex.condition-layout%23step-3-defining-the-desired-conditions)\n\n[App behavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/apps/vtex.condition-layout%23app-behavior)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout/docs/apps/vtex.condition-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_4d0752fc
|
[
{
"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 apps in live stores best practices in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/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-installing-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/docs/guides/store-framework-updating-live-stores)\n\n[Migrating CMS settings after a Store Theme major update](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update)\n\n[Installing apps on live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices)\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-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/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-installing-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/docs/guides/store-framework-updating-live-stores)\n\n[Migrating CMS settings after a Store Theme major update](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update)\n\n[Installing apps on live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices)\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-apps-in-live-stores-best-practices/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-apps-in-live-stores-best-practices/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices/docs/guides/store-framework)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices/docs/guides/store-framework-updating-live-stores)\n\n[Installing apps on live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices)\n\nInstalling apps on live stores\n\nManaging a live store comes with its own set of challenges, particularly concerning security, stability, and performance. Making changes, such as installing new apps, can feel risky if their potential impact isn't well understood. However, by following established best practices, you can minimize risks and maintain smooth operations, protecting your store's stability and conversion rates.\n\nCombining manual testing in [development workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace) with [A/B testing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ab-tests) is a highly effective strategy. These steps allow you to identify and address potential issues before implementing changes for all users.\n\n## Instructions\n\n### Step 1 - Performing manual tests in a Development Workspace\n\n1. [Install](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app) the app in a development workspace.\n2. [Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app) your local files to the development workspace with VTEX IO.\n3. Access the store via the development workspace URL: `{developmentWorkspaceName}--{accountName}.myvtex.com`.\n4. Navigate the store and perform manual tests to ensure the app behaves as expected. Look for any functionality issues or unintended side effects.\n5. Visit the master workspace (`{accountName}.myvtex.com`) to identify any unexpected changes introduced by the app.\n6. If all tests pass, install the app in a [production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace);\n\n### Step 2 - Running A/B tests\n\nSet up an [A/B test](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing) between the master workspace and the production workspace. During configuration, manually set traffic distribution for each workspace, directing a small percentage of users to the Production workspace.\n\n> Avoid relying on automatic traffic segmentation, which splits traffic 50/50, as it exposes a larger audience to potential issues.\n\n### Step 3 - Promoting your changes\n\n1. If your changes involve a new major version of the Store Theme, refer to the [Migrating CMS settings after a major theme update](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update) guide to avoid losing Admin page template settings.\n2. Once validated, [promote the production workspace to master](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master), making the new configurations public for all your 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/Perks/best-practices/vtex-io-documentation-installing-apps-in-live-stores-best-practices.md)\n\n[Migrating CMS settings after a Store Theme major update« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices//docs/guides/vtex-io-documentation-migrating-cms-settings-after-major-update)[Migrating your storefront from Legacy CMS Portal to Store FrameworkNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices//docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io)\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-installing-apps-in-live-stores-best-practices/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices%23instructions)\n\n[Step 1 - Performing manual tests in a Development Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices%23step-1-performing-manual-tests-in-a-development-workspace)[Step 2 - Running A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices%23step-2-running-ab-tests)[Step 3 - Promoting your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices%23step-3-promoting-your-changes)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Perks/best-practices/vtex-io-documentation-installing-apps-in-live-stores-best-practices.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-installing-apps-in-live-stores-best-practices/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices%23instructions)\n\n[Step 1 - Performing manual tests in a Development Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices%23step-1-performing-manual-tests-in-a-development-workspace)[Step 2 - Running A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices%23step-2-running-ab-tests)[Step 3 - Promoting your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices/docs/guides/vtex-io-documentation-installing-apps-in-live-stores-best-practices%23step-3-promoting-your-changes)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_34bf599b
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore headless cms widgets in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/headless-cms-overview)\n\n[Managing content with 'scopes' and 'requiredScopes'](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes)\n\n[Multiple page templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/headless-cms-multiple-page-template)\n\n[Previewing Headless CMS in development mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode)\n\n[Widgets for Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/headless-cms-widgets)\n\n[Customizing pages with Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/dynamic-content-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/headless-cms-overview)\n\n[Managing content with 'scopes' and 'requiredScopes'](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes)\n\n[Multiple page templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/headless-cms-multiple-page-template)\n\n[Previewing Headless CMS in development mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode)\n\n[Widgets for Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/headless-cms-widgets)\n\n[Customizing pages with Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/dynamic-content-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/headless-cms-overview)\n\nWidgets for Headless CMS\n\nWidgets are interface elements in the [Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview) that merchants can use to enhance store sections. These can include date pickers, dropdown menus, image uploaders, and more, helping editors create and edit content.\n\nIn this guide, you will find:\n\n* [Widgets available](#widgets-available): An overview of each widget and its function.\n* [Instructions on how to add a widget to a section](#adding-a-widget-to-a-store-section): A guide with instructions on incorporating a widget into a new store section.\n\n## Widgets available\n\nBelow is a brief description of the widgets that can be implemented and used in the Headless CMS interface in the VTEX Admin. For detailed information about each widget, click the respective widget name.\n\n| Widget name | Description |\n| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| [checkboxes](#checkboxes) | Displays checkboxes for selecting options in forms. |\n| [image-uploader](#image-uploader) | Uploads images from your local machine. |\n| [date-time](#date-time) | Provides a calendar popup for selecting a date and time. |\n| [draftjs-rich-text](#draftjs-rich-text) | Rich text editor for formatting and styling store text. |\n| [media-gallery](#media-gallery) | Uploads or selects existing images or videos from the [Media](https://read.calvincode.net/reader?url=https://vtexhelp.myvtex.com/tutorial/media-overview--31fhjHTt4TBoo50AmGQ9b2). |\n\n### `checkboxes`\n\nDisplays a checkbox commonly used in forms to select an option. The following image shows how the `checkboxes` are displayed within the headless CMS interface:\n\n\n\n### `image-uploader`\n\nDisplays a card to upload an image from your local machine. The following image shows how the `image-uploader` is displayed within the headless CMS interface:\n\n\n\n> The `image-uploader` is one of the available widgets. Still, we recommend using the [media gallery](#media-gallery) widget, which allows you to select and upload not only images but also videos from the [Media](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/media-overview--31fhjHTt4TBoo50AmGQ9b2) module.\n\n### `date-time`\n\nProvides a calendar popup for selecting a date and time. It is ideal for displaying deadlines, event times, or any scenario where you need to specify a specific date and time within your headless CMS content. For example, you can showcase a product's expiration date or display a time-limited coupon badge. The following image shows how the `date-time` is displayed within the headless CMS interface:\n\n\n\n### `draftjs-rich-text`\n\nDisplays an editor that allows formatting and styling the store text. The following image shows how the `draftjs-rich-text` is displayed within the headless CMS interface:\n\n\n\n### `media-gallery`\n\nDisplays a card to upload or select an existing image from the [Media](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/media-overview--31fhjHTt4TBoo50AmGQ9b2) module. The following image shows how the `media-gallery` is displayed within the headless CMS interface:\n\n> The difference between the [image-uploader](#image-uploader) and the `media-gallery` is that when you click the `media-gallery` property, you can select or upload an image or a video from the [Media](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/media-overview--31fhjHTt4TBoo50AmGQ9b2) module. The `image-uploader` on the other hand, only allows you to upload images from your machine.\n\n\n\n## Adding a widget to a store section\n\nWidgets are useful when you've [created a new store section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section) and want to add a new property to it. To illustrate how a widget can be used in a store section, here's an example using the [media-gallery](#media-gallery) widget in the new `Custom Newsletter` section, based on the [Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter) native section.\n\n> To create a new section, such as the `Custom Newsletter`, follow the instructions in the guide [Creating a new store section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section).\n\n1. Open your store project code in a code editor and navigate to the `cms/faststore` folder.\n2. Open the `sections.json` file.\n3. In the `sections.json` file, find the section where you want to add the widget. In the following `sections.json` file example, the new section, `Custom Newsletter`, receives the [media-gallery](#media-gallery) widget.\n1. Open the terminal and run `yarn cms-sync` to sync the new section with the Headless CMS. Once the changes are synced, you will see the following message: `info: CMS synced successfully...`.\n2. Go to the VTEX Admin and access **Storefront > Headless CMS**.\n3. Open the page where you want to add the new section. In this example, we will add the `Custom Newsletter` to `Home`.\n4. Add the section to the page, and you will notice the widget you added, the [media-gallery](#media-gallery). \n\n5. Click `Preview` to view the new component with the new image. \n\n\ncheckboxes\n\n`1\n\n\"activate\": { \n\n2\n\n \"title\": \"Activate Cupom\", \n\n3\n\n \"type\": \"boolean\", \n\n4\n\n \"default\": true, \n\n5\n\n \"widget\": { \n\n6\n\n \"ui:widget\": \"checkboxes\" \n\n7\n\n } \n\n8\n\n}, \n\n`\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/headless-cms/widgets.mdx)\n\n[Previewing Headless CMS in development mode« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode)[Customizing pages with Dynamic ContentNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/dynamic-content-overview)\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Widgets available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/headless-cms-widgets%23widgets-available)\n\n[checkboxes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/headless-cms-widgets%23checkboxes)[image-uploader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/headless-cms-widgets%23image-uploader)[date-time](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/headless-cms-widgets%23date-time)[draftjs-rich-text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/headless-cms-widgets%23draftjs-rich-text)[media-gallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/headless-cms-widgets%23media-gallery)\n\n[Adding a widget to a store section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/headless-cms-widgets%23adding-a-widget-to-a-store-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/faststore/docs/headless-cms/widgets.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Widgets available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/headless-cms-widgets%23widgets-available)\n\n[checkboxes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/headless-cms-widgets%23checkboxes)[image-uploader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/headless-cms-widgets%23image-uploader)[date-time](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/headless-cms-widgets%23date-time)[draftjs-rich-text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/headless-cms-widgets%23draftjs-rich-text)[media-gallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/headless-cms-widgets%23media-gallery)\n\n[Adding a widget to a store section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-widgets/docs/guides/faststore/headless-cms-widgets%23adding-a-widget-to-a-store-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_89e411e0
|
[
{
"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 store 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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-builder/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-builder/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-builder/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-builder/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-builder/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-builder/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-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-store-builder/docs/guides/vtex-io-documentation-builders)\n\n[Store Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-builder/docs/guides/vtex-io-documentation-store-builder)\n\nStore builder\n\nLearn how to use the VTEX IO Store builder.\n\nThe `store` builder enables the development of [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io) storefronts, empowering the development of both [storefront components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3) and unique store themes. The main use cases of the `store` builder include:\n\n* **Frontend apps**: When used alongside the [react builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-react-builder), the `store` builder allows integrating a [frontend component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io) with Site Editor. It enables mapping a React component to a block, grouping store blocks, and defining route handling within a component.\n* **Store Theme apps**: Defines block usage and store routes.\n\n> Note that if your store uses a different [storefront solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/storefront-development), the `store` builder is not necessary, as this builder is specifically designed for developing apps for Store Framework.\n\nThis builder interprets and validates the [blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-composition%23blocks), [interfaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface), and [routes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-routes) within the `/store` folder.\n\nWith the `store` builder, you can use VTEX IO capabilities to quickly build store components and themes that can be reused across ecommerce stores and interact seamlessly with VTEX APIs and existing components.\n\n## Folder structure\n\nAn app that uses the `store` builder has a folder named `/store` in its root directory. The directory structure may vary depending on the specific project settings.\n\nThe basic structure of a `/store` folder is composed of the following files, as you can see in the [store repository](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store/tree/master/store):\n\n`1\n\nstore \n\n2\n\n ┣ 📄 blocks.json \n\n3\n\n ┣ 📄 contentSchemas.json \n\n4\n\n ┣ 📄 interfaces.json \n\n5\n\n ┗ 📄 routes.json \n\n`\n\n* `blocks.json`: Declares all blocks that exist in your project. Note that blocks can be defined both in the `store/blocks.json` file or in any number of `.json` files organized within the `store/blocks` directory, using an arbitrary directory structure.\n* `contentSchemas.json`: Follows the [JSON Schema](https://read.calvincode.net/reader?url=https://json-schema.org/) format.\n* `interfaces.json`: Establishes a relationship between blocks and React components. Learn more in [Interfaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-interface).\n* `routes.json`: Creates custom routes in your app, mapping page templates to the path they will respond to. When developing store themes, see [Creating a custom page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page) for more information.\n\n## Usage\n\nTo use the `store` builder in your app, follow these steps:\n\nAdd the `store` builder to your app’s builder list in the `manifest.json` file, as follows:\n\n`1\n\n \"builders\": { \n\n2\n\n \"store\": \"0.x\" \n\n3\n\n } \n\n`\n\nIn the root directory of your app, create a `/store` folder.\n\n> If you are developing a store theme with Store Framework from the [Store Theme boilerplate](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-theme), the `store` builder is natively installed, along with the `/store` folder.\n\n## Use case examples\n\nEvery store theme developed using Store Framework requires the `store` builder. Moreover, the `store` builder is also used in the development of any [Store Framework component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps).\n\nBelow, you can check both scenarios.\n\n### Store theme\n\nWhen [creating a Store Framework storefront project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-settingyourstoretheme), the first step is installing the [Store Theme boilerplate](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-theme). This process automatically installs the `store` builder in the `manifest.json` file.\n\nNext, you can check the file structure of the Store Theme app:\n\n`1\n\nstore \n\n2\n\n ┣ 📂 blocks \n\n3\n\n ┗ 📂 footer \n\n4\n\n ┗ 📂 header \n\n5\n\n ┗ 📂 home \n\n6\n\n ┗ 📂 pdp \n\n7\n\n ┗ 📂 product-summary \n\n8\n\n ┗ 📄about-us.json \n\n9\n\n ┗ 📄contact.jsonc \n\n10\n\n ┗ 📄faq.jsonc \n\n11\n\n ┗ 📄minicart.jsonc \n\n12\n\n ┗ 📄orderplaced.jsonc \n\n13\n\n ┗ 📄product-price.jsonc \n\n14\n\n ┗ 📄search.jsonc \n\n15\n\n ┣ 📄blocks.json \n\n16\n\n ┣ 📄routes.json \n\n`\n\n* The `blocks` folder contains the [Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components) installed by default, such as `footer`, `header`, `home`, `minicart`, `search`, among others.\n* The `blocks.json` file defines the organization and structure of different blocks that compose the storefront project.\n* The `routes.json` file defines custom routes for different sections of the storefront project, such as `store.custom#about-us`, `store.custom#faq`, and `store.custom#contact-us`, providing the path where the content related to that route can be accessed.\n\nFor more information on building a store theme with Store Framework, check the [Storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3) documentation.\n\n### Frontend components\n\nThe `store` builder is also necessary when developing a frontend app for use within a Store Theme app. Typically, such an app also leverages the [react builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-react-builder). For example, consider the [Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary) app.\n\nThe Product Summary app summarizes product information, including its name, price, and image.\n\nNext, you can check the structure of the `store` folder for the Product Summary app:\n\n`1\n\nstore \n\n2\n\n ┣ 📄 blocks.json \n\n3\n\n ┣ 📄 contentSchemas.json \n\n4\n\n ┣ 📄 interfaces.json \n\n`\n\nWithin each of these files, there is a JSON structure, as follows:\n\n* `blocks.json`: Outlines the composition of a product summary component, specifying how different elements, such as image, name, attachments, price, and buy button should be arranged within various layouts (shelf and flex).\n* `contentSchemas.json`: Defines the properties and settings for two types of components related to product summaries, “ProductSummary” and “ProductSummaryList”. This includes specifying text labels, badge information, and positional details for integration with Site Editor.\n* `inferfaces.json`: Maps a React component from the [react builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-react-builder) to a block definition.\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/Reference/concepts/vtex-io-documentation-builders/vtex-io-documentation-store-builder.md)\n\n[React Builder« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-builder//docs/guides/vtex-io-documentation-react-builder)[Styles BuilderNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-builder//docs/guides/vtex-io-documentation-styles-builder)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Folder structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-builder/docs/guides/vtex-io-documentation-store-builder%23folder-structure)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-builder/docs/guides/vtex-io-documentation-store-builder%23usage)\n\n[Use case examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-builder/docs/guides/vtex-io-documentation-store-builder%23use-case-examples)\n\n[Store theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-builder/docs/guides/vtex-io-documentation-store-builder%23store-theme)[Frontend components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-builder/docs/guides/vtex-io-documentation-store-builder%23frontend-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/guides/vtex-io/Reference/concepts/vtex-io-documentation-builders/vtex-io-documentation-store-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-store-builder/docs/guides/vtex-io-documentation-store-builder%23folder-structure)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-builder/docs/guides/vtex-io-documentation-store-builder%23usage)\n\n[Use case examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-builder/docs/guides/vtex-io-documentation-store-builder%23use-case-examples)\n\n[Store theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-builder/docs/guides/vtex-io-documentation-store-builder%23store-theme)[Frontend components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-builder/docs/guides/vtex-io-documentation-store-builder%23frontend-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_f7c262a8
|
[
{
"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 checkout 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-checkout/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-checkout/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-checkout/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-checkout/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-checkout/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-checkout/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-checkout/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/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-checkout/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/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-checkout/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/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-checkout/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-checkout/docs/guides/ui-customization-my-authentication)\n\n[vtex.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs)\n\n[vtex.js for Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/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-checkout/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-checkout/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/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-checkout/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-checkout/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/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-checkout/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/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-checkout/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/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-checkout/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-checkout/docs/guides/ui-customization-my-authentication)\n\n[vtex.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs)\n\n[vtex.js for Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/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-checkout/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-checkout/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/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-checkout/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-checkout/docs/guides)\n\nUI Customization\n\n[vtex.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs)\n\n[vtex.js for Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout)\n\nvtex.js for Checkout\n\nThe Checkout module handles customer purchase information.\n\nCheckout adds different details needed to create an order, such as customer profile, address, shipping, and item information.\n\nThe OrderForm is the structure that contains this clustered data. It has several sections, each with helpful information that can be accessed, manipulated, and changed. To learn more, read the [OrderForm documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields).\n\n## Behavior of successive API requests\n\nThe `checkout` module encapsulates all requests that modify the orderForm and adds a cancellation behavior for subsequent requests.\n\nThus, subsequent requests to perform the same operation cause the `abort` of the previous request for the same operation. This means that if 3 successive requests are made for the same operation, the first 2 will be aborted, and only the third will be considered. For this reason, if more than one consumer uses the same Checkout instance, requests may be unintentionally aborted.\n\nConsider the following scenario:\n\n* Application A creates variable API = new vtexjs.Checkout()\n* Plugin B uses API.sendAttachment() to send an address\n* Plugin C uses API.sendAttachment() to simultaneously send another address\n* Result: Call from B will be aborted and replaced with the call from C. This is expected. However, if Plugin B is waiting for the resolution of the call promise (e.g., using done()), it will never be successful because the request \"failed\" (was aborted).\n\nThere are two ways to solve this situation:\n\n* Each plugin uses its Checkout instance, e.g., var APIInternaDoPluginA = new vtexjs.Checkout().\n* The `orderFormUpdated.vtex` event handler is used to receive success notifications for Checkout modifications.\n\nWe recommend using `extended-ajax.js` (used by default in the bundle). With that, all requests are queued, so they do not happen in parallel.\n\n## Events\n\n### `orderFormUpdated.vtex [orderForm]`\n\nWhen a call updates the orderForm, the orderFormUpdated.vtex event is fired. This is useful for different components that use vtex.js to stay updated without knowing the other present components.\n\n**Important**: This event is only sent when the last pending request is finished. So, if multiple consecutive calls to the API are queued, the event will only be sent at the end of the last call.\n\n### `checkoutRequestBegin.vtex [ajaxOptions]`\n\nWhen any request that changes the orderForm is started, this event is fired. It can be used, for example, to initiate a load on the screen and prevent the user from making further modifications. The ajaxOptions parameter is the option object originally used to initiate this request.\n\n### `checkoutRequestEnd.vtex [orderForm|jqXHR]`\n\nWhen any request that changes the orderForm is finished, _with or without success_, this event is fired. Note that the argument can be an `orderForm` on success, or `jqXHR` in case of failure. It is not recommended to use this request to detect changes in the orderForm. Instead, use `orderFormUpdated.vtex`.\n\n## expectedOrderFormSections\n\nYou will notice that most methods require an `expectedOrderFormSections` argument.\n\nThe orderForm is made up of several sections (or attachments). You can request that only a few be sent in the response.\n\nThis primarily improves performance when you know your call will not affect the sections you did not ask for, or if you do not mind the changes.\n\nIn general, it is safe not to send this argument, in which case all sections will be required.\n\nYou can see a description of each section by taking a look at the `_allOrderFormSections` property.\n\nGiven this explanation, this argument will no longer be detailed in the method documentation.\n\n### Example\n\n`1\n\n$(window).on(\"orderFormUpdated.vtex\", function(evt, orderForm) { \n\n2\n\n alert(\"Someone changed the orderForm!\") \n\n3\n\n console.log(orderForm) \n\n4\n\n}) \n\n`\n\n## getOrderForm(expectedOrderFormSections\n\nGets the current orderForm.\n\nThis is one of the most important methods. It is essential to make sure that an orderForm is available before making calls to change it.\n\n### Returns\n\n`Promise` for the orderForm.\n\n### Example\n\n`1\n\nvtexjs.checkout.getOrderForm().done(function(orderForm) { \n\n2\n\n console.log(orderForm) \n\n3\n\n}) \n\n`\n\n## sendAttachment(attachmentId, attachment, expectedOrderFormSections\n\nSends an attachment to the current orderForm. (An attachment is a section.)\n\nThis makes it possible to update this section by sending new information, making changes, or removing something.\n\n> You must send the complete attachment. See examples.\n\nRead the [OrderForm documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) to learn more about sections.\n\nDo not forget to use `getOrderForm` first.\n\n### Returns\n\n`Promise` for the orderForm.\n\n### Arguments\n\n| Name | Type |\n| ------------ | -------------------------------------------------------- |\n| attachmentId | String containing the name of the attachment being sent. |\n| attachment | Object containing the attachment. |\n\n### Examples\n\n#### Change clientProfileData\n\nIf you want to change the customer's first name, change the property `firstName` in `clientProfileData`.\n\n`1\n\nvtexjs.checkout \n\n2\n\n .getOrderForm() \n\n3\n\n .then(function(orderForm) { \n\n4\n\n var clientProfileData = orderForm.clientProfileData \n\n5\n\n clientProfileData.firstName = William \n\n6\n\n return vtexjs.checkout.sendAttachment( \n\n7\n\n \"clientProfileData\", \n\n8\n\n clientProfileData \n\n9\n\n ) \n\n10\n\n }) \n\n11\n\n .done(function(orderForm) { \n\n12\n\n alert(\"Name changed!\") \n\n13\n\n console.log(orderForm) \n\n14\n\n console.log(orderForm.clientProfileData) \n\n15\n\n }) \n\n`\n\n#### Change openTextField\n\nThe openTextField is a field for comments. Read the [OrderForm documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) for more information.\n\n`1\n\nvtexjs.checkout \n\n2\n\n .getOrderForm() \n\n3\n\n .then(function(orderForm) { \n\n4\n\n var obs = \"No onion!\" \n\n5\n\n return vtexjs.checkout.sendAttachment(\"openTextField\", { value: obs }) \n\n6\n\n }) \n\n7\n\n .done(function(orderForm) { \n\n8\n\n console.log(\"openTextField filled with: \", orderForm.openTextField) \n\n9\n\n }) \n\n`\n\n## addToCart(items, expectedOrderFormSections, salesChannel)\n\nAdd items to the orderForm.\n\n> This method does not automatically apply to promotions through UTM. To add promotions using UTM, do a `sendAttachment` of `marketingData` with the required information.\n\nAn item to be added is necessarily composed of: `id`, `quantity`, and `seller`. The `id` property can be obtained from the [Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/vtexjs-for-catalog) by looking at the ItemId of the item in the product item array.\n\nItems that are already in the orderForm will remain unchanged.\n\n### Returns\n\n`Promise` for the orderForm.\n\n### Arguments\n\n| Name | Type |\n| ------------ | --------------------------------------------------------------------------------------------------------------------- |\n| items | Array containing the set of items that will be added. Even if there is only one item, it must be wrapped in an array. |\n| salesChannel | Number or String(Optional parameter, default = 1). |\n\n### Example\n\nAdd an item with itemId 2000017893 from sales channel 3.\n\n`1\n\nvar item = { \n\n2\n\n id: 2000017893, \n\n3\n\n quantity: 1, \n\n4\n\n seller: \"1\", \n\n5\n\n} \n\n6\n\nvtexjs.checkout.addToCart([item], null, 3).done(function(orderForm) { \n\n7\n\n alert(\"Item added!\") \n\n8\n\n console.log(orderForm) \n\n9\n\n}) \n\n`\n\n## updateItems(items, expectedOrderFormSections)\n\nUpdates items in the orderForm.\n\nAn item is identified by its `index` property. In the orderForm, this property can be obtained by looking at the item index in the item array.\n\nRead the [OrderForm documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) to learn more about the item object.\n\nProperties and orderForm items that are not sent, will remain unchanged.\n\nDo not forget to use getOrderForm first.\n\n### Returns\n\n`Promise` for the orderForm.\n\n### Arguments\n\n| Name | Type |\n| --------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| items | Array containing the set of items that will be updated. Even if there is only one item, it must be wrapped in an array. |\n| splitItem | Boolean default: true. Indicates if a separate item should be created when the items to be updated have attachments/services. |\n\n### Example\n\nChange the quantity and the seller of the first item.\n\n`1\n\nvtexjs.checkout \n\n2\n\n .getOrderForm() \n\n3\n\n .then(function(orderForm) { \n\n4\n\n var itemIndex = 0 \n\n5\n\n var item = orderForm.items[itemIndex] \n\n6\n\n var updateItem = { \n\n7\n\n index: itemIndex, \n\n8\n\n quantity: 5, \n\n9\n\n } \n\n10\n\n return vtexjs.checkout.updateItems([updateItem], null, false) \n\n11\n\n }) \n\n12\n\n .done(function(orderForm) { \n\n13\n\n alert(\"Items updated!\") \n\n14\n\n console.log(orderForm) \n\n15\n\n }) \n\n`\n\n## removeItems(items, expectedOrderFormSections)\n\nRemoves items from the orderForm.\n\nAn item is identified by its `index` property. In the orderForm, this property can be obtained by looking at the item index in the item array.\n\nDo not forget to use getOrderForm first.\n\n### Returns\n\n`Promise` for the orderForm.\n\n### Arguments\n\n| Name | Type |\n| ----- | ----------------------------------------------------------------------------------------------------------------------- |\n| items | Array containing the set of items that will be removed. Even if there is only one item, it must be wrapped in an array. |\n\n### Example\n\nRemove the first item.\n\n`1\n\nvtexjs.checkout \n\n2\n\n .getOrderForm() \n\n3\n\n .then(function(orderForm) { \n\n4\n\n var itemIndex = 0 \n\n5\n\n var item = orderForm.items[itemIndex] \n\n6\n\n var itemsToRemove = [ \n\n7\n\n { \n\n8\n\n index: 0, \n\n9\n\n quantity: 0, \n\n10\n\n }, \n\n11\n\n ] \n\n12\n\n return vtexjs.checkout.removeItems(itemsToRemove) \n\n13\n\n }) \n\n14\n\n .done(function(orderForm) { \n\n15\n\n alert(\"Item removed!\") \n\n16\n\n console.log(orderForm) \n\n17\n\n }) \n\n`\n\n## removeAllItems(expectedOrderFormSections)\n\nRemoves all items from the orderForm.\n\nDo not forget to use getOrderForm first.\n\n### **Returns**\n\n`Promise` for the orderForm.\n\n### Example\n\n`1\n\nvtexjs.checkout.removeAllItems() \n\n2\n\n.done(function(orderForm) { \n\n3\n\nalert('Empty cart.'); \n\n4\n\nconsole.log(orderForm); \n\n5\n\n}); \n\n`\n\n## cloneItem(itemIndex, newItemsOptions, expectedOrderFormSections)\n\nCreates one or more items in the cart based on another item. The item to be cloned must have an attachment.\n\nAn item is identified by its `index` property. In the orderForm, this property can be obtained by looking at the item index in the item array.\n\nDo not forget to use getOrderForm first.\n\n### Returns\n\n`Promise` for the orderForm.\n\n### Arguments\n\n| Name | Type |\n| --------------- | ------------------------------------------------------------------------------ |\n| itemIndex | Index number of the item to which the offer is applied. |\n| newItemsOptions | Array (optional) with the properties that should be assigned to the new items. |\n\n### Example\n\nCreate a new item based on the item with index 0.\n\n`1\n\nvar itemIndex = 0; \n\n2\n\n \n3\n\nvtexjs.checkout.cloneItem(itemIndex) \n\n4\n\n .done(function(orderForm) { \n\n5\n\n console.log(orderForm); \n\n6\n\n }); \n\n`\n\nCreate a new item based on an item with index 0, quantity 2, and an attachment already configured.\n\n`1\n\nvar itemIndex = 0 \n\n2\n\nvar newItemsOptions = [ \n\n3\n\n { \n\n4\n\n itemAttachments: [ \n\n5\n\n { \n\n6\n\n name: \"Customization\", \n\n7\n\n content: { \n\n8\n\n Name: \"Robert\", \n\n9\n\n }, \n\n10\n\n }, \n\n11\n\n ], \n\n12\n\n quantity: 2, \n\n13\n\n }, \n\n14\n\n] \n\n15\n\n \n16\n\nvtexjs.checkout.cloneItem(itemIndex, newItemsOptions).done(function(orderForm) { \n\n17\n\n console.log(orderForm) \n\n18\n\n}) \n\n`\n\n## calculateShipping(address)\n\nReceives an address and records it in the user's shippingData.\n\nThe effect is that the shipping will be calculated and available in one of the orderForm totalizers.\n\nDo not forget to use getOrderForm first.\n\n### Returns\n\n`Promise` for the orderForm.\n\n### Arguments\n\n| Name | Type |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------- |\n| address | Object containing the address that must have at least postalCode and country. From these two properties, the others will be inferred. |\n\n### Example\n\n`1\n\nvtexjs.checkout.getOrderForm() \n\n2\n\n .then(function(orderForm) { \n\n3\n\n var postalCode = '22250-040'; // no hyphen is also OK \n\n4\n\n var country = 'BRA'; \n\n5\n\n var address = { \n\n6\n\n \"postalCode\": postalCode, \n\n7\n\n \"country\": country \n\n8\n\n }; \n\n9\n\n return vtexjs.checkout.calculateShipping(address) \n\n10\n\n }) \n\n11\n\n .done(function(orderForm) { \n\n12\n\n alert(Shipping calculated.'); \n\n13\n\n console.log(orderForm.shippingData); \n\n14\n\n console.log(orderForm.totalizers); \n\n15\n\n }); \n\n`\n\n## simulateShipping(items, postalCode, country, salesChannel) \\[DEPRECATED\\]\n\nReceives an item list, postalCode, and country and simulates the shipping of these items for this address.\n\nThe difference from `calculateShipping` is that this call is isolated. It can be used for an arbitrary set of items and does not bind the address to the user.\n\nThe result of this simulation includes the different carriers that can be used for each item, including name, delivery date, and price.\n\nIt is ideal for simulating shipping on the product page.\n\n### Returns\n\nPromise with the result. The result has the property logisticsInfo.\n\n### Arguments\n\n| Name | Type |\n| ------------ | ------------------------------------------------------------------------- |\n| items | Array of objects that have at least ID, quantity, and seller. |\n| postalCode | String with the postal code. (CEP for Brazil.) |\n| country | String with the three-letter country code. For example, \"BRA\" for Brazil. |\n| salesChannel | Number or string. (Optional parameter, default = 1.) |\n\n### Example\n\n`` 1\n\n// `Items` must be an array of objects containing at least the information below \n\n2\n\nvar items = [ \n\n3\n\n { \n\n4\n\n id: 5987, // item sku \n\n5\n\n quantity: 1, \n\n6\n\n seller: \"1\", \n\n7\n\n }, \n\n8\n\n] \n\n9\n\n \n10\n\n// For Brazil, `postalCode` must be the customer's CEP \n\n11\n\nvar postalCode = \"22250-040\" \n\n12\n\n// This also works \n\n13\n\n// var postalCode = '22250040'; \n\n14\n\n \n15\n\n// `country` must be the 3-letter country code \n\n16\n\nvar country = \"BRA\" \n\n17\n\n \n18\n\nvtexjs.checkout \n\n19\n\n .simulateShipping(items, postalCode, country) \n\n20\n\n .done(function(result) { \n\n21\n\n /* `result.logisticsInfo` is an array of objects. \n\n22\n\n Each object corresponds to the logistics information (shipping) for each item in the order in which the items were sent. \n\n23\n\n For example, `result.logisticsInfo[0].slas` will contain different carrier options (with deadline and price) for the first item. \n\n24\n\n For more details, check the orderForm documentation. \n\n25\n\n */ \n\n26\n\n}) \n\n ``\n\n## simulateShipping(shippingData, orderFormId, country, salesChannel)\n\nReceives an object containing shipping information (`shippingData`), the `orderFormId`, and `country`, and simulates the shipping of these items for this address.\n\nThe difference from `calculateShipping` is that this call receives different parameters to get the same result.\n\nThis is an overloaded function.\n\nThe result of this simulation is the same as the last one; it returns different carriers that can be used for each item, including name, delivery date, and price.\n\n### Returns\n\nPromise for the result. The result has the property `logisticsInfo`.\n\n### Arguments\\*\\*\n\n| Name | Type |\n| ------------ | -------------------------------------------------------------------------------------------- |\n| shippingData | Object containing shipping and item information through logisticsInfo and selectedAddresses. |\n| orderFormId | String representing the ID of the current session's orderForm. |\n| country | String with the three-letter country code. For example, \"BRA\" for Brazil. |\n| salesChannel | Number or string. (Optional parameter, default = 1.) |\n\n### Example\n\n`` 1\n\n// `logisticsInfo` must be an array of logisticsInfo objects and contain at least one selectedAddresses \n\n2\n\nvar shippingData = [ \n\n3\n\n { \n\n4\n\n logisticsInfo: logisticsInfoList, \n\n5\n\n selectedAddresses: selectedAddressesList, \n\n6\n\n }, \n\n7\n\n] \n\n8\n\n \n9\n\n// `orderFormId` must be an ID of the session's orderForm \n\n10\n\nvar orderFormId = \"9f879d435f8b402cb133167d6058c14f\" \n\n11\n\n \n12\n\n// `country` must be the 3-letter country code \n\n13\n\nvar country = \"BRA\" \n\n14\n\n \n15\n\nvtexjs.checkout \n\n16\n\n .simulateShipping(items, postalCode, country) \n\n17\n\n .done(function(result) { \n\n18\n\n /* `result.logisticsInfo` is an array of objects. \n\n19\n\n Each object corresponds to the logistics information (shipping) for each item in the order in which the items were sent. \n\n20\n\n For example, `result.logisticsInfo[0].slas` contains the different carrier options (with deadline and price) for the first item. \n\n21\n\n For more details, check the orderForm documentation. \n\n22\n\n */ \n\n23\n\n}) \n\n ``\n\n## getAddressInformation(address)\n\nGiven an incomplete address with postalCode and country, returns a complete address with city, state, street, and any other available information.\n\n### Returns\n\n`Promise` for the complete address.\n\n### Arguments\n\n| Name | Type |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------- |\n| address | Object with the address that must have at least postalCode and country. With these two properties, the others will be inferred. |\n\n### Example\n\n`` 1\n\n// For Brazil, `postalCode` must be the customer's CEP \n\n2\n\nvar postalCode = \"22250-040\" \n\n3\n\n// No hyphen also works \n\n4\n\n// var postalCode = '22250040'; \n\n5\n\n \n6\n\n// `country` must be the 3-letter country abbreviation \n\n7\n\nvar country = \"BRA\" \n\n8\n\n \n9\n\nvar address = { \n\n10\n\n postalCode: postalCode, \n\n11\n\n country: country, \n\n12\n\n} \n\n13\n\n \n14\n\nvtexjs.checkout.getAddressInformation(address).done(function(result) { \n\n15\n\n console.log(result) \n\n16\n\n}) \n\n ``\n\n## getProfileByEmail(email, salesChannel)\n\nPerforms partial user login using email.\n\nThe information will likely come masked, and you will not be able to edit it if the user already exists. For this, you need to authenticate with VTEX ID. You can check through the canEditData property of the orderForm. For more information, read the [OrderForm documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields).\n\nDo not forget to use getOrderForm first.\n\n### Returns\n\n`Promise` for the orderForm.\n\n### **Arguments**\n\n| Name | Type |\n| ------------ | ------------------------------- |\n| email | String |\n| salesChannel | Number or string (default = 1). |\n\n### Example\n\n`1\n\nvtexjs.checkout \n\n2\n\n .getOrderForm() \n\n3\n\n .then(function(orderForm) { \n\n4\n\n var email = \"example@vtex.com\" \n\n5\n\n return vtexjs.checkout.getProfileByEmail(email) \n\n6\n\n }) \n\n7\n\n .done(function(orderForm) { \n\n8\n\n console.log(orderForm) \n\n9\n\n }) \n\n`\n\n## removeAccountId(accountId, expectedOrderFormSections)\n\nIn orderForm.paymentData.availableAccounts, you find the user's payment accounts. Each account has several details, one of which is the accountId. This ID can be used in this method for removing the payment account.\n\nDo not forget to use getOrderForm first.\n\n### Returns\n\n`Promise` of success.\n\n### Arguments\n\n| Name | Type |\n| --------- | ------ |\n| accountId | String |\n\n### Example\n\n`1\n\nvtexjs.checkout \n\n2\n\n .getOrderForm() \n\n3\n\n .then(function(orderForm) { \n\n4\n\n var accountId = orderForm.paymentData.availableAccounts[0].accountId \n\n5\n\n return vtexjs.checkout.removeAccountId(accountId) \n\n6\n\n }) \n\n7\n\n .then(function() { \n\n8\n\n alert(\"Removed.\") \n\n9\n\n }) \n\n`\n\n## addDiscountCoupon(couponCode, expectedOrderFormSections)\n\nAdds a discount coupon to the orderForm.\n\nOnly one discount coupon can be applied per purchase.\n\nDo not forget to use getOrderForm first.\n\n### Returns\n\n`Promise` for the orderForm.\n\n### Arguments\n\n| Name | Type |\n| ---------- | ------ |\n| couponCode | String |\n\n### Example\n\n`1\n\nvtexjs.checkout \n\n2\n\n .getOrderForm() \n\n3\n\n .then(function(orderForm) { \n\n4\n\n var code = \"ABC123\" \n\n5\n\n return vtexjs.checkout.addDiscountCoupon(code) \n\n6\n\n }) \n\n7\n\n .then(function(orderForm) { \n\n8\n\n alert(\"Coupon added.\") \n\n9\n\n console.log(orderForm) \n\n10\n\n console.log(orderForm.paymentData) \n\n11\n\n console.log(orderForm.totalizers) \n\n12\n\n }) \n\n`\n\n## removeDiscountCoupon(expectedOrderFormSections)\n\nRemoves the orderForm discount coupon.\n\nOnly one discount coupon can be applied per purchase. Therefore, there is no need to specify anything here.\n\nDo not forget to use getOrderForm first.\n\n### Returns\n\n`Promise` for the orderForm.\n\n### Example\n\n`1\n\nvtexjs.checkout \n\n2\n\n .getOrderForm() \n\n3\n\n .then(function(orderForm) { \n\n4\n\n return vtexjs.checkout.removeDiscountCoupon() \n\n5\n\n }) \n\n6\n\n .then(function(orderForm) { \n\n7\n\n alert(\"Coupon removed.\") \n\n8\n\n console.log(orderForm) \n\n9\n\n console.log(orderForm.paymentData) \n\n10\n\n console.log(orderForm.totalizers) \n\n11\n\n }) \n\n`\n\n## removeGiftRegistry(expectedOrderFormSections)\n\nRemoves the gift registry from the orderForm.\n\nThis unlinks the gift list to which the orderForm is associated, if any. If it is not linked, it does not do anything.\n\nDo not forget to use getOrderForm first.\n\n### Returns\n\n`Promise` for the orderForm.\n\n### Example\n\n`1\n\nvtexjs.checkout \n\n2\n\n .getOrderForm() \n\n3\n\n .then(function(orderForm) { \n\n4\n\n return vtexjs.checkout.removeGiftRegistry() \n\n5\n\n }) \n\n6\n\n .then(function(orderForm) { \n\n7\n\n alert(\"Gift list removed.\") \n\n8\n\n console.log(orderForm) \n\n9\n\n }) \n\n`\n\n## addOffering(offeringId, itemIndex, expectedOrderFormSections)\n\nAdds an offer to the orderForm.\n\nEach orderForm item may have a list of `offerings`. These offers are linked to the item, like extended warranty or installation service.\n\nWhen an offer is added, it will appear in the item's `bundleItems` field.\n\nDo not forget to use getOrderForm first.\n\n### Returns\n\n`Promise` for the orderForm.\n\n### Arguments\n\n| Name | Type |\n| ---------- | -------------------------------------------------------------------- |\n| offeringId | String or number. This may be found in the id property of the offer. |\n| itemIndex | Number. The index of the item to which the offer is applied. |\n\n### Example\n\n`1\n\n// Considering the following (summarized) structure of items: \n\n2\n\nvar items = [ \n\n3\n\n { \n\n4\n\n id: \"2004075\", \n\n5\n\n productId: \"4741\", \n\n6\n\n name: \"Dog food\", \n\n7\n\n skuName: \"3 kg Dog Food\", \n\n8\n\n quantity: 3, \n\n9\n\n seller: \"1\", \n\n10\n\n bundleItems: [], \n\n11\n\n offerings: [ \n\n12\n\n { \n\n13\n\n id: \"1033\", \n\n14\n\n name: \"The Magnificent Offer\", \n\n15\n\n price: 100, \n\n16\n\n type: \"idk\", \n\n17\n\n }, \n\n18\n\n ], \n\n19\n\n availability: \"available\", \n\n20\n\n }, \n\n21\n\n] \n\n22\n\n \n23\n\nvar offeringId = items[0].offerings[0].id \n\n24\n\nvar itemIndex = 0 \n\n25\n\n \n26\n\nvtexjs.checkout \n\n27\n\n .getOrderForm() \n\n28\n\n .then(function() { \n\n29\n\n return vtexjs.checkout.addOffering(offeringId, itemIndex) \n\n30\n\n }) \n\n31\n\n .done(function(orderForm) { \n\n32\n\n // Offer added! \n\n33\n\n console.log(orderForm) \n\n34\n\n }) \n\n`\n\n## removeOffering(offeringId, itemIndex, expectedOrderFormSections)\n\nRemoves an offer.\n\nDo not forget to use getOrderForm first.\n\n### Returns\n\n`Promise` for the orderForm.\n\n### Arguments\n\n| Name | Type |\n| ---------- | --------------------------------------------------------------- |\n| offeringId | String or number. This may be found in the offer's id property. |\n| itemIndex | Number. The index of the item to which the offer is applied. |\n\n### Example\n\n`1\n\n// Considering the following (summarized) structure of items: \n\n2\n\nvar items = [ \n\n3\n\n { \n\n4\n\n id: \"2004075\", \n\n5\n\n productId: \"4741\", \n\n6\n\n name: \"Dog Food\", \n\n7\n\n skuName: \"3 kg Dog Food\", \n\n8\n\n quantity: 3, \n\n9\n\n seller: \"1\", \n\n10\n\n bundleItems: [ \n\n11\n\n { \n\n12\n\n id: \"1033\", \n\n13\n\n name: \"The Magnificent Offer\", \n\n14\n\n price: 100, \n\n15\n\n type: \"idk\", \n\n16\n\n }, \n\n17\n\n ], \n\n18\n\n offerings: [ \n\n19\n\n { \n\n20\n\n id: \"1033\", \n\n21\n\n name: \"The Magnificent Offer\", \n\n22\n\n price: 100, \n\n23\n\n type: \"idk\", \n\n24\n\n }, \n\n25\n\n ], \n\n26\n\n availability: \"available\", \n\n27\n\n }, \n\n28\n\n] \n\n29\n\n \n30\n\nvar offeringId = items[0].bundleItems[0].id \n\n31\n\nvar itemIndex = 0 \n\n32\n\n \n33\n\nvtexjs.checkout \n\n34\n\n .getOrderForm() \n\n35\n\n .then(function() { \n\n36\n\n return vtexjs.checkout.removeOffering(offeringId, itemIndex) \n\n37\n\n }) \n\n38\n\n .done(function(orderForm) { \n\n39\n\n // Offer removed! \n\n40\n\n console.log(orderForm) \n\n41\n\n }) \n\n`\n\n## addItemAttachment(itemIndex, attachmentName, content, expectedOrderFormSections, splitItem)\n\nThis method adds an attachment to an item in the cart. This allows you to add extra information to the item.\n\nYou can link an attachment to the SKU through the admin interface. To see which attachments can be inserted, check the item's `attachmentOfferings` property.\n\nFor example, when adding a sports team shirt to the cart, you can add the 'customization' attachment to allow the customer to choose the number that will be printed on the shirt.\n\nIf the attachment has more than one property in its object, you must send the complete object even if you only changed one field.\n\nExample\n\nThe item has an attachmentOffering as follows:\n\n`1\n\n\"attachmentOfferings\": [{ \n\n2\n\n \"name\": \"Customization\", \n\n3\n\n \"required\": true, \n\n4\n\n \"schema\": { \n\n5\n\n \"Name\": { \n\n6\n\n \"maximumNumberOfCharacters\": 20, \n\n7\n\n \"domain\": [] \n\n8\n\n }, \n\n9\n\n \"Number\": { \n\n10\n\n \"maximumNumberOfCharacters\": 20, \n\n11\n\n \"domain\": [] \n\n12\n\n } \n\n13\n\n } \n\n14\n\n}], \n\n`\n\nThe content object must always send all its properties:\n\n`1\n\nvar itemIndex = 0 \n\n2\n\nvar attachmentName = Customization \n\n3\n\n \n4\n\n// User entered the value for the Name field. The object must also pass the Number field. \n\n5\n\nvar content = { Name: Robert, Number: \"\" } \n\n6\n\n \n7\n\nvtexjs.checkout.addItemAttachment( \n\n8\n\n itemIndex, \n\n9\n\n attachmentName, \n\n10\n\n content, \n\n11\n\n null, \n\n12\n\n false \n\n13\n\n) \n\n`\n\nDo not forget to call getOrderForm at least once before.\n\n### Returns\n\n`Promise` for the orderForm.\n\n### Arguments\n\n| Name | Type |\n| -------------- | -------------------------------------------------------------------------------------------------------------------- |\n| itemIndex | Number. The index of the item that will be included in the attachment. |\n| attachmentName | String that can be found in the name property of attachmentOfferings in the item object. |\n| content | Object. An object that follows the schema described in the schema property of attachmentOfferings. |\n| splitItem | Boolean default: true. Indicates that a separate item should be created if the items to be updated have attachments. |\n\n### Example\n\n`1\n\n// Called sometime before \n\n2\n\n// vtexjs.checkout.getOrderForm() \n\n3\n\n \n4\n\nvar itemIndex = 0 \n\n5\n\nvar attachmentName = \"Customization\" \n\n6\n\nvar content = { \n\n7\n\n Name: Robert, \n\n8\n\n Numero: \"10\", \n\n9\n\n} \n\n10\n\n \n11\n\nvtexjs.checkout \n\n12\n\n .addItemAttachment(itemIndex, attachmentName, content) \n\n13\n\n .done(function(orderForm) { \n\n14\n\n // Attachment added to the item! \n\n15\n\n console.log(orderForm) \n\n16\n\n }) \n\n`\n\n### Possible errors\n\n404: The item does not have this linked `attachment` or the `content` object has an invalid property. 400: The `content` object was not passed correctly.\n\nIf the call fails, check the error object returned: `(error.message)`. This will give you clues about what is wrong in the call.\n\n## **removeItemAttachment(itemIndex, attachmentName, content, expectedOrderFormSections)**\n\nRemoves an item attachment from the cart.\n\nDo not forget to use getOrderForm first.\n\n### Returns\n\n`Promise` for the orderForm.\n\n### Arguments\n\n| Name | Type |\n| -------------- | -------------------------------------------------------------------------------------------------- |\n| itemIndex | Number. The index of the item that will be included in the attachment. |\n| attachmentName | String that can be found in the name property of attachmentOfferings in the item object. |\n| content | Object. An object that follows the schema described in the schema property of attachmentOfferings. |\n\n## addBundleItemAttachment(itemIndex, bundleItemId, attachmentName, content, expectedOrderFormSections)\n\nThis method adds an attachment to the service (bundleItem) of an item in the cart.\n\nYou can link an attachment to the service through the admin interface. To see which attachments can be inserted, check the attachmentOfferings property of the service.\n\nDo not forget to use getOrderForm first.\n\n### Returns\n\n`Promise` for the orderForm.\n\n### Arguments\n\n| Name | Type |\n| -------------- | -------------------------------------------------------------------------------------------------- |\n| itemIndex | Number. The index of the item to which the service is applied. |\n| bundleId | String or number. This may be found in the id property of the bundleItem. |\n| attachmentName | String that can be found in the name property of attachmentOfferings in the service object. |\n| content | Object. An object that follows the schema described in the schema property of attachmentOfferings. |\n\n### Example\n\n`1\n\nvar itemIndex = 0 \n\n2\n\nvar bundleItemId = 5 \n\n3\n\nvar attachmentName = \"message\" \n\n4\n\nvar content = { \n\n5\n\n text: \"Congratulations!\", \n\n6\n\n} \n\n7\n\n \n8\n\nvtexjs.checkout \n\n9\n\n .getOrderForm() \n\n10\n\n .then(function() { \n\n11\n\n return vtexjs.checkout.addBundleItemAttachment( \n\n12\n\n itemIndex, \n\n13\n\n bundleItemId, \n\n14\n\n attachmentName, \n\n15\n\n content \n\n16\n\n ) \n\n17\n\n }) \n\n18\n\n .done(function(orderForm) { \n\n19\n\n // Attachment added to the item! \n\n20\n\n console.log(orderForm) \n\n21\n\n }) \n\n`\n\n## removeBundleItemAttachment(itemIndex, bundleItemId, attachmentName, content, expectedOrderFormSections)\n\nRemoves an attachment from a service.\n\nDo not forget to use getOrderForm first.\n\n### Returns\n\n`Promise` for the orderForm.\n\n### Arguments\n\n| Name | Type |\n| -------------- | ------------------------------------------------------------------------------------------- |\n| itemIndex | Number. The index of the item to which the service is applied. |\n| bundleId | String ou Number May be found in the id property of the bundleItem |\n| attachmentName | String that can be found in the name property of attachmentOfferings in the service object. |\n| content | An object that follows the schema described in the schema property of attachmentOfferings. |\n\n## sendLocale(locale)\n\nChanges the user locale.\n\nThis causes a change in the orderForm, in `clientPreferencesData`.\n\nDo not forget to use getOrderForm first.\n\n### Returns\n\n`Promise` of success (no orderForm section is requested).\n\n### Arguments\n\n| Name | Type |\n| ------ | ---------------------------------- |\n| locale | String examples: \"pt-BR\", \"en-US\". |\n\n### Example\n\n`1\n\nvtexjs.checkout \n\n2\n\n .getOrderForm() \n\n3\n\n .then(function(orderForm) { \n\n4\n\n return vtexjs.checkout.sendLocale(\"en-US\") \n\n5\n\n }) \n\n6\n\n .then(function() { \n\n7\n\n alert(\"Now you're an American ;)\") \n\n8\n\n }) \n\n`\n\n## clearMessages(expectedOrderFormSections)\n\nOccasionally, the orderForm has its `messages` section populated with informational or error messages.\n\nTo clear the messages, use this method.\n\nDo not forget to use getOrderForm first.\n\n### Returns\n\n`Promise` of success (no orderForm section is requested).\n\n### Example\n\n`1\n\nvtexjs.checkout \n\n2\n\n .getOrderForm() \n\n3\n\n .then(function(orderForm) { \n\n4\n\n return vtexjs.checkout.clearMessages() \n\n5\n\n }) \n\n6\n\n .then(function() { \n\n7\n\n alert(\"Messages cleaned.\") \n\n8\n\n }) \n\n`\n\n## getLogoutURL()\n\nThis method returns a URL that logs the user out, but keeps their cart.\n\nYou are responsible for making this redirection.\n\nDo not forget to use getOrderForm first.\n\n### Returns\n\n`String`\n\n### Example\n\n`1\n\n$(\".logout\").on(\"click\", function() { \n\n2\n\n vtexjs.checkout.getOrderForm().then(function(orderForm) { \n\n3\n\n var logoutURL = vtexjs.checkout.getLogoutURL() \n\n4\n\n window.location = logoutURL \n\n5\n\n }) \n\n6\n\n}) \n\n`\n\n## getOrders(orderGroupId)\n\nGets the orders (order) contained in an order group (orderGroup).\n\nIf an order has been finalized and fulfilled by multiple sellers, it will be split into several orders — one for each seller.\n\nThe orderGroupId looks like `v50123456abc`, while group orders have identifiers such as `v50123456abc-01`, `v50123456abc-02`.\n\nIn most cases, an orderGroup will only contain one order.\n\nIn terms of data, an orderGroup is an array of order objects. An order has several properties related to the completion of the purchase. Full documentation of this object will be available soon.\n\n### Returns\n\n`Promise` for the orders.\n\n### Arguments\n\n| Name | Type |\n| ------------ | ------ |\n| orderGroupId | String |\n\n### Example\n\n`1\n\nvar orderGroupId = \"v50123456abc\" \n\n2\n\nvtexjs.checkout.getOrders(orderGroupId).then(function(orders) { \n\n3\n\n console.log(\"Number of orders in this group: \", orders.length) \n\n4\n\n console.log(orders) \n\n5\n\n}) \n\n`\n\n## changeItemsOrdination(criteria, ascending, expectedOrderFormSections)\n\nChanges the sort order of the items based on the criteria (criteria) and an ascending parameter (ascending).\n\nThis causes a change in the `itemsOrdination` object of the `OrderForm` and also in the sort order of the objects in the `items` array.\n\n### Returns\n\n`Promise` for the orderForm.\n\n### Arguments\n\n| Name | Type |\n| --------- | ------------------------------------------------------ |\n| criteria | String name or add\\_time |\n| ascending | Boolean. True for increasing and false for decreasing. |\n\n### Example\n\n`1\n\nvar criteria = \"add_time\" \n\n2\n\nvar asceding = \"false\" \n\n3\n\nvtexjs.checkout \n\n4\n\n .changeItemsOrdination(criteria, ascending) \n\n5\n\n .then(function(orderForm) { \n\n6\n\n console.log(\"Sorting criteria: \", orderForm.itemsOrdination) \n\n7\n\n console.log(\"Array of items sorted by criteria: \", orderForm.items) \n\n8\n\n }) \n\n`\n\n## replaceSKU(items, expectedOrderFormSections, splitItem)\n\nRemoves a SKU from a current item and replaces it with a new one.\n\n### Returns\n\n`Promise` for the orderForm.\n\n### Arguments\n\n| Name | Type |\n| --------- | ------------------------------------------------------------------------------------------------------------------------ |\n| items | Array object with the SKU to be removed in quantity 0 and the new SKU to be added. Must be wrapped in an array. |\n| splitItem | Boolean default: true. Indicates a separate item should be created if the items to be updated have attachments/services. |\n\n### Example\n\n`1\n\nvar items = [ \n\n2\n\n { \n\n3\n\n seller: \"1\", \n\n4\n\n quantity: 0, \n\n5\n\n index: 0, \n\n6\n\n }, \n\n7\n\n { \n\n8\n\n seller: \"1\", \n\n9\n\n quantity: 1, \n\n10\n\n id: \"2\", \n\n11\n\n }, \n\n12\n\n] \n\n13\n\n \n14\n\nvtexjs.checkout.replaceSKU(items).then(function(orderForm) { \n\n15\n\n console.log(\"New items: \", orderForm.items) \n\n16\n\n}) \n\n`\n\n## finishTransaction(orderGroupId, expectedOrderFormSections)\n\nTells the Checkout API to finish a transaction and go to the final URL (e.g. `order-placed`, `checkout`).\n\n### Returns\n\n`Promise` for the orderForm.\n\n### Arguments\n\n| Name | Type |\n| ---------------- | ----------------------------------------------------------------------------------- |\n| **orderGroupId** | Number. ID of the order to be created after finishing the checkout process.\\*\\*\\*\\* |\n\n### Example\n\n`1\n\nvar orderGroupId = \"959290226406\" \n\n2\n\n \n3\n\nvtexjs.checkout.finishTransaction(orderGroupId).then(function(response) { \n\n4\n\n console.log(\"Success\", response.status) \n\n5\n\n}) \n\n`\n\nContributors\n\n2\n\n[](https://github.com/GeorgeLimaDev)\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-checkout.md)\n\n[vtex.js« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout//docs/guides/vtexjs)[vtex.js for CatalogNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout//docs/guides/vtexjs-for-catalog)\n\nContributors\n\n2\n\n[](https://github.com/GeorgeLimaDev)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Behavior of successive API requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23behavior-of-successive-api-requests)\n\n[Events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23events)\n\n[orderFormUpdated.vtex \\[orderForm\\]](https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout#orderformupdatedvtex-orderform)[checkoutRequestBegin.vtex \\[ajaxOptions\\]](https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout#checkoutrequestbeginvtex-ajaxoptions)[checkoutRequestEnd.vtex \\[orderForm|jqXHR\\]](https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout#checkoutrequestendvtex-orderformjqxhr)\n\n[expectedOrderFormSections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23expectedorderformsections)\n\n[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[getOrderForm(expectedOrderFormSections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23getorderformexpectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[sendAttachment(attachmentId, attachment, expectedOrderFormSections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23sendattachmentattachmentid-attachment-expectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23examples)\n\n[addToCart(items, expectedOrderFormSections, salesChannel)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23addtocartitems-expectedorderformsections-saleschannel)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[updateItems(items, expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23updateitemsitems-expectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[removeItems(items, expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23removeitemsitems-expectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[removeAllItems(expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23removeallitemsexpectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[cloneItem(itemIndex, newItemsOptions, expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23cloneitemitemindex-newitemsoptions-expectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[calculateShipping(address)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23calculateshippingaddress)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[simulateShipping(items, postalCode, country, salesChannel) \\[DEPRECATED\\]](https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout#simulateshippingitems-postalcode-country-saleschannel-deprecated)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[simulateShipping(shippingData, orderFormId, country, salesChannel)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23simulateshippingshippingdata-orderformid-country-saleschannel)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments\\*\\*](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[getAddressInformation(address)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23getaddressinformationaddress)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[getProfileByEmail(email, salesChannel)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23getprofilebyemailemail-saleschannel)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[removeAccountId(accountId, expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23removeaccountidaccountid-expectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[addDiscountCoupon(couponCode, expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23adddiscountcouponcouponcode-expectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[removeDiscountCoupon(expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23removediscountcouponexpectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[removeGiftRegistry(expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23removegiftregistryexpectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[addOffering(offeringId, itemIndex, expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23addofferingofferingid-itemindex-expectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[removeOffering(offeringId, itemIndex, expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23removeofferingofferingid-itemindex-expectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[addItemAttachment(itemIndex, attachmentName, content, expectedOrderFormSections, splitItem)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23additemattachmentitemindex-attachmentname-content-expectedorderformsections-splititem)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)[Possible errors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23possible-errors)\n\n[removeItemAttachment(itemIndex, attachmentName, content, expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23removeitemattachmentitemindex-attachmentname-content-expectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)\n\n[addBundleItemAttachment(itemIndex, bundleItemId, attachmentName, content, expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23addbundleitemattachmentitemindex-bundleitemid-attachmentname-content-expectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[removeBundleItemAttachment(itemIndex, bundleItemId, attachmentName, content, expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23removebundleitemattachmentitemindex-bundleitemid-attachmentname-content-expectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)\n\n[sendLocale(locale)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23sendlocalelocale)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[clearMessages(expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23clearmessagesexpectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[getLogoutURL()](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23getlogouturl)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[getOrders(orderGroupId)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23getordersordergroupid)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[changeItemsOrdination(criteria, ascending, expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23changeitemsordinationcriteria-ascending-expectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[replaceSKU(items, expectedOrderFormSections, splitItem)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23replaceskuitems-expectedorderformsections-splititem)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[finishTransaction(orderGroupId, expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23finishtransactionordergroupid-expectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%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-checkout.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Behavior of successive API requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23behavior-of-successive-api-requests)\n\n[Events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23events)\n\n[orderFormUpdated.vtex \\[orderForm\\]](https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout#orderformupdatedvtex-orderform)[checkoutRequestBegin.vtex \\[ajaxOptions\\]](https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout#checkoutrequestbeginvtex-ajaxoptions)[checkoutRequestEnd.vtex \\[orderForm|jqXHR\\]](https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout#checkoutrequestendvtex-orderformjqxhr)\n\n[expectedOrderFormSections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23expectedorderformsections)\n\n[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[getOrderForm(expectedOrderFormSections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23getorderformexpectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[sendAttachment(attachmentId, attachment, expectedOrderFormSections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23sendattachmentattachmentid-attachment-expectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23examples)\n\n[addToCart(items, expectedOrderFormSections, salesChannel)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23addtocartitems-expectedorderformsections-saleschannel)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[updateItems(items, expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23updateitemsitems-expectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[removeItems(items, expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23removeitemsitems-expectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[removeAllItems(expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23removeallitemsexpectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[cloneItem(itemIndex, newItemsOptions, expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23cloneitemitemindex-newitemsoptions-expectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[calculateShipping(address)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23calculateshippingaddress)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[simulateShipping(items, postalCode, country, salesChannel) \\[DEPRECATED\\]](https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout#simulateshippingitems-postalcode-country-saleschannel-deprecated)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[simulateShipping(shippingData, orderFormId, country, salesChannel)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23simulateshippingshippingdata-orderformid-country-saleschannel)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments\\*\\*](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[getAddressInformation(address)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23getaddressinformationaddress)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[getProfileByEmail(email, salesChannel)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23getprofilebyemailemail-saleschannel)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[removeAccountId(accountId, expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23removeaccountidaccountid-expectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[addDiscountCoupon(couponCode, expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23adddiscountcouponcouponcode-expectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[removeDiscountCoupon(expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23removediscountcouponexpectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[removeGiftRegistry(expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23removegiftregistryexpectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[addOffering(offeringId, itemIndex, expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23addofferingofferingid-itemindex-expectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[removeOffering(offeringId, itemIndex, expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23removeofferingofferingid-itemindex-expectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[addItemAttachment(itemIndex, attachmentName, content, expectedOrderFormSections, splitItem)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23additemattachmentitemindex-attachmentname-content-expectedorderformsections-splititem)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)[Possible errors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23possible-errors)\n\n[removeItemAttachment(itemIndex, attachmentName, content, expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23removeitemattachmentitemindex-attachmentname-content-expectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)\n\n[addBundleItemAttachment(itemIndex, bundleItemId, attachmentName, content, expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23addbundleitemattachmentitemindex-bundleitemid-attachmentname-content-expectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[removeBundleItemAttachment(itemIndex, bundleItemId, attachmentName, content, expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23removebundleitemattachmentitemindex-bundleitemid-attachmentname-content-expectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)\n\n[sendLocale(locale)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23sendlocalelocale)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[clearMessages(expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23clearmessagesexpectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[getLogoutURL()](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23getlogouturl)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[getOrders(orderGroupId)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23getordersordergroupid)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[changeItemsOrdination(criteria, ascending, expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23changeitemsordinationcriteria-ascending-expectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[replaceSKU(items, expectedOrderFormSections, splitItem)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23replaceskuitems-expectedorderformsections-splititem)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23example)\n\n[finishTransaction(orderGroupId, expectedOrderFormSections)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23finishtransactionordergroupid-expectedorderformsections)\n\n[Returns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23returns)[Arguments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%23arguments)[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexjs-for-checkout/docs/guides/vtexjs-for-checkout%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_7945fc32
|
[
{
"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 using flex layout 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-using-flex-layout/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-using-flex-layout/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout/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-using-flex-layout/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-using-flex-layout/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout/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-using-flex-layout/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-using-flex-layout/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/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-using-flex-layout/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout/docs/guides/store-framework)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout/docs/guides/store-framework-using-advanced-layouts)\n\n[Using Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout/docs/guides/vtex-io-documentation-using-flex-layout)\n\nUsing Flex Layout\n\nSince [**Flex Layout**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout) is a structure that allows the construction of custom layouts according to the concept of **rows** and **columns**, it basically can be used to build any desired store page.\n\nIn this recipe, we will learn how to use it in a practical case, building an **About Us** page from scratch just as the one below:\n\n\n\nIf we think on how we could divide this page layout, we realize that it could be easily thought of as a \"one row with two columns\" model:\n\n\n\nTo achieve the layout shown above, we must use the `flex-layout.row` and `flex-layout.col` blocks, which are going to define each row and column in the page layout and their children blocks.\n\n## Declaring the `flex-layout.row`\n\nFirst, let's declare (in the `blocks` folder or `blocks.jsonc` file) the main block for the entire About Us page:\n\n`1\n\n\"store.custom#about-us\": { \n\n2\n\n \"blocks\": [ \n\n3\n\n \"flex-layout.row#about-us\" \n\n4\n\n ] \n\n5\n\n}, \n\n`\n\nAs you can see, the `store.custom#about-us` block consists of a single `flex-layout.row` block, because it is always the highest order block in the `flex-layout`. You should never use the `flex-layout` block directly.\n\n## Defining the `flex-layout.row` and declaring the `flex-layout.col`\n\nNow that we declared that we are going to use `flex-layout.row#about-us`, let's in fact define it:\n\n`1\n\n\"store.custom#about-us\": { \n\n2\n\n \"blocks\": [ \n\n3\n\n \"flex-layout.row#about-us\" \n\n4\n\n ] \n\n5\n\n}, \n\n6\n\n\"flex-layout.row#about-us\": { \n\n7\n\n \"children\": [ \n\n8\n\n \"image#mobile-phone\", \n\n9\n\n \"flex-layout.col#text-about-us\" \n\n10\n\n ] \n\n11\n\n}, \n\n`\n\n> The `flex-layout.row#about-us` block is going to display its child dependencies in an interface, from left to right, one after the other.\n\nAs shown above, the `flex-layout.row#about-us` was declared with two child blocks, one of them being an `image` and the other a `flex-layout.col` block. Both `flex-layout` blocks only accept blocks allowed by their parent.\n\n## Defining the `flex-layout.col`\n\nLet's define our `flex-layout.col#text-about-us` block:\n\n`1\n\n\"store.custom#about-us\": { \n\n2\n\n \"blocks\": [ \n\n3\n\n \"flex-layout.row#about-us\" \n\n4\n\n ] \n\n5\n\n}, \n\n6\n\n\"flex-layout.row#about-us\": { \n\n7\n\n \"children\": [ \n\n8\n\n \"image#mobile-phone\", \n\n9\n\n \"flex-layout.col#text-about-us\" \n\n10\n\n ] \n\n11\n\n}, \n\n12\n\n\"flex-layout.col#text-about-us\": { \n\n13\n\n \"children\": [ \n\n14\n\n \"rich-text#title-about-us\", \n\n15\n\n \"rich-text#about-us\" \n\n16\n\n ], \n\n17\n\n \"props\": { \n\n18\n\n \"blockClass\": \"textColumn\", \n\n19\n\n \"preventVerticalStretch\": true \n\n20\n\n } \n\n21\n\n}, \n\n`\n\n> The `flex-layout.col#text-about-us` block is going to display its child dependencies in an interface, from top to bottom, one after the other.\n\nThe `preventVerticalStretch` prop prevents the column from occupying 100% of its parent's height when set as `true`. You can use other custom row props, which can be found in the [Flex Layout documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-flex-layout/).\n\n### Final results\n\nHere is the final `about-us.json` file using Flex Layout:\n\n`1\n\n{ \n\n2\n\n \"store.custom#about-us\": { \n\n3\n\n \"blocks\": [\"flex-layout.row#about-us\"] \n\n4\n\n }, \n\n5\n\n \"flex-layout.row#about-us\": { \n\n6\n\n \"children\": [\"image#mobile-phone\", \"flex-layout.col#text-about-us\"] \n\n7\n\n }, \n\n8\n\n \"flex-layout.col#text-about-us\": { \n\n9\n\n \"children\": [\"rich-text#title-about-us\", \"rich-text#about-us\"], \n\n10\n\n \"props\": { \n\n11\n\n \"blockclass\": \"textColumn\", \n\n12\n\n \"preventVerticalStretch\": true \n\n13\n\n } \n\n14\n\n }, \n\n15\n\n \"rich-text#title-about-us\": { \n\n16\n\n \"props\": { \n\n17\n\n \"text\": \"# Create meaningful and relevant experiences.\", \n\n18\n\n \"blockClass\": \"title\" \n\n19\n\n } \n\n20\n\n }, \n\n21\n\n \"image#mobile-phone\": { \n\n22\n\n \"props\": { \n\n23\n\n \"src\": \"https://storecomponents.vteximg.com/files/mobile-phone.png\", \n\n24\n\n \"maxHeight\": \"\", \n\n25\n\n \"maxWidth\": \"\", \n\n26\n\n \"blockClass\": \"storePrint\" \n\n27\n\n } \n\n28\n\n }, \n\n29\n\n \"rich-text#about-us\": { \n\n30\n\n \"props\": { \n\n31\n\n \"text\": \"**Optimized store framework** \\n Free your frontend with our React + Node store framework. Improve usability and SEO, while increasing conversion with modular components, single-page applications, and a ready-for-PWA structure. \\n **Multi-currency and language** \\n Go international with multiple storefronts to support different languages and easily manage local currencies and payment conditions. \\n **Serverless development platform** \\n Reduce loading time, improve usability, and make the best out of SEO. Developing scalable components with a comprehensive, easy-to-use toolset, you can build stores faster than ever.\", \n\n32\n\n \"blockClass\": \"about\" \n\n33\n\n } \n\n34\n\n } \n\n35\n\n} \n\n`\n\n## Rules and recommendations\n\n* Each row and column can have as **many levels as needed**.\n* When creating levels, it is necessary to **alternate between rows and columns**. Within a row, you can only place columns, and within columns, only rows.\n* Be mindful about the structure that you set in your flex layout does not only affect your code organization, but also reflects in the way that blocks will be shown and managed through the Site Editor admin. Therefore, it is always important to **take the organization of both code and Site Editor into account when planning to apply the Flex Layout** onto a page.\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-using-flex-layout.md)\n\n[Rendering a badge on top of a product« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout//docs/guides/vtex-io-documentation-rendering-a-badge)[Working with Site EditorNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout//docs/guides/store-framework-working-with-site-editor)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Declaring the flex-layout.row](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout/docs/guides/vtex-io-documentation-using-flex-layout%23declaring-the-flex-layoutrow)\n\n[Defining the flex-layout.row and declaring the flex-layout.col](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout/docs/guides/vtex-io-documentation-using-flex-layout%23defining-the-flex-layoutrow-and-declaring-the-flex-layoutcol)\n\n[Defining the flex-layout.col](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout/docs/guides/vtex-io-documentation-using-flex-layout%23defining-the-flex-layoutcol)\n\n[Final results](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout/docs/guides/vtex-io-documentation-using-flex-layout%23final-results)\n\n[Rules and recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout/docs/guides/vtex-io-documentation-using-flex-layout%23rules-and-recommendations)\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-using-flex-layout.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Declaring the flex-layout.row](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout/docs/guides/vtex-io-documentation-using-flex-layout%23declaring-the-flex-layoutrow)\n\n[Defining the flex-layout.row and declaring the flex-layout.col](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout/docs/guides/vtex-io-documentation-using-flex-layout%23defining-the-flex-layoutrow-and-declaring-the-flex-layoutcol)\n\n[Defining the flex-layout.col](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout/docs/guides/vtex-io-documentation-using-flex-layout%23defining-the-flex-layoutcol)\n\n[Final results](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout/docs/guides/vtex-io-documentation-using-flex-layout%23final-results)\n\n[Rules and recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout/docs/guides/vtex-io-documentation-using-flex-layout%23rules-and-recommendations)\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_22597789
|
[
{
"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 recommendations bff 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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-api/docs/api-reference/recommendations-bff-api/)\n\nEvents\n\nRecommendations\n\nUsers\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-api/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/recommendations-bff-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/recommendations-bff-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/recommendations-bff-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/recommendations-bff-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/recommendations-bff-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-api/docs/api-reference/recommendations-bff-api/)\n\nEvents\n\nRecommendations\n\nUsers\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-api/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-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/recommendations-bff-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[PoCreate a review« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/recommendations-bff-api/docs/api-reference/reviews-and-ratings-api%23post-/reviews-and-ratings/api/review)[PoRecommendation viewNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/recommendations-bff-api/docs/api-reference/recommendations-bff-api%23post-/api/recommend-bff/v2/events/recommendation-view)\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_724a7c12
|
[
{
"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 marketplace protocol external marketplace mapper 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/marketplace-protocol-external-marketplace-mapper/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/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/marketplace-protocol-external-marketplace-mapper/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[Anti-fraud Provider APINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper/docs/api-reference/antifraud-provider-protocol)\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_a96b205e
|
[
{
"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 context 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-context/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-context/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-context/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-context/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-context/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-context/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-context/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-context/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/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-context/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.checkout-ui-custom)\n\n[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.messages)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/guides/affiliates-program-app)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/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-context/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-context/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-context/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/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-context/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/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-context/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.checkout-ui-custom)\n\n[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.messages)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/guides/affiliates-program-app)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/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-context/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-context/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-context/docs/vtex-io-apps)\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/guides/functional-apps)\n\nProduct Context\n\nOfficial extension\n\nVersion: 0.10.1\n\nLatest version: 0.10.1\n\n[](#contributors-)\n\nThe Product Context app is designed to provide essential product data to all child blocks within your store theme.\n\n## Configuration\n\n1. Add the `product-context` app as a dependency to your store theme's `manifest.json` file: \nmanifest.json \n`1 \n \"dependencies\": { \n2 \n+ \"vtex.product-context\": \"0.x\" \n3 \n } \n`\n2. Install the TypeScript types exported by the app by running the following command: \n`1 \nvtex setup \n`\n\nNow, you're ready to import components and hooks from the app. Check this example component that displays the product name using data stored in the nearest `ProductContext`:\n\n`1\n\n// Notice that this is TypeScript, and this code should be in a .tsx file \n\n2\n\nimport React, { FC } from 'react' \n\n3\n\nimport { useProduct } from 'vtex.product-context' \n\n4\n\n \n5\n\nconst MyComponent: FC = () => { \n\n6\n\n const productContextValue = useProduct(); \n\n7\n\n \n8\n\n return ( \n\n9\n\n <Fragment> \n\n10\n\n {productContextValue?.product?.productName} \n\n11\n\n </Fragment> \n\n12\n\n ) \n\n13\n\n} \n\n14\n\n \n15\n\nexport default MyComponent \n\n`\n\n## Hooks\n\n### `useProduct`\n\nThe `useProduct` hook allows your app to retrieve data from the nearest `ProductContext` relative to its caller. Expect an object with the structure below as the return value:\n\n`1\n\ninterface ProductContextState { \n\n2\n\n selectedItem?: Item | null \n\n3\n\n product: MaybeProduct \n\n4\n\n selectedQuantity: number \n\n5\n\n skuSelector: { \n\n6\n\n selectedImageVariationSKU: string | null \n\n7\n\n isVisible: boolean \n\n8\n\n areAllVariationsSelected: boolean \n\n9\n\n } \n\n10\n\n buyButton: BuyButtonContextState \n\n11\n\n assemblyOptions: { \n\n12\n\n items: Record<GroupId, AssemblyOptionItem[]> \n\n13\n\n inputValues: Record<GroupId, InputValues> \n\n14\n\n areGroupsValid: Record<GroupId, boolean> \n\n15\n\n } \n\n16\n\n} \n\n`\n\n> Note that if the hook is called outside a `ProductContextProvider`, the return value may be `undefined` or an empty object.\n\n### `useProductDispatch`\n\nThe `useProductDispatch` hook provides a `dispatch` function to manipulate the nearest `ProductContext`. The function supports the following actions:\n\n* `SELECT_IMAGE_VARIATION`: Sets the value for the `skuSelector.selectedImageVariationSKU` property.\n* `SET_QUANTITY`: Sets the value for the `selectedQuantity` property.\n* `SKU_SELECTOR_SET_VARIATIONS_SELECTED`: Sets the value for the `skuSelector.areAllVariationsSelected` property.\n* `SET_BUY_BUTTON_CLICKED`: Sets the value for the `buyButton.clicked` property.\n* `SKU_SELECTOR_SET_IS_VISIBLE`: Sets the value for the `skuSelector.isVisible` property.\n* `SET_SELECTED_ITEM`: Sets the value for the `selectedItem` property.\n* `SET_ASSEMBLY_OPTIONS`: Sets the value for the `assemblyOptions` property.\n* `SET_PRODUCT`: Sets the value for the `product` property.\n* `SET_LOADING_ITEM`: Sets the value of whether a selected item is loading.\n\n[Messages GraphQL API« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.messages/messages-graphql-api)[Pickup point selectorNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtexbr.pickup-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[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.product-context%23configuration)\n\n[Hooks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.product-context%23hooks)\n\n[useProduct](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.product-context%23useproduct)[useProductDispatch](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-context/docs/apps/vtex.product-context%23useproductdispatch)\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_9670e99d
|
[
{
"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 product grid 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-product-grid/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-product-grid/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-product-grid/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-product-grid/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-product-grid/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-product-grid/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-product-grid/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-product-grid/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-product-grid/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/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-product-grid/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/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-product-grid/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-overview)\n\n[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-banner-text)\n\n[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-cart-sidebar)\n\n[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-empty-state)\n\n[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-filter-slider)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-filter)\n\n[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-hero)\n\n[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-image-gallery)\n\n[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-navbar-slider)\n\n[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-navbar)\n\n[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-newsletter)\n\n[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-out-of-stock)\n\n[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-payment-methods)\n\n[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-price-range)\n\n[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-product-grid)\n\n[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-product-shelf)\n\n[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-region-modal)\n\n[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-search-input)\n\n[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-shipping-simulation)\n\n[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/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-product-grid/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/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-product-grid/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-product-grid/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-product-grid/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-product-grid/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/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-product-grid/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-product-grid/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/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-product-grid/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-product-grid/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/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-product-grid/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/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-product-grid/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-overview)\n\n[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-banner-text)\n\n[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-cart-sidebar)\n\n[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-empty-state)\n\n[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-filter-slider)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-filter)\n\n[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-hero)\n\n[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-image-gallery)\n\n[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-navbar-slider)\n\n[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-navbar)\n\n[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-newsletter)\n\n[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-out-of-stock)\n\n[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-payment-methods)\n\n[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-price-range)\n\n[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-product-grid)\n\n[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-product-shelf)\n\n[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-region-modal)\n\n[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-search-input)\n\n[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-shipping-simulation)\n\n[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/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-product-grid/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/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-product-grid/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-product-grid/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-product-grid/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-product-grid/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/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-product-grid/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-product-grid/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-product-grid/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/components-index)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-overview)\n\nProductGrid\n\nLists the products available in the store.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/organisms/ProductGrid)\n\nThe `ProductGrid` is a section generally used on PLP pages to list the products available in the store.The `ProductGrid` is a compound of the following:\n\n* `ProductGrid`: wraps the product grid items.\n* `ProductGridItem`: wraps the product inside a list item.\n* `ProductCard`: the proposed child of a `ProductGridItem`.\n\nExample\n\nCode\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---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { ProductGrid, ProductGridItem } from \"@faststore/ui\"; \n\n`\n\nWe highly recommend using the [ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-card) as the direct child of the `ProductGridItem`.\n\n`1\n\nimport { \n\n2\n\n ProductCard, \n\n3\n\n ProductCardContent, \n\n4\n\n ProductCardImage, \n\n5\n\n} from \"@faststore/ui\"; \n\n`\n\n### Import styles\n\nTo apply styles, include the following in your stylesheet:\n\n`1\n\n@import \"@faststore/ui/src/components/organisms/ProductGrid/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-product-grid-gap-mobile | var(--fs-grid-gap-0) |\n| \\--fs-product-grid-gap-tablet | var(--fs-product-grid-gap-mobile) |\n| \\--fs-product-grid-gap-desktop | var(--fs-grid-gap-2) |\n| \\--fs-product-grid-columns-mobile | 2 |\n| \\--fs-product-grid-columns-tablet | 4 |\n| \\--fs-product-grid-columns-desktop | var(--fs-product-grid-columns-tablet) |\n\n---\n\n## Data attributes\n\nYou can target and override `ProductGrid` styles using the following data attributes:`data-fs-product-grid`\n\n`data-fs-product-grid-item`\n\n---\n\n## Props\n\n### ProductGrid\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-product-grid |\n\n### ProductGridItem\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-product-grid-item |\n\n---\n\n## Best Practices\n\n### ✅ Do's\n\n* Respect `ProductGridItem` content's width considering the space available on the page.\n\n### ❌ Don'ts\n\n* Avoid using a lot of `ProductGridItem` on the same row, this could lead to unwanted horizontal scroll.\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 \nProductShelf \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/organisms-product-grid/docs/guides/faststore/organisms-product-shelf)\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/product-grid.mdx)\n\n[PriceRange« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-price-range)[ProductShelfNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-product-shelf)\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-product-grid/docs/guides/faststore/organisms-product-grid%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-product-grid%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-product-grid%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-product-grid%23design-tokens)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-product-grid%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-product-grid%23props)\n\n[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-product-grid%23productgrid)[ProductGridItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-product-grid%23productgriditem)\n\n[Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-product-grid%23best-practices)\n\n[✅ Do's](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-product-grid%23-dos)[❌ Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-product-grid%23-donts)\n\n[Related components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-product-grid%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/organisms/product-grid.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-product-grid/docs/guides/faststore/organisms-product-grid%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-product-grid%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-product-grid%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-product-grid%23design-tokens)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-product-grid%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-product-grid%23props)\n\n[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-product-grid%23productgrid)[ProductGridItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-product-grid%23productgriditem)\n\n[Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-product-grid%23best-practices)\n\n[✅ Do's](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-product-grid%23-dos)[❌ Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-product-grid%23-donts)\n\n[Related components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-grid/docs/guides/faststore/organisms-product-grid%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_f5b14cc0
|
[
{
"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 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-seller-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-seller-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-seller-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-seller-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-seller-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-seller-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-seller-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-seller-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-seller-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-seller-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-seller-integration-guide/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-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-seller-integration-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-guide/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-guide/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-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-seller-integration-guide/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-guide/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-guide/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-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-seller-integration-guide/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-guide/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-guide/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-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-seller-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-seller-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-seller-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-seller-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-seller-integration-guide/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-guide/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-guide/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-guide/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-guide/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-guide/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-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-seller-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-seller-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-seller-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-seller-integration-guide/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-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-seller-integration-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/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-guide/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-guide/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-guide/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-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-seller-integration-guide/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-guide/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-guide/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-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-seller-integration-guide/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-guide/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-guide/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-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-seller-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-seller-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-seller-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-seller-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-seller-integration-guide/docs/guides)\n\nIntegration Guides\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-guide/docs/guides/external-seller-integration-guide)\n\nExternal Seller\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 products from an external seller in your storefront**.\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-seller-integration-guide/external-seller-integration-guide.md)\n\n[How to update a canceled order’s status in VTEX« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-guide//docs/guides/external-marketplace-integration-canceled-orders)[Marketplace / Seller architectureNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-guide//docs/guides/external-seller-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-seller-integration-guide/external-seller-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_6c636544
|
[
{
"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 b2b suite 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-b2b-suite/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/guides/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/guides/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/guides/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/guides/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/guides/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/guides/vtex-b2b-suite/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-suite/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-suite/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-suite/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-suite/docs/apps/vtex.b2b-suite)\n\n[Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-suite/docs/apps/vtex.storefront-permissions)\n\n[Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-suite/docs/apps/vtex.storefront-permissions-ui)\n\n[B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-suite/docs/apps/vtex.b2b-organizations)\n\n[B2B Checkout Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/guides/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/guides/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/guides/vtex-b2b-suite/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-suite/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/guides/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/guides/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/guides/vtex-b2b-suite/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-suite/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-suite/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-suite/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-suite/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-suite/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/guides/vtex-b2b-suite/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-suite/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-suite/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-suite/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-suite/docs/apps/vtex.b2b-suite)\n\n[Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-suite/docs/apps/vtex.storefront-permissions)\n\n[Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-suite/docs/apps/vtex.storefront-permissions-ui)\n\n[B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-suite/docs/apps/vtex.b2b-organizations)\n\n[B2B Checkout Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/guides/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/guides/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/guides/vtex-b2b-suite/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-suite/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/guides/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/guides/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/guides/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/guides/vtex-b2b-suite/docs/apps/vtex.sku-list)[Storefront PermissionsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/guides/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/guides/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_1a707d4f
|
[
{
"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 tax services 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/tax-services-overview/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-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/tax-services-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/tax-services-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/tax-services-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/tax-services-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/tax-services-overview/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/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/tax-services-overview/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/tax-service-integration-guide)\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/tax-services-overview)\n\n[Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/tax-services-specification)\n\n[Recipe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/tax-services-recipe)\n\n[Tax Protocol GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/tax-protocol-graphql-api)\n\n[Reference Implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/tax-services-reference-implementation)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/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/tax-services-overview/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/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/tax-services-overview/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/tax-services-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/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/tax-services-overview/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/tax-service-integration-guide)\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/tax-services-overview)\n\n[Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/tax-services-specification)\n\n[Recipe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/tax-services-recipe)\n\n[Tax Protocol GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/tax-protocol-graphql-api)\n\n[Reference Implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/tax-services-reference-implementation)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/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/tax-services-overview/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/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/tax-services-overview/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/tax-services-overview/docs/guides)\n\nIntegration Guides\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/tax-service-integration-guide)\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/tax-services-overview)\n\nOverview\n\nSelling products online is subject to various types of taxes that can differ based on factors such as inventory location, shipping addresses, and, of course, the nature of the product. For certain stores, particularly those operating in a B2B model, tax calculations can become intricate and require an external tax calculation provider.\n\nIn such scenarios, it is possible to establish an integration that enables a store to send checkout information to an external tax calculation API and obtain a response from that API with the necessary tax details and values applicable to the purchase.\n\n\n\n## Implementation\n\nAccess the [specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-specification) and [recipe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-recipe) to learn more about Tax Service integration and how to implement it.\n\nContributors\n\n3\n\n[](https://github.com/karenkrieger)\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/tax-service-integration-guide/tax-services-overview.md)\n\n[Tax Service« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview//docs/guides/tax-service-integration-guide)[SpecificationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview//docs/guides/tax-services-specification)\n\nContributors\n\n3\n\n[](https://github.com/karenkrieger)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/tax-services-overview%23implementation)\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/tax-service-integration-guide/tax-services-overview.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-services-overview/docs/guides/tax-services-overview%23implementation)\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_917e0d82
|
[
{
"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 updating edition 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/vtex-io-documentation-updating-edition-apps/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-updating-edition-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/vtex-io-documentation-updating-edition-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/vtex-io-documentation-updating-edition-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/vtex-io-documentation-updating-edition-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/vtex-io-documentation-updating-edition-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/vtex-io-documentation-updating-edition-apps/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-updating-edition-apps/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-updating-edition-apps/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-updating-edition-apps/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-updating-edition-apps/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-updating-edition-apps/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/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-updating-edition-apps/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-updating-edition-apps/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-updating-edition-apps/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-updating-edition-apps/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-updating-edition-apps/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/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-updating-edition-apps/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-updating-edition-apps/docs/guides/managing-edition-apps)\n\n[Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/vtex-io-documentation-edition-app)\n\n[Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/vtex-io-documentation-sponsor-account)\n\n[Becoming a Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/vtex-io-documentation-becoming-a-sponsor-account)\n\n[Developing an Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/vtex-io-documentation-configuring-an-edition-app)\n\n[Updating Edition apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/vtex-io-documentation-updating-edition-apps)\n\n[Seller Portal Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/seller-portal-edition-app)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/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-updating-edition-apps/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/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-updating-edition-apps/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-updating-edition-apps/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-updating-edition-apps/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-updating-edition-apps/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-updating-edition-apps/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/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-updating-edition-apps/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-updating-edition-apps/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-updating-edition-apps/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-updating-edition-apps/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-updating-edition-apps/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/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-updating-edition-apps/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-updating-edition-apps/docs/guides/managing-edition-apps)\n\n[Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/vtex-io-documentation-edition-app)\n\n[Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/vtex-io-documentation-sponsor-account)\n\n[Becoming a Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/vtex-io-documentation-becoming-a-sponsor-account)\n\n[Developing an Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/vtex-io-documentation-configuring-an-edition-app)\n\n[Updating Edition apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/vtex-io-documentation-updating-edition-apps)\n\n[Seller Portal Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/seller-portal-edition-app)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/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-updating-edition-apps/docs/app-development)\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/managing-edition-apps)\n\n[Updating Edition apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/vtex-io-documentation-updating-edition-apps)\n\nUpdating Edition apps\n\nLearn how to publish a new version of an Edition app.\n\nThis guide explains how to release a new version of an [Edition app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app) by defining new required apps for child accounts or by changing the Edition's initial settings.\n\n## Before you begin\n\nBefore proceeding, ensure you are a [Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account) and have already [configured an Edition app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app).\n\n## Instructions\n\n1. Open your Edition app's folder and access the `apps.json` file using your preferred code editor.\n2. Make the desired changes to the apps and settings in the file. \n> Be aware that if you add an app to the Edition that is already installed on a child account, the app's installation type changes to `edition`. You can no longer remove it from the accounts or change its major version, as the Edition now enforces it. Similarly, if you remove an app from `apps.json`, VTEX will automatically uninstall it from all child accounts using this Edition. If you still need the removed app in some child accounts, you must reinstall it manually in each of those accounts.\n3. Save and commit your changes.\n4. [Publish and deploy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app) the new Edition version.\n\n## Understanding the update process\n\nAfter you publish the new version, VTEX automatically updates the Edition in all associated accounts. This process runs asynchronously, periodically, and individually for each child account.\n\n> Note: VTEX only applies automatic updates for minor and patch version changes. If you release a new major version (a breaking change), you must update the Edition manually in each child account.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/managing-edition-apps/vtex-io-documentation-updating-edition-apps.md)\n\n[Developing an Edition App« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps//docs/guides/vtex-io-documentation-configuring-an-edition-app)[Seller Portal Edition AppNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps//docs/guides/seller-portal-edition-app)\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-updating-edition-apps/docs/guides/vtex-io-documentation-updating-edition-apps%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/vtex-io-documentation-updating-edition-apps%23instructions)\n\n[Understanding the update process](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/vtex-io-documentation-updating-edition-apps%23understanding-the-update-process)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/managing-edition-apps/vtex-io-documentation-updating-edition-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/vtex-io-documentation-updating-edition-apps/docs/guides/vtex-io-documentation-updating-edition-apps%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/vtex-io-documentation-updating-edition-apps%23instructions)\n\n[Understanding the update process](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps/docs/guides/vtex-io-documentation-updating-edition-apps%23understanding-the-update-process)\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_940484a4
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation becoming a registered vtex app store developer in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/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-io-documentation-becoming-a-registered-vtex-app-store-developer/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-io-documentation-becoming-a-registered-vtex-app-store-developer/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-io-documentation-becoming-a-registered-vtex-app-store-developer/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-io-documentation-becoming-a-registered-vtex-app-store-developer/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-io-documentation-becoming-a-registered-vtex-app-store-developer/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-io-documentation-becoming-a-registered-vtex-app-store-developer/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-io-documentation-becoming-a-registered-vtex-app-store-developer/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-io-documentation-becoming-a-registered-vtex-app-store-developer/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-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/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-io-documentation-becoming-a-registered-vtex-app-store-developer/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-io-documentation-becoming-a-registered-vtex-app-store-developer/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-io-documentation-becoming-a-registered-vtex-app-store-developer/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-io-documentation-becoming-a-registered-vtex-app-store-developer/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-io-documentation-becoming-a-registered-vtex-app-store-developer/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-io-documentation-becoming-a-registered-vtex-app-store-developer/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-io-documentation-becoming-a-registered-vtex-app-store-developer/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-io-documentation-becoming-a-registered-vtex-app-store-developer/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-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/app-development)\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/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-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer)\n\nBecoming a registered VTEX App Store developer\n\n[**VTEX App Store**](https://read.calvincode.net/reader?url=https://apps.vtex.com/) is a marketplace for VTEX IO plug-and-play solutions.\n\nAs a developer, you can share your own solutions with other VTEX users in the **VTEX App Store**, so they can also leverage them to grow their business.\n\nTo become a VTEX App Store seller, follow these steps:\n\n1. Express interest to our team.\n2. Sign a commercial agreement.\n3. Register as a VTEX App Store seller.\n\n## Instructions\n\n### Step 1 - Expressing your interest\n\nTo publish your application or integration on the VTEX App Store, complete the [Application form](https://read.calvincode.net/reader?url=https://vtex.com/us-en/partners/).\n\nThis form helps our team understand the best approach and prioritize publication requests.\n\n### Step 2 - Signing our commercial agreement\n\nIf the form is complete and the team agrees that the application is suitable for the VTEX App Store, the next step is to sign a commercial agreement with VTEX.\n\nThis contract, provided by the VTEX team, grants VTEX distribution rights over the app. Additionally, it enrolls your account in the VTEX [Partner Program](https://read.calvincode.net/reader?url=https://vtex.com/en-us/partners/) if you're not already a member.\n\n> The Partner Program provides access to a VTEX account, allowing you to test and develop new apps and receive tech support from the VTEX partner team.\n\n### Step 3 - Registering as a VTEX App Store seller\n\nThe App Store is a marketplace where developers who want to distribute their apps should register as sellers.\n\nThis [seller-marketplace configuration](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/configuring-the-marketplace-between-vtex-stores--tutorials%5F6520) is done through the `vtex.app-store-seller` app.\n\nFollow the steps below to register as a new seller on the VTEX App Store:\n\n1. In your terminal, log in to your VTEX account by running the `vtex login {accountName}` command. Replace the values between curly brackets with your account name.\n2. Run `vtex install vtex.app-store-seller@0.x` to install the `vtex.app-store-seller` app.\n3. Access the VTEX Admin of the account in which you're working.\n4. In `Installed apps`, go to `Seller setup` and complete the required fields.\n5. Select the sales channel you intend to use to connect to the App Store.\n6. Choose an affiliate ID made up of three consonants:\n\n\n\n\n\nAfter submitting your request to become a seller, you can track its status until it's approved by our team. This approval is required to publish your app successfully in the VTEX App Store.\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/App-Guides/vtex-app-store/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer.md)\n\n[VTEX App Store« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer//docs/guides/vtex-app-store)[Developing an appNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer//docs/guides/vtex-io-documentation-developing-an-app)\n\nSee also\n\n[Submitting your app to the VTEX App StoreApp Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store)\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-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer%23instructions)\n\n[Step 1 - Expressing your interest](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer%23step-1-expressing-your-interest)[Step 2 - Signing our commercial agreement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer%23step-2-signing-our-commercial-agreement)[Step 3 - Registering as a VTEX App Store seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer%23step-3-registering-as-a-vtex-app-store-seller)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/vtex-app-store/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer.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-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer%23instructions)\n\n[Step 1 - Expressing your interest](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer%23step-1-expressing-your-interest)[Step 2 - Signing our commercial agreement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer%23step-2-signing-our-commercial-agreement)[Step 3 - Registering as a VTEX App Store seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer%23step-3-registering-as-a-vtex-app-store-seller)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_0a40bf79
|
[
{
"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 promotions 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/promotions-overview/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-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/promotions-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/promotions-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/promotions-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/promotions-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/promotions-overview/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/getting-started)\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/catalog-overview)\n\n[Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/marketplace-overview)\n\n[Orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/orders-overview)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/checkout-overview)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/payments-overview)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/fulfillment)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/search-overview)\n\n[Pricing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/pricing-overview)\n\n[Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/promotions-overview)\n\n[Subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/subscriptions)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/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/promotions-overview/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/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/promotions-overview/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/promotions-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/getting-started)\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/catalog-overview)\n\n[Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/marketplace-overview)\n\n[Orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/orders-overview)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/checkout-overview)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/payments-overview)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/fulfillment)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/search-overview)\n\n[Pricing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/pricing-overview)\n\n[Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/promotions-overview)\n\n[Subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/subscriptions)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/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/promotions-overview/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/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/promotions-overview/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/promotions-overview/docs/guides)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/getting-started)\n\n[Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/promotions-overview)\n\nPromotions\n\n> **Help us improve our documentation!** Tell us about your experience with this article by filling out [this form](https://read.calvincode.net/reader?url=https://forms.gle/fQoELRA1yfKDqmAb8).\n\nThe Promotions module is the place where the configuration of promotions and fees applied to your online store is carried out. Here, you can also create coupons to be associated to promotions. According to the configuration, a promotion can be scheduled, enabled or disabled and, after its creation, it can also be found through search or filter tools, and filed.\n\nThis overview article goes over what you can accomplish with the VTEX Promotions and Taxes module, including relevant links to our developer documentation about this topic.\n\n## Understanding Promotions' module in VTEX\n\nA [promotion](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/promocoes--6asfF1vFYiZgTQtOzwJchR) is a discount granted to the customer. It may be associated with one or more products, with shipping or with a trade policy. At VTEX, the retailer can create a number of rules that, depending on the context of the purchase, will define whether and how the discount will be applied.\n\nIn addition, there are six types of promotions:\n\n* [Regular](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/promocoes--6asfF1vFYiZgTQtOzwJchR/7FjbeZdE2KMwk5L1t98pZI)\n* [Buy Together](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/compre-junto--tutorials%5F323)\n* [More For Less](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/leve-mais-por-menos--tutorials%5F325)\n* [Progressive Discount](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/desconto-progressivo--tutorials%5F324)\n* [Buy One Get One](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/compre-e-ganhe--tutorials%5F322)\n* [Campaign Benefit](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/promocao-de-campanha--1ChYXhK2AQGuS6wAqS8Ume)\n\nThe [coupon](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/promocoes--6asfF1vFYiZgTQtOzwJchR/6RU676Ot6K15ZT1aJA8NRW) is a code entered in the cart by the customer. It grants a discount on the price of the purchase. To make a coupon available for use, you need to associate the coupon to a Promotion. To be valid, the coupon has to be associated with a promotion, and a single coupon can be associated with one or more promotions. But there’s a quantity limit to the active coupons.\n\n[Campaign audience](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/audiencias-de-campanhas--3o7lhpNseXY2WmjZO0gQ6m) is a feature that allows you to define the target audience for promotions, the feature consists of creating criteria for segmenting customers. You can only apply a campaign audience if it is associated with one or more campaign promotions.\n\nUsing the Promotions API allows you to manage and retrieve all promotions, coupons and campaign audience from your VTEX store.\n\nRetrieving promotions' information\n\nA VTEX store can have different types of promotions for different kinds of trade policy. To retrieve information about your VTEX store promotions, access the available API.\n\n* [Get All Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getallbenefits)\n[ ](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getallbenefits)\n* [](https://developers.vtex.com/vtex-rest-api/reference/getallbenefits)[Get Promotion or Tax By ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getcalculatorconfigurationbyid)\n[ ](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getcalculatorconfigurationbyid)\n* [](https://developers.vtex.com/vtex-rest-api/reference/getcalculatorconfigurationbyid)[List archived Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getarchivedpromotions)\n[ ](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getarchivedpromotions)\n\n### Managing your promotions\n\nThere are several actions a VTEX store can perform on promotions. In the next sections, you will find the main actions related to a store’s promotion management routine.\n\nCreating promotions or taxes\n\nVTEX offers different types of promotions, you can create a promotion or tax, create multiple promotions by SKU and change the settings and data of any promotion using the APIs.\n\n* [Create or Update Promotion or Tax](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/createorupdatecalculatorconfiguration)\n\nUpdating promotions with multiple SKUs \n\nTo update information from a Multiple SKU Promotion.\n\n* [Update Multiple SKU Promotion](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/put%5Fapi-rnb-pvt-import-calculatorconfiguration-promotionid)\n\nArchiving/Unarchiving promotions or taxes\n\nIf you no longer want a promotion to be used, you can move it to the list of archived promotions or unarchiving if you want to use it. You cannot delete a promotion, only archive it. \n\n* [Archive Promotion or Tax](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/archivepromotion-1)\n[ ](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/archivepromotion-1)\n* [](https://developers.vtex.com/vtex-rest-api/reference/archivepromotion-1)[Archive Promotion or Tax](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/archivepromotion-1)\n[ ](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/archivepromotion-1)\n\n### Coupons\n\nCoupons cannot be deleted, only archived. It is important to emphasize that you can only archive one coupon at a time. You can edit and reuse a coupon, but the coupon code can not be modified.\n\nThere is a limited quantity of active coupons. Coupon reuse is highly recommended since a high number of coupons may compromise the Promotions & Taxes performance.\n\nIf you try to create a coupon with an existing coupon code, the API will update the existing coupon.\n\nGetting coupons\n\nYou can create one coupon or multiple coupons at a time.\n\n* [Create coupon](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/post%5Fapi-rnb-pvt-coupon)\n* [Create multiple coupons](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/post%5Fapi-rnb-pvt-multiple-coupons)\n* [Coupon Massive Generation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/massivegeneration)\n\nRetrieving coupon information\n\nYou perform different actions to retrieve coupon information.\n\n* [Get coupon by coupon code](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getbycouponcode)\n* [Get archived coupon by coupon code](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getarchivedbycouponcode)\n* [Get coupon usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getusage)\n* [Get all coupons](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getusage)\n\nArchiving/Unarchiving coupons\n\nYou cannot delete coupons, only archive or unarchive them.\n\n* [Archive coupon by coupon code](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/archivebycouponcode)\n* [Unarchive coupon by coupon code](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/unarchivebycouponcode)\n\nUpdating coupons\n\nCoupons can be updated as you wish.\n\n* [Update coupon](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/update)\n[ ](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/update)\n\n### Campaign Audiences\n\nTo activate the newly created campaign audience, you must associate it to a [Campaign promotion](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/campaign-promotion--1ChYXhK2AQGuS6wAqS8Ume).\n\nCreating campaign audiences\n\nYou can create campaign audiences to segment your store's promotions based on defining target audiences meeting specific criteria.\n\n* [Create campaign audience](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/setcampaignconfiguration)\n\nRetrieving campaign audience information\n\nYou can retrieve campaign audience information using the following APIs.\n\n* [Get campaign audience configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getcampaignconfiguration)\n* [Get all campaign audiences](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getcampaignaudiences)\n\n### Policy Engine\n\nThe Policy Engine API creates [promotion alarms](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/using-policy-engine-api-on-promotion-alerts) when selling products with undesired prices and promotions. It will create conditions that will check if the prices and the promotions are correct.\n\nIf not, the system will alert the store by email with information about the product sold at unexpected prices.\n\nCreating a promotion alert\n\nTo create a new promotion alert, you should use this API.\n\n* [Create Policy](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/policy%5Fcreateorupdate)\n\nRetrieving policy engine information\n\nYou can retrieve policy engine information using the following APIs.\n\n* [Get Policy by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/policies-system-api/%23get-/api/policy-engine/policies/-id-)\n* [Get Policy List](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/policy%5Flist)\n\nEvaluating policies\n\nConsult and verify all policies that meet the conditions in the request body.\n\n* [Evaluate Policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/policy%5Fevaluate)\n\nUpdating an existing policy\n\nTo update an existing promotion alert, you should use this API.\n\n* [Update Policy](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/put%5Fapi-policy-engine-policies-id)\n\nDeleting a policy\n\nTo delete an existing promotion alert, you should use this API.\n\n* [Delete Policy by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/policy%5Fdelete)\n\n## Surcharges\n\nA [surcharge](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/promocoes--6asfF1vFYiZgTQtOzwJchR/3DcO1XrLqlbZsq80zxSgZS) is the opposite of a promotion, that is, it is an additional percentage added to the product price in order to increase the value. A surcharge can be configured on the basis of a range of conditions, such as postal code (CEP) range, department, the brand of the products, the customer cluster, and so on. The surcharge is added only in the shopping cart, in the area marked Tax.\n\nThe surcharge is applied in accordance with the registration done on the seller. So if your store’s shopping cart has another seller’s product, the surcharge to be applied to that product will be the one registered on the admin of the seller that owns the product. Surcharges registered in the [Pricing module](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/pricing-overview) will not be taken into account, even if this surcharge is associated with this product.\n\nRetrieving Surcharges/Taxes information\n\nTo retrieve information about your VTEX store taxes, access the available API\n\n* [Get All Taxes](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getalltaxes)\n[ ](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getalltaxes)\n* [](https://developers.vtex.com/vtex-rest-api/reference/getalltaxes)[List Archived Taxes](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getarchivedtaxes)\n[ ](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getarchivedtaxes)\n\n[Contributors](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getarchivedtaxes)\n\n[2](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getarchivedtaxes)\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/Getting-Started/promotions-overview.md)\n\n[Pricing« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview//docs/guides/pricing-overview)[SubscriptionsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview//docs/guides/subscriptions)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Understanding Promotions' module in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/promotions-overview%23understanding-promotions-module-in-vtex)\n\n[Managing your promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/promotions-overview%23managing-your-promotions)[Coupons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/promotions-overview%23coupons)[Campaign Audiences](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/promotions-overview%23campaign-audiences)[Policy Engine](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/promotions-overview%23policy-engine)\n\n[Surcharges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/promotions-overview%23surcharges)\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/promotions-overview.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Understanding Promotions' module in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/promotions-overview%23understanding-promotions-module-in-vtex)\n\n[Managing your promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/promotions-overview%23managing-your-promotions)[Coupons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/promotions-overview%23coupons)[Campaign Audiences](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/promotions-overview%23campaign-audiences)[Policy Engine](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/promotions-overview%23policy-engine)\n\n[Surcharges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/promotions-overview/docs/guides/promotions-overview%23surcharges)\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_395f2dfa
|
[
{
"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 access control list 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/access-control-list/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/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/access-control-list/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/access-control-list/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/access-control-list/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/access-control-list/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/access-control-list/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/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/access-control-list/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/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/access-control-list/docs/guides/how-search-parameters-work)\n\n[Search Control – fulltextSearchBox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/search-control-fulltextsearchbox)\n\n[Consult store search terms information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/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/access-control-list/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/access-control-list/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/access-control-list/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/access-control-list/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/access-control-list/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/access-control-list/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/access-control-list/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/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/access-control-list/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/access-control-list/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/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/access-control-list/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/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/access-control-list/docs/guides/how-search-parameters-work)\n\n[Search Control – fulltextSearchBox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/search-control-fulltextsearchbox)\n\n[Consult store search terms information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/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/access-control-list/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/access-control-list/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/access-control-list/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/access-control-list/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/access-control-list/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/access-control-list/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/access-control-list/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/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/access-control-list/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/access-control-list/docs/guides)\n\nSearch\n\n[Access Control List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/access-control-list)\n\nAccess Control List\n\nBy default, all VTEX stores are configured to display all available products during every navigation session. The Access Control List feature allows you to create a list of users that can or cannot access specific products in the store.\n\n## Creating a specification\n\nTo configure the Access Control List, you must first create one of the following product specifications either through [Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications) or on [VTEX Admin](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/adding-specifications-or-product-fields--tutorials%5F106) and set their values, which represent groups of customers that can be set on Master Data. All values for both specifications must be separated by `;` (i.e.: `1;2;3`).\n\n| Specification name | Example values | Description |\n| ------------------ | -------------- | ------------------------------------------------------------------------------- |\n| \\_blocklist | 1;2;3 | Blocklist: Restricts product visibility based on the defined navigation values. |\n| \\_allowlist | 1;2;3 | Allowlist: Enables product visibility based on the defined navigation values. |\n\n> Do not set both specifications at the same time for the same product, otherwise the product will not be displayed in any scenario. Read [Behavior](#behavior) for more information.\n\nAfter creating the product specification, Intelligent Search automatically triggers a reindexing process to update the values in the search database.\n\n## Defining segmented navigation\n\nTo define segmented navigation, you must configure the `accesscontrollist` facet on the [vtex-segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-segmenting-the-search-result) app. For example, `acesscontrollist:1` can define navigation for a customer, where a certain product will not be displayed in the search results.\n\n`1\n\nquery { \n\n2\n\n productSearch( \n\n3\n\n selectedFacets: [ \n\n4\n\n {key: \"trade-policy\", value: \"1\"}, \n\n5\n\n {key: \"accesscontrollist\", value: \"1\"} \n\n6\n\n ] \n\n7\n\n ) \n\n8\n\n { \n\n9\n\n products { \n\n10\n\n productId, \n\n11\n\n productName \n\n12\n\n } \n\n13\n\n } \n\n14\n\n} \n\n`\n\n### Behavior\n\nWherever the `accesscontrollist` facet is present, `_blocklist` and `_allowlist` can be applied to each product and result in one of the following scenarios:\n\n| \\_blocklist | \\_allowlist | Result |\n| ---------------------------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------------- |\n| Empty value or nonexistent specification | Empty value or nonexistent specification | The product will always be visible. |\n| Defined value | Empty value or nonexistent specification | The product will be visible unless the accesscontrollist value is included in \\_blocklist. |\n| Empty value or nonexistent specification | Defined value | The product will be visible only if the accesscontrollist value is included in \\_allowlist. |\n| Defined value | Defined value | The product will not be visible to anyone. This is an invalid scenario. |\n\nContributors\n\n1\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/access-control-list.md)\n\n[Segmenting the search result« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list//docs/guides/vtex-io-documentation-segmenting-the-search-result)[Delivery promise for headless stores (Beta)Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list//docs/guides/delivery-promise-for-headless-stores)\n\nContributors\n\n1\n\n[](https://github.com/geisecosta)\n\nON THIS PAGE\n\n[Creating a specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/access-control-list%23creating-a-specification)\n\n[Defining segmented navigation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/access-control-list%23defining-segmented-navigation)\n\n[Behavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/access-control-list%23behavior)\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/access-control-list.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Creating a specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/access-control-list%23creating-a-specification)\n\n[Defining segmented navigation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/access-control-list%23defining-segmented-navigation)\n\n[Behavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/access-control-list/docs/guides/access-control-list%23behavior)\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_495cc47d
|
[
{
"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 identifying development errors and starter bugs 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-identifying-development-errors-and-starter-bugs/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-identifying-development-errors-and-starter-bugs/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-identifying-development-errors-and-starter-bugs/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-identifying-development-errors-and-starter-bugs/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-identifying-development-errors-and-starter-bugs/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-identifying-development-errors-and-starter-bugs/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-identifying-development-errors-and-starter-bugs/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/troubleshooting-identifying-development-errors-and-starter-bugs/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/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/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/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/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/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/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/troubleshooting-identifying-development-errors-and-starter-bugs/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/troubleshooting-identifying-development-errors-and-starter-bugs/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/troubleshooting-identifying-development-errors-and-starter-bugs/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/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/troubleshooting-overview)\n\n[Debugging Partytown and analytics issues](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/troubleshooting-analytics-and-partytown)\n\n[Identifying development errors and Starter bugs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs)\n\n[Tracing the error source](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/troubleshooting-tracing-the-error-source)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/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/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/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/troubleshooting-identifying-development-errors-and-starter-bugs/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/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/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/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/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/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/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/troubleshooting-identifying-development-errors-and-starter-bugs/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/troubleshooting-identifying-development-errors-and-starter-bugs/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/troubleshooting-identifying-development-errors-and-starter-bugs/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/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/troubleshooting-overview)\n\n[Debugging Partytown and analytics issues](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/troubleshooting-analytics-and-partytown)\n\n[Identifying development errors and Starter bugs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs)\n\n[Tracing the error source](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/troubleshooting-tracing-the-error-source)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/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/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/troubleshooting-overview)\n\nIdentifying development errors and Starter bugs\n\nWhile developing with FastStore, you may run into errors. Some of these may require fixes in FastStore libraries, while others may require adjusting your code.\n\nHence, before proceeding with any advanced troubleshooting, we recommend that you first check if you are facing a bug from FastStore/WebOps or a mistake on your side.\n\n---\n\n## Instructions\n\nComing Soon\n\n---\n\nIf the problem persists with the starter, we recommend [opening an issue](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/issues/new/choose) and reporting the problem. However, if the error only occurs in your own project, please refer to the [Tracing the error source](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-tracing-the-error-source) guide to continue debugging your store.\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/docs/troubleshooting/identifying-development-errors-and-starter-bugs.mdx)\n\n[Debugging Partytown and analytics issues« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/troubleshooting-analytics-and-partytown)[Tracing the error sourceNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/troubleshooting-tracing-the-error-source)\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[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs%23instructions)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/troubleshooting/identifying-development-errors-and-starter-bugs.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/troubleshooting-identifying-development-errors-and-starter-bugs/docs/guides/faststore/troubleshooting-identifying-development-errors-and-starter-bugs%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_628c4289
|
[
{
"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 payment provider protocol 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-payment-provider-protocol/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-payment-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/guides/payments-integration-payment-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/guides/payments-integration-payment-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/guides/payments-integration-payment-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/guides/payments-integration-payment-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/guides/payments-integration-payment-provider-protocol/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/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-payment-provider-protocol/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/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-payment-provider-protocol/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/docs/guides/payments-integration-purchase-flows)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/guides/payments-integration-payment-app)\n\n[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/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-payment-provider-protocol/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/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-payment-provider-protocol/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/docs/guides/payments-integration-purchase-flows)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/guides/payments-integration-payment-app)\n\n[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/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-payment-provider-protocol/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-payment-provider-protocol/docs/guides)\n\nIntegration Guides\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/guides/payments-integration-guide)\n\n[Payment Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol/docs/guides/payments-integration-payment-provider-protocol)\n\nPayment Provider Protocol\n\nThe Payment Provider Protocol is a public contract for those who want to integrate its payment providers into the VTEX platform. In other words, It is the protocol that defines how a Payment Service Provider must integrate with the VTEX SmartCheckout system.\n\nThis resource enables us to increase the range of payment methods and partner options that we can offer to our merchants. This way, they have more options to create a strategy aligned with their market needs. It is important to mention that integration is only possible if the store or the partner fulfills some criteria.\n\nOur protocol is composed of nine endpoints, all public and documented in the Developer Portal. To check more details about each one of them, go to the [Payment Provider Protocol API overview page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payment-provider-protocol-api-overview). More information about the integration steps can be found in the [correspondent Help Center article](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/payment-provider-protocol--RdsT2spdq80MMwwOeEq0m).\n\n> To develop a new payment connector, it is mandatory to follow the **prerequisites determined by VTEX**. You can learn about them in the [Implementation prerequisites section of our Payment Provider Protocol article](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/payment-provider-protocol--RdsT2spdq80MMwwOeEq0m%23implementation-prerequisites).\n\nContributors\n\n1\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/payments-integration-guide/payments-integration-payment-provider-protocol.md)\n\n[Integrating a new payment provider on VTEX« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol//docs/guides/integrating-a-new-payment-provider-on-vtex)[Payment Provider Protocol for Point of Sale (POS) - VTEX Sales AppNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-protocol//docs/guides/payments-integration-ppp-applied-to-pos)\n\nContributors\n\n1\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/payments-integration-guide/payments-integration-payment-provider-protocol.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_00de5143
|
[
{
"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 enable an observation field on the checkout page 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/enable-an-observation-field-on-the-checkout-page/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/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/enable-an-observation-field-on-the-checkout-page/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/enable-an-observation-field-on-the-checkout-page/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/enable-an-observation-field-on-the-checkout-page/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/enable-an-observation-field-on-the-checkout-page/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/enable-an-observation-field-on-the-checkout-page/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/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/enable-an-observation-field-on-the-checkout-page/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/docs/guides/customization)\n\n[Checkout customization guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/docs/guides/checkout-customization-guide)\n\n[Customize checkout confirmation pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/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/enable-an-observation-field-on-the-checkout-page/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/enable-an-observation-field-on-the-checkout-page/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/enable-an-observation-field-on-the-checkout-page/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/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/enable-an-observation-field-on-the-checkout-page/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/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/enable-an-observation-field-on-the-checkout-page/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/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/enable-an-observation-field-on-the-checkout-page/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/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/enable-an-observation-field-on-the-checkout-page/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/enable-an-observation-field-on-the-checkout-page/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/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/enable-an-observation-field-on-the-checkout-page/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/docs/guides/customization)\n\n[Checkout customization guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/docs/guides/checkout-customization-guide)\n\n[Customize checkout confirmation pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/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/enable-an-observation-field-on-the-checkout-page/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/enable-an-observation-field-on-the-checkout-page/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/enable-an-observation-field-on-the-checkout-page/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/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/enable-an-observation-field-on-the-checkout-page/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/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/enable-an-observation-field-on-the-checkout-page/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/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/enable-an-observation-field-on-the-checkout-page/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/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/enable-an-observation-field-on-the-checkout-page/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/enable-an-observation-field-on-the-checkout-page/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/docs/guides/checkout-api-overview)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page/docs/guides/customization)\n\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/docs/guides/enable-an-observation-field-on-the-checkout-page)\n\nEnable an Observation field on the Checkout page\n\nYou can enable an **Observation** field on the Checkout page and use it to store additional information about the order.\n\nThe data entered in this field is sent via API to the Order Management System. They populate the `openTextField` field, which can be retrieved later either in the Admin or through an Orders API call.\n\nBy default, this field is disabled. To enable it, it is necessary to insert the following rule in the CSS via the APP [Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-checkout-ui-settings) or by the Admin.\n\n`.note { display: block; }`\n\nCheckout code configuration page view in Admin:\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/customization/enable-an-observation-field-on-the-checkout-page.md)\n\n[Change payment method names in Checkout« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page//docs/guides/change-payment-method-names-in-checkout)[DiscountsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-an-observation-field-on-the-checkout-page//docs/guides/discounts)\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/Checkout/customization/enable-an-observation-field-on-the-checkout-page.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_66b173fc
|
[
{
"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 rewriter rewriter graphql api 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.rewriter/rewriter-graphql-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-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/apps/vtex.rewriter/rewriter-graphql-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/apps/vtex.rewriter/rewriter-graphql-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/apps/vtex.rewriter/rewriter-graphql-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/apps/vtex.rewriter/rewriter-graphql-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/apps/vtex.rewriter/rewriter-graphql-api/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.checkout-ui-custom)\n\n[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.messages)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter)\n\n[Rewriter GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/guides/affiliates-program-app)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/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.rewriter/rewriter-graphql-api/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.rewriter/rewriter-graphql-api/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.checkout-ui-custom)\n\n[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.messages)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter)\n\n[Rewriter GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/guides/affiliates-program-app)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/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.rewriter/rewriter-graphql-api/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.rewriter/rewriter-graphql-api/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.rewriter/rewriter-graphql-api/docs/vtex-io-apps)\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/guides/functional-apps)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter)\n\nRewriter GraphQL API\n\n[vtex.rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter)\n\nVersion: 1.68.0\n\nLatest version: 1.68.0\n\nThis article serves as a comprehensive guide to the GraphQL API provided by the [Rewriter app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter). This API allows managing internal URLs and URL redirects.\n\nRoutes stored in the Rewriter commonly have complex paths, since they communicate with other systems and databases. To improve client-side usage and SEO rankings, the Rewriter app has, in the definition of the routes, the standard paths along with canonical (shorter) paths. For instance, the standard path to a product is `/_v/segment/routing/vtex.store@2.x/product/:id/:slug/p`, while the canonical path to a product is `/:slug/p`.\n\nThe Rewriter app is responsible for three main types of routes: **product**, **search**, and **navigation** routes.\n\nThe first two are first-class entities in Rewriter, meaning Rewriter identifies these routes and directly forwards them to the rendering pipeline.\n\nNavigation routes, in turn, are client-side defined routes related to custom paths and VTEX IO pre-defined templates, such as department, brand, and category routes. These routes can have a canonical path and a search query string.\n\nIn Rewriter, navigation routes are identified by the internal type, and routes used to redirect a route from one path to another are identified by the redirect type.\n\nThe table below summarizes the classification of routes used in the API.\n\n| Type of route | Description |\n| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Internal | Identifies navigation routes. Its standard path can have segments specifying the communication with other systems such as databases or apps, possibly making them long. It can be associated with a canonical path, omitting some segments, for improved client-side usage and SEO ranking. |\n| Redirect | Navigation route that redirects one path to another. There are various reasons to use a redirect including URL changes, content removal, SEO and navigation improvements, and others. |\n\nRewriter includes functionalities to:\n\n* Create an internal route.\n* Create a canonical path related to an internal route.\n* Create a redirect route.\n* Delete an internal route.\n* Delete a canonical path related to an internal route.\n* Delete a redirect route.\n* Create translated URLs for cross-border stores.\n\nIn the following sections are the definitions of endpoints and parameter descriptions of the Rewriter GraphQL API.\n\n## Schema overview\n\n### Query\n\n Query version: String [ redirect: ](#redirect) [ QueryRedirect!](#queryredirect) [internal:](#internal) [QueryInternal!](#queryinternal) QueryRedirect get(path:String!, locator:[RouteLocator](#routelocator)): [Redirect](#redirect) listRedirects(limit:Int, next:String): [ListRedirectsResponse!](#listredirectsresponse) Query: redirect QueryInternal get(path:String!, locator:[RouteLocator](#routelocator)): [Internal](#internal) listInternals(limit:Int, next:String): [ListInternalsResponse!](#listinternalsresponse) routes(locator:[EntityLocator](#entitylocator)): [\\[RoutesByBinding!\\]](#routesbybinding) Query: internal Redirect from: String! to: String! endDate: String type: [RedirectTypes!](#redirecttypes) binding: String! origin: String QueryRedirect: get ListRedirectsResponse routes: [\\[Redirect!\\]](#redirect) next: String QueryRedirect: listRedirects Internal from: String! declarer: String! type: String! id: String! query: JSON binding: String! endDate: String imagePath: String imageTitle: String routesVersion: Float resolveAs: String origin: String disableSitemapEntry: Boolean QueryInternal: get ListInternalsResponse routes: [\\[Internal!\\]](#internal) next: String QueryInternal: listInternals RoutesByBinding binding: String! route: String! QueryInternal: routes ListRedirectsResponse: routes ListInternalsResponse: routes \n\n| Field | Type | Description |\n| ------------ | -------------------------------- | ------------------------------------------------------------------------------------------------------ |\n| **redirect** | [QueryRedirect](#queryredirect)! | Provides _redirect_ routes data.Redirect routes are used to redirect a route from one path to another. |\n| **internal** | [QueryInternal](#queryinternal)! | Provides _internal_ routes data.Internal routes are navigation routes. |\n\n### Mutation\n\nMutation Mutation [redirect](#redirect) [ MutateRedirect!](#mutateredirect) [internal:](#internal) [ MutateInternal!](#mutateinternal) MutateRedirect MutateRedirect save(route: [RedirectInput](#redirectinput)!): [Redirect](#redirect) saveMany(routes: \\[[RedirectInput](#redirectinput)!\\]!): Boolean! delete(path: String! locator: [RouteLocator](#routelocator)): [Redirect](#redirect) deleteMany(paths: \\[String!\\]! locators: \\[[RouteLocator](#routelocator)!\\]): Boolean! Mutation:redirectport->MutateRedirect Mutation: redirect MutateInternal MutateInternal save(route: [InternalInput](#internalinput)!): [Internal](#internal) saveMany(routes: \\[[InternalInput](#internalinput)!\\]!): Boolean! delete(path: String! locator: [RouteLocator](#routelocator)): [Internal](#internal) deleteMany(paths: \\[String!\\]! locators: \\[[RouteLocator](#routelocator)!\\]): Boolean! Mutation:internalport->MutateInternal Mutation: internal Redirect from: String! to: String! endDate: String type: [RedirectTypes!](#redirecttypes) binding: String! origin: String MutateRedirect:deleteport-Redirect MutateRedirect: delete Internal from: String! declarer: String! type: String! id: String! query: JSON binding: String! endDate: String imagePath: String imageTitle: String routesVersion: Float resolveAs: String origin: String disableSitemapEntry: Boolean MutateInternal:saveport-Internal MutateInternal: save MutateInternal:deleteport-Internal MutateInternal: delete MutateRedirect:saveport-Redirect MutateRedirect: save \n\n| Field | Type | Description |\n| ------------ | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **redirect** | [MutateRedirect](#mutateredirect)! | Updates or deletes _redirect_ routes data according to the provided arguments.Redirect routes are used to redirect a route from one path to another. |\n| **internal** | [MutateInternal](#mutateinternal)! | Updates or deletes _internal_ routes data according to the provided arguments.Internal routes are navigation routes. |\n\n## Schema description\n\n> Arguments must be provided by the user. The exclamation mark `!` indicates that a type cannot be nullable.\n\n### QueryRedirect\n\n| Field | (argument) | Type | Description |\n| ----------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |\n| **get** | [Redirect](#redirect) | Returns information regarding a specific redirect route, given its related _path_ and _locator_. | |\n| path | **String!** | The path of the desired route to fetch data. | |\n| locator | [RouteLocator](#routelocator) | The _RouteLocator_ object, containing information about the store locale and route origin. | |\n| **listRedirects** | [ListRedirectsResponse](#listredirectsresponse)! | Lists all redirect routes. | |\n| limit | Int | The number of _ListRedirectsResponse_ objects to be displayed at once. | |\n| next | String | The argument used to fetch more internal routes from _ListRedirectsResponse_.It must be empty in the first query and, in the following, filled in with the string previously obtained from the _ListRedirectsResponse_ object. | |\n\n[Query](#query) 🔼\n\n### QueryInternal\n\n| Field | (argument) | Type | Description |\n| ----------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |\n| **get** | [Internal](#internal) | Returns information regarding a specific internal route, given its related _path_ and _locator_ | |\n| path | String! | The path of the desired route to fetch data. | |\n| locator | [RouteLocator](#routelocator) | The _RouteLocator_ object, containing information about the store locale and route origin. | |\n| **listInternals** | [ListInternalsResponse](#listinternalsresponse)! | Lists all internal routes. | |\n| limit | Int | The number of _ListInternalsResponse_ objects to be displayed at once. | |\n| next | String | The argument used to fetch more internal routes from _ListInternalsResponse_.It must be empty in the first query and, in the following, filled in with the string previously obtained from the _ListInternalsResponse_ object. | |\n| **routes** | \\[[RoutesByBinding](#routesbybinding)!\\] | Lists all internal routes of a specific type (e.g. deparment routes, category routes, etc.) and its related _binding_, which is an identifier for each store locale. | |\n| locator | [EntityLocator](#entitylocator) | The _EntityLocator_ object, containing information about the entity type of the routes to be listed. | |\n\n[Query](#query) 🔼\n\n### MutateRedirect\n\n| Field | (argument) | Type | Description |\n| -------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------ | ----------- |\n| **save** | [Redirect](#redirect) | Creates or updates a redirect route according to the provided arguments. | |\n| route | [RedirectInput](#redirectinput)! | The data regarding the redirect route to be created or updated. | |\n| **saveMany** | Boolean! | Creates or updates many redirect routes according to the provided arguments. | |\n| routes | \\[[RedirectInput](#redirectinput)!\\]! | The data regarding the redirect routes to be created or updated. | |\n| **delete** | [Redirect](#redirect) | Deletes a redirect route according to the provided arguments. | |\n| path | String! | The path of the route to be deleted. | |\n| locator | [RouteLocator](#routelocator) | The _EntityLocator_ object, containing information about the entity type of the route to be deleted. | |\n| **deleteMany** | Boolean! | Deletes many redirect route according to the provided arguments. | |\n| paths | \\[String!\\]! | The paths of the routes to be deleted. | |\n| locators | \\[[RouteLocator](#routelocator)!\\] | The _EntityLocator_ objects, containing information about the entity type of the routes to be deleted. | |\n\n[Mutation](#mutation) 🔼\n\n### MutateInternal\n\n| Field | (argument) | Type | Description |\n| -------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------ | ----------- |\n| **save** | [Internal](#internal) | Creates or updates an internal route according to the provided arguments. | |\n| route | [InternalInput](#internalinput)! | The data regarding the internal route to be created or updated. | |\n| **saveMany** | Boolean! | Creates or updates many internal routes according to the provided arguments. | |\n| routes | \\[[InternalInput](#internalinput)!\\]! | The data regarding the internal routes to be created or updated. | |\n| **delete** | [Internal](#internal) | Deletes an internal route according to the provided arguments. | |\n| path | String! | The path of the route to be deleted. | |\n| locator | [RouteLocator](#routelocator) | The _EntityLocator_ object, containing information about the entity type of the route to be deleted. | |\n| **deleteMany** | Boolean! | Deletes many internal routes according to the provided arguments. | |\n| paths | \\[String!\\]! | The paths of the routes to be deleted. | |\n| locators | \\[[RouteLocator](#routelocator)!\\] | The _EntityLocator_ objects, containing information about the entity type of the routes to be deleted. | |\n\n[Mutation](#mutation) 🔼\n\n### Internal\n\n| Field | Type | Description |\n| ----------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **from** | String! | The route path. |\n| **declarer** | String! | The app that originally defined the route in a routes.json file. For VTEX IO pre-defined routes, the declarer value is [vtex.store@2.x](mailto:vtex.store@2.x). |\n| **type** | String! | The route entity type defined in the declarer app, which can be: department, category, subcategory, brand, etc. |\n| **id** | String! | The entity type id. For example, a deparment id. |\n| **query** | JSON | The query string parameters of a route. |\n| **binding** | String! | The id of the _binding_ which the route is available._Keep in mind: Every store has a binding id related to its store locale. Hence, cross-border stores always have more than one binding, while accounts with a single storefront have only one binding id._ |\n| **endDate** | String | The date a route stops being valid._Keep in mind: The endDate value for permanent routes is null._ |\n| **imagePath** | String | |\n| **imageTitle** | String | |\n| **routesVersion** | Float | The current routes version._Keep in mind: If the routesVersion value is null or different from the current version, the route is not currently available in the store._ |\n| **resolveAs** | String | Alias paths of a route, meaning that the route will resolve the paths defined in the resolveAs field _Keep in mind: The resolveAs parameter must always be defined in the catalog's default language._ |\n| **origin** | String | A string that defines the origin of the route, for example: user-canonical |\n| **disableSitemapEntry** | Boolean | The boolean value that indicates if a route is included (False) or not (True) in the store's sitemap. |\n\n[QueryInternal](#queryinternal) 🔼\n\n[MutateInternal](#mutateinternal) 🔼\n\n[ListInternalsResponse](#listinternalsresponse) 🔼\n\n### ListInternalsResponse\n\n| Field | Type | Description |\n| ---------- | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **routes** | \\[[Internal](#internal)!\\] | Returns the demanded information from the _Internal_ object for each route. |\n| **next** | String | Returns a string to be used as the _next_ argument of the succeeding _listInternals_ query to fetch more data.When _next_ returns _null_, all data have already been fetched. |\n\n[QueryInternal](#queryinternal) 🔼\n\n### RoutesByBinding\n\n| Field | Type | Description |\n| ----------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **binding** | String! | The id of the _binding_ which the route is available. _Keep in mind: Every store has a binding id related to its store locale. Hence, cross-border stores always have more than one binding, while accounts with a single storefront have only one binding id._ |\n| **route** | String! | Returns the route path. |\n\n[QueryInternal](#queryinternal) 🔼\n\n### Redirect\n\n| Field | Type | Description |\n| ----------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **from** | String! | The original route path. |\n| **to** | String! | The route redirect path. |\n| **endDate** | String | The date a redirect route stops being valid. _Keep in mind: The endDate value for permanent routes is null._ |\n| **type** | [RedirectTypes](#redirecttypes)! | The route type: temporary or permanent. |\n| **binding** | String! | The id of the _binding_ which the route is available. _Keep in mind: Every store has a binding id related to its store locale. Hence, cross-border stores always have more than one binding, while accounts with a single storefront have only one binding id._ |\n| **origin** | String | A string that defines the origin of the route, for example: user-canonical |\n\n[QueryRedirect](#queryredirect) 🔼\n\n[MutateRedirect](#mutateredirect) 🔼\n\n### ListRedirectsResponse\n\n| Field | Type | Description |\n| ---------- | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **routes** | \\[[Redirect](#redirect)!\\] | Returns the demanded information from the _Redirect_ object for each route. |\n| **next** | String | Returns a string to be used as the _next_ argument of the succeeding _listInternals_ query to fetch more data.When _next_ returns _null_, all data have already been fetched. |\n\n[QueryRedirect](#queryredirect) 🔼\n\n### EntityLocator\n\n| Field | Type | Description |\n| -------- | ------- | ----------------------------------------------------------------------------------- |\n| **id** | String! | The entity type id. For example, a deparment id. |\n| **type** | String! | The route entity type, which can be: department, category, subcategory, brand , etc |\n\n[QueryInternal](#queryinternal) 🔼\n\n### InternalInput\n\n| Field | Type | Description |\n| ----------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **from** | String! | The route path. |\n| **declarer** | String! | The app that originally defined the route in a routes.json file. For VTEX IO pre-defined routes, the declarer value is [vtex.store@2.x](mailto:vtex.store@2.x). |\n| **type** | String! | The route entity type, which can be: department, category, subcategory, brand , etc |\n| **id** | String! | The entity type id. For example, a deparment id. |\n| **query** | JSON | The query string parameters of a route. |\n| **binding** | String | The id of the _binding_ which the route is available._Keep in mind: Every store has a binding id related to its store locale. Hence, cross-border stores always have more than one binding, while accounts with a single storefront have only one binding id._ |\n| **endDate** | String | The date a route stops being valid._Keep in mind: The endDate value for permanent routes is null._ |\n| **imagePath** | String | |\n| **imageTitle** | String | |\n| **resolveAs** | String | Alias paths of a route, meaning that the route will resolve the paths defined in the resolveAs field. _Keep in mind: The resolveAs parameter must always be defined in the catalog's default language._ |\n| **origin** | String | A string that defines the origin of the route, for example: user-canonical |\n| **disableSitemapEntry** | Boolean | The boolean value that indicates if a route is included (False) or not (True) in the store's sitemap. |\n\n[MutateInternal](#mutateinternal) 🔼\n\n### RedirectInput\n\n| Field | Type | Description |\n| ----------- | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **from** | String! | The original route path. |\n| **to** | String! | The route redirect path. |\n| **endDate** | String | The date a route stops being valid._Keep in mind: The endDate value for permanent routes is null._ |\n| **type** | [RedirectTypes](#redirecttypes)! | The route type: temporary or permanent. |\n| **binding** | String | The id of the _binding_ which the route is available._Keep in mind: Every store has a binding id related to its store locale. Hence, cross-border stores always have more than one binding, while accounts with a single storefront have only one binding id._ |\n| **origin** | String | A string that defines the origin of the route, for example: user-canonical |\n\n[MutateRedirect](#mutateredirect) 🔼\n\n### RouteLocator\n\n| Field | Type | Description |\n| ----------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **from** | String! | The original route path. |\n| **binding** | String! | The id of the _binding_ which the route is available._Keep in mind: Every store has a binding id related to its store locale. Hence, cross-border stores always have more than one binding, while accounts with a single storefront have only one binding id._ |\n\n[QueryRedirect](#queryredirect) 🔼\n\n[QueryInternal](#queryinternal) 🔼\n\n[MutateRedirect](#mutateredirect) 🔼\n\n[MutateInternal](#mutateinternal) 🔼\n\n### RedirectTypes\n\n| Value | | **PERMANENT** |\n| ------------- | ---------------- |\n| **TEMPORARY** | |\n\n[Redirect](#redirect) 🔼\n\n[RedirectInput](#redirectinput) 🔼\n\n[Rewriter« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter)[Responsive ValuesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.responsive-values)\n\nSee also\n\n[Vtex.rewriterVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Schema overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23schema-overview)\n\n[Query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23query)[Mutation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23mutation)\n\n[Schema description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23schema-description)\n\n[QueryRedirect](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23queryredirect)[QueryInternal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23queryinternal)[MutateRedirect](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23mutateredirect)[MutateInternal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23mutateinternal)[Internal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23internal)[ListInternalsResponse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23listinternalsresponse)[RoutesByBinding](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23routesbybinding)[Redirect](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23redirect)[ListRedirectsResponse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23listredirectsresponse)[EntityLocator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23entitylocator)[InternalInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23internalinput)[RedirectInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23redirectinput)[RouteLocator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23routelocator)[RedirectTypes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rewriter/rewriter-graphql-api/docs/apps/vtex.rewriter/rewriter-graphql-api%23redirecttypes)\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_9f4b0968
|
[
{
"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 payment methods 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-payment-methods/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-payment-methods/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-payment-methods/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-payment-methods/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-payment-methods/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-payment-methods/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-payment-methods/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-payment-methods/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-payment-methods/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/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-payment-methods/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/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-payment-methods/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-overview)\n\n[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-banner-text)\n\n[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-cart-sidebar)\n\n[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-empty-state)\n\n[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-filter-slider)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-filter)\n\n[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-hero)\n\n[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-image-gallery)\n\n[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-navbar-slider)\n\n[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-navbar)\n\n[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-newsletter)\n\n[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-out-of-stock)\n\n[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods)\n\n[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-price-range)\n\n[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-product-grid)\n\n[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-product-shelf)\n\n[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-region-modal)\n\n[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-search-input)\n\n[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-shipping-simulation)\n\n[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/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-payment-methods/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/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-payment-methods/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-payment-methods/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-payment-methods/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-payment-methods/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/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-payment-methods/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-payment-methods/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/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-payment-methods/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-payment-methods/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/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-payment-methods/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/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-payment-methods/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-overview)\n\n[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-banner-text)\n\n[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-cart-sidebar)\n\n[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-empty-state)\n\n[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-filter-slider)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-filter)\n\n[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-hero)\n\n[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-image-gallery)\n\n[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-navbar-slider)\n\n[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-navbar)\n\n[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-newsletter)\n\n[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-out-of-stock)\n\n[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods)\n\n[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-price-range)\n\n[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-product-grid)\n\n[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-product-shelf)\n\n[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-region-modal)\n\n[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-search-input)\n\n[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-shipping-simulation)\n\n[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/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-payment-methods/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/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-payment-methods/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-payment-methods/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-payment-methods/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-payment-methods/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/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-payment-methods/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-payment-methods/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-payment-methods/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/components-index)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-overview)\n\nPaymentMethods\n\nDisplays the logos of the available payment options in a store.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/organisms/PaymentMethods)\n\nThe `PaymentMethods` component displays the logos of the available payment options in a store.\n\nExample\n\nCode\n\n### Payment Methods\n\n* Amex\n* Visa\n* Diners Club\n* Mastercard\n* Elo Card\n* PayPal\n* Pix\n* Stripe\n* GooglePay\n* ApplePay\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { PaymentMethods } 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/PaymentMethods/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### Title\n\n| Local token | Default value/Global token linked |\n| --------------------------------------- | --------------------------------- |\n| \\--fs-payment-methods-title-size | var(--fs-text-size-body) |\n| \\--fs-payment-methods-title-weight | var(--fs-text-weight-bold) |\n| \\--fs-payment-methods-title-line-height | 1.25 |\n\n### Flags\n\n| Local token | Default value/Global token linked |\n| -------------------------------------- | --------------------------------- |\n| \\--fs-payment-methods-flags-row-gap | var(--fs-spacing-1) |\n| \\--fs-payment-methods-flags-margin-top | var(--fs-spacing-3) |\n\n### Flag\n\n| Local token | Default value/Global token linked |\n| ---------------------------------------- | --------------------------------- |\n| \\--fs-payment-methods-flag-width | var(--fs-spacing-5) |\n| \\--fs-payment-methods-flag-height | var(--fs-spacing-4) |\n| \\--fs-payment-methods-flag-bkg-color | var(--fs-color-neutral-0) |\n| \\--fs-payment-methods-flag-border-width | var(--fs-border-width) |\n| \\--fs-payment-methods-flag-border-color | var(--fs-color-neutral-3) |\n| \\--fs-payment-methods-flag-border-radius | var(--fs-border-radius-small) |\n\n---\n\n## Data attributes\n\nYou can target and override `PaymentMethods` styles using the following data attributes:`data-fs-payment-methods`\n\n`data-fs-payment-methods-title`\n\n`data-fs-payment-methods-flags`\n\n`data-fs-payment-methods-flag`\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-payment-methods | | | | | | |\n| **title** | string \\| number | false | true | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | Title of the payment methods section (e.g.: \"Payment methods\", \"Accepted Cards\"). |\n| **aria-label** | string | Defines a string value that labels the current element when title is not used. | | | | | | | |\n| **flagList\\*** | Flag\\[\\] | List of flags to be displayed in the payment methods section (e.g.:, visa, mastercard, etc). | | | | | | | |\n\n## Flag\n\n| Name | Type | Description | Default |\n| -------- | ---------------- | ------------------------------------------------------------------------- | ------- |\n| **icon** | { icon: string } | An object with the icon name to display the flag image. | |\n| **alt** | string | Description of the flag image to be also used for accessibility purposes. | |\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/payment-methods.mdx)\n\n[OutOfStock« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-out-of-stock)[PriceRangeNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-price-range)\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-payment-methods/docs/guides/faststore/organisms-payment-methods%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23design-tokens)\n\n[Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23title)[Flags](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23flags)[Flag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23flag)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23props)\n\n[Flag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23flag)\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/payment-methods.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-payment-methods/docs/guides/faststore/organisms-payment-methods%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23design-tokens)\n\n[Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23title)[Flags](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23flags)[Flag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23flag)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23props)\n\n[Flag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-payment-methods/docs/guides/faststore/organisms-payment-methods%23flag)\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_ed3f9eef
|
[
{
"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 what is vtex io in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/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-what-is-vtex-io/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/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-what-is-vtex-io/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/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-what-is-vtex-io/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/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-what-is-vtex-io/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/app-development)\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\nWhat is VTEX IO\n\nVTEX IO is a low-code development platform designed to handle performance, scalability, and security requirements in enterprise applications. By managing infrastructure complexities, VTEX IO enables developers to concentrate on application logic and business-specific needs.\n\nThe platform supports a wide range of use cases, such as web storefronts, custom admin applications, and backend integrations.\n\n## Cloud-native infrastructure\n\nVTEX IO provides a cloud-native environment optimized for scalability and high availability, minimizing manual infrastructure management.\n\n* **Automatic scaling:** Resources are dynamically adjusted based on traffic demands, maintaining uptime and performance even during peak usage without requiring pre-scaling.\n* **VTEX IO Command-line interface (CLI):** The VTEX IO CLI enables fast setup and configuration, allowing developers to synchronize code with the cloud environment quickly and efficiently.\n* **Continuous deployment:** Code changes in the local environment are automatically synced and deployed to the cloud, ensuring a consistent development and production environment.\n\n## Workspaces\n\nThe [workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace) functionality on VTEX IO provides isolated environments, allowing teams to develop, test, and deploy code safely without impacting the live environment.\n\n* **Version control:** Multiple workspaces allow developers to maintain and test separate code versions. Each workspace can be deployed independently to evaluate changes.\n* **Testing and monitoring:** Workspaces support A/B testing and enable real-time performance tracking, allowing teams to measure the impact of updates and optimize them accordingly.\n\n## Supported frameworks and technologies\n\nVTEX IO incorporates an opinionated set of frameworks supported by [VTEX IO Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders) to facilitate development with familiar tools.\n\nSupported frameworks include [TypeScript](https://read.calvincode.net/reader?url=https://www.typescriptlang.org/), [React](https://read.calvincode.net/reader?url=https://react.dev/), [GraphQL](https://read.calvincode.net/reader?url=https://graphql.org/), [.NET](https://read.calvincode.net/reader?url=https://dotnet.microsoft.com/en-us/), and [Node](https://read.calvincode.net/reader?url=https://nodejs.org/en).\n\n### VTEX IO Store Framework\n\nFor teams specifically focused on building and maintaining storefronts, VTEX IO offers the [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework). This framework provides foundational tools and components, making it easy to create dynamic and customized ecommerce experiences.\n\n* **React-based store blocks:** The Store Framework offers pre-built, customizable React [blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps), which simplify the process of developing and updating storefront layouts and features.\n* **Consistent architecture:** Designed to integrate seamlessly with other VTEX services, the Store Framework ensures stable, scalable storefronts that align with VTEX’s core capabilities, supporting efficient and robust ecommerce solutions.\n\nFor further technical information, see the [VTEX IO Frequently Asked Questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions) to explore detailed use cases and platform-specific guidance.\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/Getting-Started/vtex-io-documentation-what-is-vtex-io.md)\n\n[What is a VTEX AppNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io//docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Cloud-native infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io%23cloud-native-infrastructure)\n\n[Workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io%23workspaces)\n\n[Supported frameworks and technologies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io%23supported-frameworks-and-technologies)\n\n[VTEX IO Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io%23vtex-io-store-framework)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Getting-Started/vtex-io-documentation-what-is-vtex-io.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Cloud-native infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io%23cloud-native-infrastructure)\n\n[Workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io%23workspaces)\n\n[Supported frameworks and technologies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io%23supported-frameworks-and-technologies)\n\n[VTEX IO Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io%23vtex-io-store-framework)\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_569601b0
|
[
{
"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 quotes graphql b2bquotes graphql api 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-quotes-graphql/b2bquotes-graphql-api/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-quotes-graphql/b2bquotes-graphql-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/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-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/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-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/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-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/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-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/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/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-quotes-graphql/b2bquotes-graphql-api/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.b2b-suite)\n\n[Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.storefront-permissions)\n\n[Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.storefront-permissions-ui)\n\n[B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.b2b-organizations)\n\n[B2B Checkout Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/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-quotes-graphql/b2bquotes-graphql-api/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-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes)\n\n[B2B Quotes GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/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-quotes-graphql/b2bquotes-graphql-api/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-quotes-graphql/b2bquotes-graphql-api/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-quotes-graphql/b2bquotes-graphql-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/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-quotes-graphql/b2bquotes-graphql-api/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.b2b-suite)\n\n[Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.storefront-permissions)\n\n[Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.storefront-permissions-ui)\n\n[B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.b2b-organizations)\n\n[B2B Checkout Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/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-quotes-graphql/b2bquotes-graphql-api/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-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes)\n\n[B2B Quotes GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/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-quotes-graphql/b2bquotes-graphql-api/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-quotes-graphql/b2bquotes-graphql-api/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-quotes-graphql/b2bquotes-graphql-api/docs/vtex-io-apps)\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.b2b-suite)\n\n[B2B Quotes & Carts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes)\n\nB2B Quotes GraphQL API\n\n[vtex.b2b-quotes-graphql](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql)\n\nVersion: 4.0.1\n\nLatest version: 4.0.1\n\nThis article provides a reference guide to the B2B Quotes GraphQL API, with details about the available queries and mutations for the [B2B Quotes app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes). The API supports quote management and related configurations in a B2B environment, enabling users to retrieve, create, and update quotes, as well as manage application settings and permissions.\n\n## Schema overview\n\n### Query\n\nadminSetup\n\ngetAppSettings\n\nupdateHistory\n\nitems\n\ngetQuote\n\ndata\n\npagination\n\ngetQuotes\n\ngetChildrenQuotes\n\nAdminSetup\n\ncartLifeSpan Int\n\nquotesManagedBy QuotesManagedBy!\n\nAppSettings\n\nadminSetup AdminSetup\n\nQuoteUpdate\n\nemail String\n\nrole String\n\ndate String\n\nstatus String\n\nnote String\n\nQuoteItem\n\nname String\n\nskuName String\n\nrefId String\n\nid String\n\nproductId String\n\nimageUrl String\n\nlistPrice Float\n\nprice Float\n\nquantity Int\n\nsellingPrice Float\n\nseller String\n\nQuote\n\nid String\n\nreferenceName String\n\ncreatorEmail String\n\ncreatorRole String\n\ncreationDate String\n\nexpirationDate String\n\nlastUpdate String\n\nupdateHistory \\[QuoteUpdate\\]\n\nitems \\[QuoteItem\\]\n\nsubtotal Float\n\nstatus String\n\norganization String\n\norganizationName String\n\ncostCenter String\n\ncostCenterName String\n\nviewedBySales Boolean\n\nviewedByCustomer Boolean\n\nsalesChannel String\n\nseller String\n\nparentQuote String\n\nhasChildren Boolean\n\nPagination\n\npage Int\n\npageSize Int\n\ntotal Int\n\nQuotes\n\ndata \\[Quote\\]\n\npagination Pagination\n\nQuery\n\ngetAppSettings AppSettings\n\ngetQuoteEnabledForUser(email String!) : Boolean\n\ngetQuote(id String) : Quote\n\ngetQuotes(organization \\[String\\], costCenter \\[String\\], status \\[String\\], search String, page Int, pageSize Int, sortOrder String, sortedBy String) : Quotes\n\ngetChildrenQuotes(id String, page Int, pageSize Int, sortOrder String, sortedBy String) : Quotes\n\n| Field | Argument | Type | Description |\n| -------------------------- | --------------------------- | --------------------------------------------------------------------------- | ----------- |\n| **getAppSettings** | [AppSettings](#appsettings) | Retrieves the current configuration settings of the B2B Quotes app. | |\n| **getQuoteEnabledForUser** | Boolean | Checks if the specified user has permission to use the quotes feature. | |\n| email | String! | Email address of the user to check permissions for. | |\n| **getQuote** | [Quote](#quote) | Retrieves a specific quote by ID. | |\n| id | String | Unique identifier of the quote to retrieve. | |\n| **getQuotes** | [Quotes](#quotes) | Retrieves a paginated list of quotes and saved carts with optional filters. | |\n| organization | \\[String\\] | Filters quotes and saved carts by organization IDs. | |\n| costCenter | \\[String\\] | Filters quotes and saved carts by cost center IDs. | |\n| status | \\[String\\] | Filters by status: READY, PENDING, REVISED, DECLINED, EXPIRED, or PLACED. | |\n| search | String | Searches quotes and saved carts by reference name. | |\n| page | Int | Page number for pagination. | |\n| pageSize | Int | Number of quotes per page. | |\n| sortOrder | String | Specifies the sort direction (ASC or DESC). | |\n| sortedBy | String | Field to sort the quotes by. | |\n| **getChildrenQuotes** | [Quotes](#quotes) | Retrieves child quotes associated with a parent quote. | |\n| id | String | ID of the parent quote. | |\n| page | Int | Page number for pagination. | |\n| pageSize | Int | Number of child quotes per page. | |\n| sortOrder | String | Specifies the sort direction (ASC or DESC). | |\n| sortedBy | String | Field to sort the child quotes by. | |\n\n### Mutation\n\nadminSetup\n\nsaveAppSettings\n\nAdminSetup\n\ncartLifeSpan Int\n\nquotesManagedBy QuotesManagedBy!\n\nAppSettings\n\nadminSetup AdminSetup\n\nMutation\n\ncreateQuote(input QuoteInput!) : String\n\nupdateQuote(input QuoteUpdateInput!) : String\n\nuseQuote(id String, orderFormId String) : String\n\nclearCart(orderFormId String) : String\n\nsaveAppSettings(input AppSettingsInput!) : AppSettings\n\n| Field | Argument | Type | Description |\n| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------- |\n| **createQuote** | String | Creates a new quote (PENDING status) or saved cart (READY status) from the current shopping cart. | |\n| input | [QuoteInput](#quoteinput)! | Input data for creating a new quote. | |\n| **updateQuote** | String | Updates an existing quote or saved cart, including price adjustments, quantities, and status changes. | |\n| input | [QuoteUpdateInput](#quoteupdateinput)! | Input data for updating the quote. | |\n| **useQuote** | String | Applies a quote or saved cart to the current shopping cart and redirects to checkout. | |\n| id | String | ID of the quote to be applied. | |\n| orderFormId | String | ID of the order form to apply the quote to. | |\n| **clearCart** | String | Removes all items from the current shopping cart before applying a quote. | |\n| orderFormId | String | ID of the order form to be cleared. | |\n| **saveAppSettings** | [AppSettings](#appsettings) | Updates the B2B Quotes app settings. | |\n| input | [AppSettingsInput](#appsettingsinput)! | New configuration to be saved. | |\n\n## Schema description\n\n> Arguments must be provided by the user. Required fields are marked with an exclamation mark (`!`).\n\n### AppSettings\n\n| Field | Type | Description |\n| -------------- | ------------------------- | ------------------------------------------------ |\n| **adminSetup** | [AdminSetup](#adminsetup) | Configuration settings for the B2B Quotes admin. |\n\n[Query](#query) 🔼\n\n[Mutation](#mutation) 🔼\n\n### AppSettingsInput\n\n| Field | Type | Description |\n| ------------------- | ----------------------------------- | ----------------------------------------------------------------------------------------- |\n| **cartLifeSpan** | Int | Default expiration period in days for quotes and saved carts. The minimum value is 1 day. |\n| **quotesManagedBy** | [QuotesManagedBy](#quotesmanagedby) | Defines who has permission to manage quotes (marketplace admins or individual sellers). |\n\n[Mutation](#mutation) 🔼\n\n### AdminSetup\n\n| Field | Type | Description |\n| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------- |\n| **cartLifeSpan** | Int | Default expiration period in days for quotes and saved carts. The minimum value is 1 day. |\n| **quotesManagedBy** | [QuotesManagedBy](#quotesmanagedby)! | Defines who has permission to manage quotes (marketplace administrators or individual sellers). |\n\n[AppSettings](#appsettings) 🔼\n\n### Quotes\n\n| Field | Type | Description |\n| -------------- | ------------------------- | ---------------------------------------------- |\n| **data** | \\[[Quote](#quote)\\] | Array of quotes matching the query parameters. |\n| **pagination** | [Pagination](#pagination) | Pagination details for the quotes list. |\n\n[Query](#query) 🔼\n\n### Quote\n\n| Field | Type | Description |\n| -------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **id** | String | Unique identifier for the quote. |\n| **referenceName** | String | User-defined name to identify the quote or saved cart. |\n| **creatorEmail** | String | Email address of the user who created the quote. |\n| **creatorRole** | String | Role of the user who created the quote. |\n| **creationDate** | String | Date and time when the quote was created. |\n| **expirationDate** | String | Date and time when the quote will expire. |\n| **lastUpdate** | String | Date of the last time when the quote or saved cart was updated. |\n| **updateHistory** | \\[[QuoteUpdate](#quoteupdate)\\] | History of all events related to the quote, including creation, discounts, and notes. |\n| **items** | \\[[QuoteItem](#quoteitem)\\] | Products included in the quote. |\n| **subtotal** | Float | Total price of all items, including any discounts offered by sales associates. |\n| **status** | String | Current status of the quote. Possible values are:READY (ready to place the order)PENDING (waiting for review)REVISED (waiting for additional review)DECLINED (can't be used)EXPIRED (past expiration date)PLACED (already used) |\n| **organization** | String | ID of the organization the quote belongs to. |\n| **organizationName** | String | Name of the organization the quote belongs to. |\n| **costCenter** | String | ID of the cost center associated with the quote. |\n| **costCenterName** | String | Name of the cost center associated with the quote. |\n| **viewedBySales** | Boolean | Indicates if a sales associate has viewed the quote or saved cart. |\n| **viewedByCustomer** | Boolean | Indicates if the customer has viewed the quote or saved cart. |\n| **salesChannel** | String | Sales channel associated with the quote or saved cart. |\n| **seller** | String | ID of the seller associated with the quote. |\n| **parentQuote** | String | ID of the parent quote if this is a child quote. |\n| **hasChildren** | Boolean | Indicates if this quote has associated child quotes. |\n\n[Query](#query) 🔼\n\n[Quotes](#quotes) 🔼\n\n### QuoteInput\n\n| Field | Type | Description |\n| ------------------ | ------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |\n| **referenceName** | String | User-defined name to identify the quote. |\n| **items** | \\[[QuoteItemInput](#quoteiteminput)\\] | List of products to include in the quote. |\n| **subtotal** | Float | Total price of all items, including any discounts offered by sales associates. |\n| **note** | String | Optional note that will be visible in the quote's update history to salespeople and organization members. |\n| **sendToSalesRep** | Boolean | If true, creates a quote with PENDING status for sales review. If false, creates a saved cart with READY status. |\n\n[Mutation](#mutation) 🔼\n\n### QuoteUpdate\n\n| Field | Type | Description |\n| ---------- | ------ | ------------------------------------------------------------------------------------- |\n| **email** | String | Email of the user who made the update. |\n| **role** | String | Role of the user who made the update (such as sales associate or organization buyer). |\n| **date** | String | Date when the update was made. |\n| **status** | String | Status change made in this update, if any. |\n| **note** | String | Optional comment or instruction added during this update. |\n\n[Quote](#quote) 🔼\n\n### QuoteItem\n\n| Field | Type | Description |\n| ---------------- | ------ | ------------------------------------------------------------------ |\n| **name** | String | Product name. |\n| **skuName** | String | Name of the specific SKU variant. |\n| **refId** | String | Reference ID of the product. |\n| **imageUrl** | String | URL of the product image. |\n| **listPrice** | Float | Original price before any discounts. |\n| **price** | Float | Original product price before any discounts. |\n| **quantity** | Int | Number of items. |\n| **sellingPrice** | Float | Product price including any discounts offered by sales associates. |\n\n[Quote](#quote) 🔼\n\n### QuoteUpdateInput\n\n| Field | Type | Description |\n| ------------------ | ------------------------------------- | ------------------------------------------------------------------------------------- |\n| **id** | String | Unique identifier of the quote to be updated. |\n| **items** | \\[[QuoteItemInput](#quoteiteminput)\\] | Updated list of products with their quantities and prices. |\n| **subtotal** | Float | Updated total price of all items. |\n| **note** | String | Optional comment or instruction that will be displayed in the quote's update history. |\n| **decline** | Boolean | When true, changes the quote status to DECLINED, preventing further use. |\n| **expirationDate** | String | New expiration date for the quote or saved cart. |\n\n[Mutation](#mutation) 🔼\n\n### QuoteItemInput\n\n| Field | Type | Description |\n| ---------------- | ------ | ------------------------------------------------------------------ |\n| **name** | String | Product name. |\n| **skuName** | String | Name of the specific SKU variant. |\n| **refId** | String | Reference ID of the product. |\n| **id** | String | Unique identifier for the SKU. |\n| **productId** | String | Unique identifier for the product. |\n| **imageUrl** | String | URL of the product image. |\n| **listPrice** | Float | Original price before any discounts. |\n| **price** | Float | Original product price before any discounts. |\n| **quantity** | Int | Number of items. |\n| **sellingPrice** | Float | Product price including any discounts offered by sales associates. |\n| **seller** | String | ID of the seller offering this item. |\n\n[QuoteUpdateInput](#quoteupdateinput) 🔼\n\n### Pagination\n\n| Field | Type | Description |\n| ------------ | ---- | --------------------------------------- |\n| **page** | Int | Current page number. |\n| **pageSize** | Int | Number of items per page. |\n| **total** | Int | Total number of items across all pages. |\n\n[Quotes](#quotes) 🔼\n\n## Enums\n\n### QuotesManagedBy\n\n| Field | Description |\n| --------------- | --------------------------------------------- |\n| **MARKETPLACE** | Quotes are managed by the marketplace admins. |\n| **SELLER** | Quotes are managed by individual sellers. |\n\n[AppSettingsInput](#appsettingsinput) 🔼\n\n[AdminSetup](#adminsetup) 🔼\n\n[B2B Quotes & Carts« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes)[Functional AppsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/guides/functional-apps)\n\nSee also\n\n[Vtex.b2b Quotes GraphqlVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Schema overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api%23schema-overview)\n\n[Query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api%23query)[Mutation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api%23mutation)\n\n[Schema description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api%23schema-description)\n\n[AppSettings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api%23appsettings)[AppSettingsInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api%23appsettingsinput)[AdminSetup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api%23adminsetup)[Quotes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api%23quotes)[Quote](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api%23quote)[QuoteInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api%23quoteinput)[QuoteUpdate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api%23quoteupdate)[QuoteItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api%23quoteitem)[QuoteUpdateInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api%23quoteupdateinput)[QuoteItemInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api%23quoteiteminput)[Pagination](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api%23pagination)\n\n[Enums](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api%23enums)\n\n[QuotesManagedBy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api%23quotesmanagedby)\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_1c195bff
|
[
{
"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 InfoCard 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/InfoCard/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/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/apps/vtex.store-components@3.178.5/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/apps/vtex.store-components@3.178.5/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/apps/vtex.store-components@3.178.5/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/apps/vtex.store-components@3.178.5/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/apps/vtex.store-components@3.178.5/InfoCard/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/InfoCard/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/InfoCard/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/InfoCard/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/InfoCard/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/InfoCard/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/InfoCard/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/InfoCard/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/InfoCard/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/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/apps/vtex.store-components@3.178.5/InfoCard/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/InfoCard/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/InfoCard/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/InfoCard/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/InfoCard/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/InfoCard/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/InfoCard/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/InfoCard/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/InfoCard/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/InfoCard/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/InfoCard/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/InfoCard/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/InfoCard/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/InfoCard/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/InfoCard/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/InfoCard/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/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/apps/vtex.store-components@3.178.5/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/apps/vtex.store-components@3.178.5/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/apps/vtex.store-components@3.178.5/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/apps/vtex.store-components@3.178.5/InfoCard/docs/apps/vtex.store-components@3.178.5/InfoCard%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/InfoCard/docs/apps/vtex.store-components@3.178.5/InfoCard%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/InfoCard/docs/apps/vtex.store-components@3.178.5/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_5fb54194
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides setting up dkim for transactional emails in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/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[Setting up DKIM for transactional emails](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/setting-up-dkim-for-transactional-emails)\n\n[Setting up the SPF](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/setting-up-the-spf)\n\n[How to set up functions in the Message Center templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/how-to-set-up-functions-in-the-message-center-templates)\n\n[Including order variables in the transactional email template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/including-order-variables-in-the-transactional-email-template)\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/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[Setting up DKIM for transactional emails](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/setting-up-dkim-for-transactional-emails)\n\n[Setting up the SPF](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/setting-up-the-spf)\n\n[How to set up functions in the Message Center templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/how-to-set-up-functions-in-the-message-center-templates)\n\n[Including order variables in the transactional email template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/including-order-variables-in-the-transactional-email-template)\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides)\n\nMessage Center\n\n[Setting up DKIM for transactional emails](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/setting-up-dkim-for-transactional-emails)\n\nSetting up DKIM for transactional emails\n\nTo enhance security for outgoing email and improve deliverability, the [DKIM](https://read.calvincode.net/reader?url=http://www.dkim.org/) standard adds an encrypted signature to the header of all outgoing messages. Email servers that receive signed messages use DKIM to decrypt the message header and verify the message was not changed after it was sent.\n\nThis guide explains how to use the [Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api?endpoint=post-/api/mail-service/pvt/providers/-EmailProvider-/dkim) to generate DKIM keys that can be stored in your DNS provider so that all transactional emails sent by VTEX can be recognized as legitimate.\n\n> These instructions only apply if the [sender](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/transactional-emails--6IkJwttMw5T84mlY9RifRP/42LVaxtFb2VHX9xTZU58qC) is set up using VTEX mail servers. If you use your own SMTP provider, you need to enable DKIM in your mail server.\n\n## DKIM endpoint\n\nIt is necessary to use the `POST` [Generate DKIM keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api?endpoint=post-/api/mail-service/pvt/providers/-EmailProvider-/dkim) endpoint from Message Center API, as follows:\n\n`POST https://{accountName}.{environment}.com.br/api/mail-service/pvt/providers/{EmailProvider}/dkim`\n\n* `{accountName}` should be replaced with your store account name (e.g. `apiexamples`).\n* `{environment}` should be replaced with the environment you are using (e.g. `vtexcommercestable`).\n* `{EmailProvider}` should be replaced with the configured email address (e.g. `help@valdie.co`).\n\nSee the [Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api?endpoint=post-/api/mail-service/pvt/providers/-EmailProvider-/dkim) reference for more details.\n\n## Generating a DKIM key for your domain\n\nFollow the steps below to create a DKIM key for your domain:\n\n1. Make a request to the `POST` [Generate DKIM keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api?endpoint=post-/api/mail-service/pvt/providers/-EmailProvider-/dkim) endpoint. \nBefore you have [set up a sender in Message Center](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/transactional-emails--6IkJwttMw5T84mlY9RifRP) using VTEX mail servers, this is the expected response from the DKIM endpoint: \n`1 \n{ \n2 \n \"status\": \"emailNotFound\", \n3 \n \"dkimKeys\": null \n4 \n} \n`\n2. Follow [this guide](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/transactional-emails--6IkJwttMw5T84mlY9RifRP%23senders) to set up a sender on Message Center. \nOnce the sender has been set up, you should receive an email from Amazon Web Services requesting you to authorize the configured email address to use [Amazon SES](https://read.calvincode.net/reader?url=https://aws.amazon.com/ses/), as illustrated below: \n\n3. Click the confirmation link provided in the email body to verify you are the owner of the configured email address. This is required for the mail server to send mail on your behalf. \nUntil this is done, this is the expected response from the DKIM endpoint: \n`1 \n{ \n2 \n \"status\": \"emailNotVerified\", \n3 \n \"dkimKeys\": null \n4 \n} \n`\n4. Once you have clicked the confirmation link, test your SMTP configuration on VTEX Admin at **Email Templates > Senders** by clicking the ✅**Test** button, as shown in the image below: \n \nYou should receive an email from the VTEX mail server using the sender you selected. The email message sent follows the Message Center template `messageservice_teste_email`, which you can customize as in the image below by following the [How to create and edit transactional email templates](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/transactional-emails--6IkJwttMw5T84mlY9RifRP/335JZKUYgvYlGOJgvJYxRO) guide. \n \n> If you do not receive any messages, review your sender configuration and try again.\n5. Once you have correctly set up a sender in Message Center using VTEX mail servers, make a request to `POST` [Generate DKIM keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api?endpoint=post-/api/mail-service/pvt/providers/-EmailProvider-/dkim) endpoint again. \nThe response should be similar to the one below: \n`1 \n{ \n2 \n \"status\": \"created\", \n3 \n \"dkimKeys\": [ \n4 \n \"'n4zbltwizctxpgcmqrars4bmfdd3zlyo._domainkey.valdie.co','CNAME','n4zbltwizctxpgcmqrars4bmfdd3zlyo.dkim.amazonses.com'\", \n5 \n \"'sq3iae4be52fhqq3wm44btttvndeecfv._domainkey.valdie.co','CNAME','sq3iae4be52fhqq3wm44btttvndeecfv.dkim.amazonses.com'\", \n6 \n \"'n4z5g2g7yfy4pnhjklfesxrrkt4o2ha4._domainkey.valdie.co','CNAME','n4z5g2g7yfy4pnhjklfesxrrkt4o2ha4.dkim.amazonses.com'\" \n7 \n ] \n8 \n} \n`\n\n## Adding the public key to your DNS records\n\nNow that you have generated a DKIM key for your domain, you need to add the values listed in dkimKeys in your DNS records. Read the documentation for your [domain name](https://read.calvincode.net/reader?url=https://support.google.com/a/answer/48323) for specific instructions on how to do that, but this is the general flow:\n\n1. Sign in to the management console for your domain host.\n2. Locate the page where you update DNS records.\n3. Add a CNAME record for each corresponding DKIM key.\n4. Save changes.\n\nIn up to 72 hours, all settings will be applied automatically, and our servers will start adding a DKIM signature to all outgoing messages.\n\nContributors\n\n5\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/mateussaggin)\n\n[](https://github.com/GeorgeLimaDev)\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/api-guides/setting-up-dkim-for-transactional-emails.md)\n\n[vtex.js for Catalog« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails//docs/guides/vtexjs-for-catalog)[Setting up the SPFNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails//docs/guides/setting-up-the-spf)\n\nContributors\n\n5\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/mateussaggin)\n\n[](https://github.com/GeorgeLimaDev)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[DKIM endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/setting-up-dkim-for-transactional-emails%23dkim-endpoint)\n\n[Generating a DKIM key for your domain](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/setting-up-dkim-for-transactional-emails%23generating-a-dkim-key-for-your-domain)\n\n[Adding the public key to your DNS records](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/setting-up-dkim-for-transactional-emails%23adding-the-public-key-to-your-dns-records)\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/api-guides/setting-up-dkim-for-transactional-emails.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[DKIM endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/setting-up-dkim-for-transactional-emails%23dkim-endpoint)\n\n[Generating a DKIM key for your domain](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/setting-up-dkim-for-transactional-emails%23generating-a-dkim-key-for-your-domain)\n\n[Adding the public key to your DNS records](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/setting-up-dkim-for-transactional-emails%23adding-the-public-key-to-your-dns-records)\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_f66d90fe
|
[
{
"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 shipping simulation 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-shipping-simulation/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-shipping-simulation/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-shipping-simulation/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-shipping-simulation/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-shipping-simulation/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-shipping-simulation/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-shipping-simulation/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-shipping-simulation/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-shipping-simulation/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/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-shipping-simulation/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/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-shipping-simulation/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-overview)\n\n[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-banner-text)\n\n[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-cart-sidebar)\n\n[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-empty-state)\n\n[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-filter-slider)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-filter)\n\n[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-hero)\n\n[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-image-gallery)\n\n[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-navbar-slider)\n\n[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-navbar)\n\n[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-newsletter)\n\n[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-out-of-stock)\n\n[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-payment-methods)\n\n[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-price-range)\n\n[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-product-grid)\n\n[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-product-shelf)\n\n[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-region-modal)\n\n[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-search-input)\n\n[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-shipping-simulation)\n\n[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/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-shipping-simulation/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/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-shipping-simulation/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-shipping-simulation/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-shipping-simulation/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-shipping-simulation/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/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-shipping-simulation/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-shipping-simulation/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/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-shipping-simulation/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-shipping-simulation/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/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-shipping-simulation/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/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-shipping-simulation/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-overview)\n\n[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-banner-text)\n\n[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-cart-sidebar)\n\n[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-empty-state)\n\n[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-filter-slider)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-filter)\n\n[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-hero)\n\n[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-image-gallery)\n\n[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-navbar-slider)\n\n[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-navbar)\n\n[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-newsletter)\n\n[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-out-of-stock)\n\n[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-payment-methods)\n\n[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-price-range)\n\n[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-product-grid)\n\n[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-product-shelf)\n\n[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-region-modal)\n\n[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-search-input)\n\n[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-shipping-simulation)\n\n[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/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-shipping-simulation/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/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-shipping-simulation/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-shipping-simulation/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-shipping-simulation/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-shipping-simulation/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/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-shipping-simulation/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-shipping-simulation/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-shipping-simulation/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/components-index)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-overview)\n\nShippingSimulation\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/ShippingSimulation)\n\nThe `ShippingSimulation` component lets customers set the `PostalCode` and see the shipping options in the `PDP`.\n\nExample\n\nCode\n\n## Shipping\n\nPostal Code\n\n[I don't know my Postal Code](/)\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { ShippingSimulation } 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/ShippingSimulation/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-shipping-simulation-text-size | var(--fs-text-size-legend) |\n\n### Title\n\n| Local token | Default value/Global token linked |\n| ---------------------------------------------- | --------------------------------- |\n| \\--fs-shipping-simulation-title-padding-bottom | var(--fs-spacing-2) |\n| \\--fs-shipping-simulation-title-font-size | var(--fs-text-size-3) |\n| \\--fs-shipping-simulation-title-font-weight | var(--fs-text-weight-bold) |\n| \\--fs-shipping-simulation-title-line-height | 1.2 |\n\n### Link\n\n| Local token | Default value/Global token linked |\n| ------------------------------------------ | --------------------------------- |\n| \\--fs-shipping-simulation-link-padding-top | var(--fs-spacing-1) |\n\n### Header\n\n| Local token | Default value/Global token linked |\n| -------------------------------------------- | --------------------------------- |\n| \\--fs-shipping-simulation-header-padding-top | var(--fs-spacing-3) |\n\n### Subtitle\n\n| Local token | Default value/Global token linked |\n| ---------------------------------------------- | --------------------------------- |\n| \\--fs-shipping-simulation-subtitle-size | var(--fs-text-size-2) |\n| \\--fs-shipping-simulation-subtitle-weight | var(--fs-text-weight-bold) |\n| \\--fs-shipping-simulation-subtitle-line-height | 1.5 |\n\n### Location\n\n| Local token | Default value/Global token linked |\n| ------------------------------------------------- | --------------------------------- |\n| \\--fs-shipping-simulation-location-padding-bottom | var(--fs-spacing-2) |\n| \\--fs-shipping-simulation-location-font-size | var(--fs-text-size-2) |\n| \\--fs-shipping-simulation-location-line-height | 1.5 |\n\n---\n\n## Data attributes\n\nYou can target and override `ShippingSimulation` styles using the following data attributes:\n\n`data-fs-shipping-simulation`\n\n`data-fs-shipping-simulation-title`\n\n`data-fs-shipping-simulation-link`\n\n`data-fs-shipping-simulation-header`\n\n`data-fs-shipping-simulation-subtitle`\n\n`data-fs-shipping-simulation-location`\n\n---\n\n## Props\n\n### ShippingSimulation\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-shipping-simulation |\n| **formatter\\*** | PriceFormatter | Formatter function that transforms the raw price value and render the result. | |\n| **title** | string | The Shipping Suggestions Section's title. | Shipping |\n| **inputLabel** | string | The text displayed to Shipping Simulation input text. | Postal Code |\n| **optionsLabel** | string | The text displayed in Shipping options table. | Shipping options |\n| **idkPostalCodeLinkProps** | Partial<LinkProps<LinkElementType>> | Props for the link \\`I don't know my Postal Code\\`. | |\n| **onInput** | (event: React.FormEvent<HTMLInputElement>) => void | Callback function when input is typed. | |\n| **onSubmit** | () => void | Callback function when form is submitted. | |\n| **onClear** | () => void | Callback function when the input clear button is clicked. | |\n| **location** | string | Location for shipping. | |\n| **address** | Address | Address for shipping. | |\n| **options** | ShippingSLA\\[\\] | Options for shipping simulation. | \\[\\] |\n| **displayClearButton** | false \\| true | Show clear button. | false |\n| **errorMessage** | string | Message of error for input. | |\n| **postalCode** | string | Postal code. | |\n\n### ShippingSLA\n\n| Name | Type | Description | Default |\n| ------------------------ | ------ | ---------------------------------------- | ------- |\n| **carrier\\*** | string | ShippingSLA carrier. | |\n| **localizedEstimates\\*** | string | ShippingSLA localized shipping estimate. | |\n| **price\\*** | number | ShippingSLA price. | |\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/shipping-simulation.mdx)\n\n[SearchInput« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-search-input)[SlideOverNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-slide-over)\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-shipping-simulation/docs/guides/faststore/organisms-shipping-simulation%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-shipping-simulation%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-shipping-simulation%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-shipping-simulation%23design-tokens)\n\n[Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-shipping-simulation%23title)[Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-shipping-simulation%23link)[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-shipping-simulation%23header)[Subtitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-shipping-simulation%23subtitle)[Location](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-shipping-simulation%23location)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-shipping-simulation%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-shipping-simulation%23props)\n\n[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-shipping-simulation%23shippingsimulation)[ShippingSLA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-shipping-simulation%23shippingsla)\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/shipping-simulation.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-shipping-simulation/docs/guides/faststore/organisms-shipping-simulation%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-shipping-simulation%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-shipping-simulation%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-shipping-simulation%23design-tokens)\n\n[Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-shipping-simulation%23title)[Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-shipping-simulation%23link)[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-shipping-simulation%23header)[Subtitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-shipping-simulation%23subtitle)[Location](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-shipping-simulation%23location)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-shipping-simulation%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-shipping-simulation%23props)\n\n[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-shipping-simulation%23shippingsimulation)[ShippingSLA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-shipping-simulation/docs/guides/faststore/organisms-shipping-simulation%23shippingsla)\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_2668485b
|
[
{
"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 cart items 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-cart-items/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/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-cart-items/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-cart-items/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-cart-items/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-cart-items/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-cart-items/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/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-cart-items/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/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-cart-items/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-cart-items/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-cart-items/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-cart-items/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-cart-items/docs/guides/remove-all-personal-data)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/add-cart-items)\n\n[Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/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-cart-items/docs/guides/change-price)\n\n[Ignore profile data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/ignore-profile-data)\n\n[Get cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/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-cart-items/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-cart-items/docs/guides/add-service-to-the-cart)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/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-cart-items/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/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-cart-items/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-cart-items/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/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-cart-items/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/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-cart-items/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-cart-items/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/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-cart-items/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/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-cart-items/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-cart-items/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-cart-items/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-cart-items/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-cart-items/docs/guides/remove-all-personal-data)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/add-cart-items)\n\n[Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/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-cart-items/docs/guides/change-price)\n\n[Ignore profile data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/ignore-profile-data)\n\n[Get cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/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-cart-items/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-cart-items/docs/guides/add-service-to-the-cart)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/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-cart-items/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/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-cart-items/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-cart-items/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/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-cart-items/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/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-cart-items/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-cart-items/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/checkout-api-overview)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/add-cart-items)\n\nAdd cart items\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 new items to a shopping cart by the 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 items. For more information, access the [Get 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 items to the shopping cart\n\nTo add items to the shopping cart, you need to use the [Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/items) endpoint. In this request, you must send the following information through the URL:\n\n* **Path param**: `orderFormId` value.\n* **Query param**: `allowedOutdatedData`. You can set up this query as `false` or `true` to define whether some cart information can be updated through the minicart.\n\nSee a URL example below:\n\n`https://accountname.environment.com.br/api/checkout/pub/orderForm/ede846222cd44046ba6c638442c3505a/items?allowedOutdatedData=paymentData`\n\nAdditionally, you must send the request body containing the following information about the new item to be added to the cart:\n\n* `quantity`\n* `seller`\n* `id`\n* `index`\n* `price`\n\n> ️ `price` should be sent only in case you want to make a bulk price change.\n\nSee a request body example below:\n\n`1\n\n{ \n\n2\n\n \"orderItems\": [ \n\n3\n\n { \n\n4\n\n \"quantity\": 3, \n\n5\n\n \"seller\": \"cosmetics1\", \n\n6\n\n \"id\": \"2005\", \n\n7\n\n \"index\": 0 \n\n8\n\n } \n\n9\n\n ] \n\n10\n\n} \n\n`\n\nAfter sending the request, the endpoint will return the response body containing the shopping cart information including the new item added, as shown in the example below:\n\n`1\n\n... \n\n2\n\n\"items\": [ \n\n3\n\n { \n\n4\n\n \"uniqueId\": \"D1E0949706A3441DA0386929FAB6E7E8\", \n\n5\n\n \"id\": \"2005\", \n\n6\n\n \"productId\": \"3\", \n\n7\n\n \"productRefId\": \"\", \n\n8\n\n \"refId\": null, \n\n9\n\n \"ean\": \"978020137962\", \n\n10\n\n \"name\": \"Weightless Waves Mild Lather Cleanser 50 ml\", \n\n11\n\n \"skuName\": \"50 ml\", \n\n12\n\n \"modalType\": null, \n\n13\n\n \"parentItemIndex\": null, \n\n14\n\n \"parentAssemblyBinding\": null, \n\n15\n\n \"assemblies\": [], \n\n16\n\n \"priceValidUntil\": \"2023-11-07T22:14:44Z\", \n\n17\n\n \"tax\": 0, \n\n18\n\n \"taxCode\": \"54WC8ZN6K8\", \n\n19\n\n \"price\": 3190, \n\n20\n\n \"listPrice\": 3190, \n\n21\n\n \"manualPrice\": null, \n\n22\n\n \"manualPriceAppliedBy\": null, \n\n23\n\n \"sellingPrice\": 3107, \n\n24\n\n \"rewardValue\": 0, \n\n25\n\n \"isGift\": false, \n\n26\n\n \"additionalInfo\": { \n\n27\n\n \"dimension\": null, \n\n28\n\n \"brandName\": \"VALDIE&CO\", \n\n29\n\n \"brandId\": \"2000000\", \n\n30\n\n \"offeringInfo\": null, \n\n31\n\n \"offeringType\": null, \n\n32\n\n \"offeringTypeId\": null \n\n33\n\n }, \n\n34\n\n \"preSaleDate\": null, \n\n35\n\n \"productCategoryIds\": \"/2/\", \n\n36\n\n \"productCategories\": { \n\n37\n\n \"2\": \"Computers\" \n\n38\n\n }, \n\n39\n\n \"quantity\": 3, \n\n40\n\n \"seller\": \"cosmetics1\", \n\n41\n\n \"sellerChain\": [ \n\n42\n\n \"cosmetics1\" \n\n43\n\n ], \n\n44\n\n \"imageUrl\": \"http://cosmetics2.vteximg.com.br/arquivos/ids/155401-55-55/ID-001-MAIN.jpg?v=637109313796670000\", \n\n45\n\n \"detailUrl\": \"/weightless-waves-mild-lather-cleanser/p\", \n\n46\n\n \"components\": [], \n\n47\n\n \"bundleItems\": [], \n\n48\n\n \"attachments\": [], \n\n49\n\n \"attachmentOfferings\": [], \n\n50\n\n \"offerings\": [], \n\n51\n\n \"priceTags\": [ \n\n52\n\n { \n\n53\n\n \"name\": \"discount@price-0e45a4e3-6084-4bf9-bff7-0fe8403699fc#ac2d3d37-5845-45a6-9254-191449d6f100\", \n\n54\n\n \"value\": -416, \n\n55\n\n \"rawValue\": -4.160, \n\n56\n\n \"isPercentual\": false, \n\n57\n\n \"identifier\": \"0e45a4e3-6084-4bf9-bff7-0fe8403699fc\", \n\n58\n\n \"owner\": \"cosmetics2\" \n\n59\n\n } \n\n60\n\n ], \n\n61\n\n \"availability\": \"available\", \n\n62\n\n \"measurementUnit\": \"un\", \n\n63\n\n \"unitMultiplier\": 1.0000, \n\n64\n\n \"manufacturerCode\": null, \n\n65\n\n \"priceDefinition\": { \n\n66\n\n \"calculatedSellingPrice\": 3107, \n\n67\n\n \"total\": 15534, \n\n68\n\n \"sellingPrices\": [ \n\n69\n\n { \n\n70\n\n \"value\": 3107, \n\n71\n\n \"quantity\": 4 \n\n72\n\n }, \n\n73\n\n { \n\n74\n\n \"value\": 3106, \n\n75\n\n \"quantity\": 1 \n\n76\n\n } \n\n77\n\n ] \n\n78\n\n } \n\n79\n\n }, \n\n80\n\n... \n\n`\n\n> ️ For more information about the meaning of each of the fields available in the shopping cart, access the [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) overview.\n\n## Error codes\n\nThe following errors may appear as a message in the response body.\n\n### 400 - Bad Request\n\n* **Message error example (code ORD002)**: `\"Invalid order form\"`. The `orderFormId` information is not valid.\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"ORD002\", \n\n5\n\n \"message\": \"Invalid order form\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"5d9f54e6-7db4-46d6-bca9-deeb278b8b98\" \n\n9\n\n} \n\n`\n\n* **Message error example (code CHK0024)**: `\"Invalid seller for item\"`. This message indicates that the `seller` used in the request does not exist, is incorrect or has not been informed.\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\": \"Invalid seller for item\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"abe5d1b9-a85f-4f10-a3e8-f783082c5c3d\" \n\n9\n\n} \n\n`\n\n### 403 - Forbidden\n\n* **Message error example (code CHK003)**: `\"Access denied\"`. This message indicates that it is not possible to make a bulk price change on this item.\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"CHK003\", \n\n5\n\n \"message\": \"Access denied\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"a6ea8b84-68d9-43a7-902e-846e8c5c05b6\" \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\n2\n\n[](https://github.com/geisecosta)\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-cart-items.md)\n\n[Remove all personal data from cart« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items//docs/guides/remove-all-personal-data)[Update cart itemsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items//docs/guides/update-cart-items)\n\nContributors\n\n2\n\n[](https://github.com/geisecosta)\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-cart-items/docs/guides/add-cart-items%23getting-shopping-cart-information)\n\n[Adding items to the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/add-cart-items%23adding-items-to-the-shopping-cart)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/add-cart-items%23error-codes)\n\n[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/add-cart-items%23400-bad-request)[403 - Forbidden](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/add-cart-items%23403-forbidden)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/add-cart-items%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-cart-items.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-cart-items/docs/guides/add-cart-items%23getting-shopping-cart-information)\n\n[Adding items to the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/add-cart-items%23adding-items-to-the-shopping-cart)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/add-cart-items%23error-codes)\n\n[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/add-cart-items%23400-bad-request)[403 - Forbidden](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/add-cart-items%23403-forbidden)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-cart-items/docs/guides/add-cart-items%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_4a9e0f6a
|
[
{
"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 empty state 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-empty-state/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-empty-state/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-empty-state/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-empty-state/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-empty-state/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-empty-state/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-empty-state/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-empty-state/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-empty-state/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/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-empty-state/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/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-empty-state/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-overview)\n\n[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-banner-text)\n\n[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-cart-sidebar)\n\n[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-empty-state)\n\n[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-filter-slider)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-filter)\n\n[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-hero)\n\n[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-image-gallery)\n\n[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-navbar-slider)\n\n[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-navbar)\n\n[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-newsletter)\n\n[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-out-of-stock)\n\n[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-payment-methods)\n\n[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-price-range)\n\n[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-product-grid)\n\n[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-product-shelf)\n\n[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-region-modal)\n\n[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-search-input)\n\n[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-shipping-simulation)\n\n[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/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-empty-state/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/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-empty-state/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-empty-state/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-empty-state/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-empty-state/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/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-empty-state/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-empty-state/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/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-empty-state/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-empty-state/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/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-empty-state/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/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-empty-state/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-overview)\n\n[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-banner-text)\n\n[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-cart-sidebar)\n\n[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-empty-state)\n\n[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-filter-slider)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-filter)\n\n[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-hero)\n\n[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-image-gallery)\n\n[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-navbar-slider)\n\n[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-navbar)\n\n[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-newsletter)\n\n[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-out-of-stock)\n\n[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-payment-methods)\n\n[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-price-range)\n\n[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-product-grid)\n\n[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-product-shelf)\n\n[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-region-modal)\n\n[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-search-input)\n\n[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-shipping-simulation)\n\n[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/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-empty-state/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/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-empty-state/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-empty-state/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-empty-state/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-empty-state/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/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-empty-state/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-empty-state/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-empty-state/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/components-index)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-overview)\n\nEmptyState\n\nRepresents the component's empty state while the main content is loading.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/organisms/EmptyState)\n\nThe `EmptyState` can be used to represent an empty state.\n\nExample\n\nCode\n\nYour Cart is empty\n\nStart Shopping\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { EmptyState } 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/EmptyState/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#### Rounded\n\nExample\n\nCode\n\nNothing matches with your search\n\nBrowse Offers\n\n## Design tokens\n\n| Local token | Default value/Global token linked |\n| ---------------------------- | --------------------------------- |\n| \\--fs-empty-state-height | 100% |\n| \\--fs-empty-state-min-height | 50vh |\n| \\--fs-empty-state-padding | 0 var(--fs-spacing-8) |\n\n### Design tokens: Title\n\n| Local token | Default value/Global token linked |\n| ------------------------------------- | --------------------------------- |\n| \\--fs-empty-state-title-margin-bottom | var(--fs-spacing-2) |\n| \\--fs-empty-state-title-color | var(--fs-color-disabled-text) |\n| \\--fs-empty-state-title-size | var(--fs-text-size-lead) |\n\n### Design tokens: Link\n\n| Local token | Default value/Global token linked |\n| -------------------------------- | --------------------------------- |\n| \\--fs-empty-state-link-min-width | 11.875rem |\n\n### Design tokens: Rounded\n\n| Local token | Default value/Global token linked |\n| ------------------------------- | --------------------------------- |\n| \\--fs-empty-state-border-radius | var(--fs-border-radius) |\n\n### Design tokens: Default background color\n\n| Local token | Default value/Global token linked |\n| ----------------------------------- | --------------------------------- |\n| \\--fs-empty-state-bkg-color-default | var(--fs-color-neutral-bkg) |\n\n### Design tokens: White background color\n\n| Local token | Default value/Global token linked |\n| --------------------------------- | --------------------------------- |\n| \\--fs-empty-state-bkg-color-light | var(--fs-color-body-bkg) |\n\n---\n\n## Data attributes\n\nYou can target and override `EmptyState` styles using the following data attributes:\n\n`data-fs-empty-state`\n\n`data-fs-empty-state-title`\n\n`data-fs-empty-state-variant=\"default | rounded\"`\n\n`data-fs-empty-state-bkg-color=\"default | white\"`\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-empty-state | | | | | | |\n| **title** | string | The EmptyState component's title. | | | | | | | |\n| **titleIcon** | string \\| number | false | true | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | A React component that will be rendered as an icon on the Title. |\n| **variant** | \"default\" \\| \"rounded\" | Specifies the component border variant. | default | | | | | | |\n| **bkgColor** | \"default\" \\| \"light\" | Specifies the component background color. | default | | | | | | |\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/empty-state.mdx)\n\n[CartSidebar« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-cart-sidebar)[FilterSliderNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-filter-slider)\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-empty-state/docs/guides/faststore/organisms-empty-state%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-empty-state%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-empty-state%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-empty-state%23examples)\n\n[Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-empty-state%23variants)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-empty-state%23design-tokens)\n\n[Design tokens: Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-empty-state%23design-tokens-title)[Design tokens: Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-empty-state%23design-tokens-link)[Design tokens: Rounded](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-empty-state%23design-tokens-rounded)[Design tokens: Default background color](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-empty-state%23design-tokens-default-background-color)[Design tokens: White background color](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-empty-state%23design-tokens-white-background-color)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-empty-state%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-empty-state%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/empty-state.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-empty-state/docs/guides/faststore/organisms-empty-state%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-empty-state%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-empty-state%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-empty-state%23examples)\n\n[Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-empty-state%23variants)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-empty-state%23design-tokens)\n\n[Design tokens: Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-empty-state%23design-tokens-title)[Design tokens: Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-empty-state%23design-tokens-link)[Design tokens: Rounded](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-empty-state%23design-tokens-rounded)[Design tokens: Default background color](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-empty-state%23design-tokens-default-background-color)[Design tokens: White background color](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-empty-state%23design-tokens-white-background-color)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-empty-state%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-empty-state/docs/guides/faststore/organisms-empty-state%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_b133fdbb
|
[
{
"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 product 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/faststore/organisms-product-shelf/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-product-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/faststore/organisms-product-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/faststore/organisms-product-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/faststore/organisms-product-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/faststore/organisms-product-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/faststore/organisms-product-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/faststore/organisms-product-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/faststore/organisms-product-shelf/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/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-product-shelf/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/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-product-shelf/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-overview)\n\n[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-banner-text)\n\n[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-cart-sidebar)\n\n[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-empty-state)\n\n[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-filter-slider)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-filter)\n\n[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-hero)\n\n[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-image-gallery)\n\n[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-navbar-slider)\n\n[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-navbar)\n\n[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-newsletter)\n\n[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-out-of-stock)\n\n[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-payment-methods)\n\n[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-price-range)\n\n[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-grid)\n\n[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf)\n\n[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-region-modal)\n\n[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-search-input)\n\n[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-shipping-simulation)\n\n[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/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-product-shelf/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/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-product-shelf/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-product-shelf/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-product-shelf/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-product-shelf/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/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-product-shelf/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-product-shelf/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-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/faststore/organisms-product-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/faststore/organisms-product-shelf/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/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-product-shelf/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/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-product-shelf/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-overview)\n\n[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-banner-text)\n\n[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-cart-sidebar)\n\n[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-empty-state)\n\n[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-filter-slider)\n\n[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-filter)\n\n[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-hero)\n\n[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-image-gallery)\n\n[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-navbar-slider)\n\n[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-navbar)\n\n[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-newsletter)\n\n[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-out-of-stock)\n\n[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-payment-methods)\n\n[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-price-range)\n\n[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-grid)\n\n[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf)\n\n[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-region-modal)\n\n[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-search-input)\n\n[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-shipping-simulation)\n\n[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/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-product-shelf/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/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-product-shelf/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-product-shelf/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-product-shelf/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-product-shelf/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/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-product-shelf/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-product-shelf/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-product-shelf/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/components-index)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-overview)\n\nProductShelf\n\nDisplays a list of products to be used as a section on the store.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/organisms/ProductShelf)\n\nThe `ProductShelf` component Displays a list of products to be used as a section on the store.The `ProductShelf` is a compound of the following:\n\n* `ProductShelfItems`: the product list.\n* `ProductShelfItem`: wraps the product inside a list item.\n* `ProductCard`: the proposed child of a `ProductShelf`.\n\nExample\n\nCode\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---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { \n\n2\n\n ProductShelf, \n\n3\n\n ProductShelfItems, \n\n4\n\n ProductShelfItem, \n\n5\n\n} from \"@faststore/ui\"; \n\n`\n\nWe highly recommend using the [ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-card) as the direct child of the `ProductShelfItem`.\n\n`1\n\nimport { \n\n2\n\n ProductCard, \n\n3\n\n ProductCardContent, \n\n4\n\n ProductCardImage, \n\n5\n\n} from \"@faststore/ui\"; \n\n`\n\n### Import styles\n\nTo apply styles, include the following in your stylesheet:\n\n`1\n\n@import \"@faststore/ui/src/components/organisms/ProductShelf/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\nYou can use [ProductCard variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-card%23variants) to create `ProductShelf` variations.\n\n### With Button\n\nExample\n\nCode\n\n*  \n### Apple Magic Mouse \nOriginal price:$999Price:$950.04 \nAdd\n*  \n### 4k Philips Monitor 27” \nOriginal price:$490Price:$420 \nAdd\n*  \n### Echo Dot Smart Speaker \nOriginal price:$310Price:$280 \nAdd\n*  \n### Aedle VK-1 L Headphone \nOriginal price:$150Price:$130 \nAdd\n\n### Bordered\n\nExample\n\nCode\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### Aspect Ratio\n\nExample\n\nCode\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### With [Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel)\n\nExample\n\nCode\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---\n\n## Design tokens\n\n### Items\n\n| Local token | Default value/Global token linked |\n| ---------------------------------------- | --------------------------------- |\n| \\--fs-product-shelf-items-gap | var(--fs-grid-gap-1) |\n| \\--fs-product-shelf-items-padding-top | var(--fs-spacing-0) |\n| \\--fs-product-shelf-items-padding-bottom | var(--fs-spacing-3) |\n\n---\n\n## Data attributes\n\nYou can target and override `ProductShelf` styles using the following data attributes:`data-fs-product-shelf`\n\n`data-fs-product-shelf-items`\n\n`data-fs-product-shelf-item`\n\n---\n\n## Props\n\nAll `ProductShelf` related components support all attributes also supported by their respective HTML tags. Besides those attributes, the following props are also supported:\n\n### ProductShelf\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-product-shelf |\n\n### ProductShelfItems\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-product-shelf-items |\n\n### ProductShelfItem\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-product-shelf-item |\n\n---\n\n## Best Practices\n\n### ❌ Don'ts\n\n* We don't recommend using [Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel) inside `ProductShelf` when display 5 or less items.\n* We don't recommend using `ProductShelfItems` and `ProductShelfItem` when using Carousel component to avoid: `validateDOMNesting(...): <li> cannot appear as a descendant of <li>` issue.\n\nSee [Carousel Code Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf%23with-carousel)\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/product-shelf.mdx)\n\n[ProductGrid« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-grid)[RegionModalNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-region-modal)\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-product-shelf/docs/guides/faststore/organisms-product-shelf%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23examples)\n\n[With Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23with-button)[Bordered](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23bordered)[Aspect Ratio](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23aspect-ratio)[With Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23with-carousel)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23design-tokens)\n\n[Items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23items)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23props)\n\n[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23productshelf)[ProductShelfItems](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23productshelfitems)[ProductShelfItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23productshelfitem)\n\n[Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23best-practices)\n\n[❌ Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23-donts)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/organisms/product-shelf.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-product-shelf/docs/guides/faststore/organisms-product-shelf%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23examples)\n\n[With Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23with-button)[Bordered](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23bordered)[Aspect Ratio](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23aspect-ratio)[With Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23with-carousel)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23design-tokens)\n\n[Items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23items)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23props)\n\n[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23productshelf)[ProductShelfItems](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23productshelfitems)[ProductShelfItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23productshelfitem)\n\n[Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23best-practices)\n\n[❌ Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf/docs/guides/faststore/organisms-product-shelf%23-donts)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_f7a15ddf
|
[
{
"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 productsummaryskuname 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/productsummaryskuname/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/productsummaryskuname/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/productsummaryskuname/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/productsummaryskuname/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/productsummaryskuname/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/productsummaryskuname/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/productsummaryskuname/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/productsummaryskuname/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/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/productsummaryskuname/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/productsummaryskuname/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/productsummaryskuname/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/productsummaryskuname/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/productsummaryskuname/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/productsummaryskuname/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/productsummaryskuname/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/productsummaryskuname/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/productsummaryskuname/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/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/productsummaryskuname/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/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/productsummaryskuname/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/productsummaryskuname/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/productsummaryskuname/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/productsummaryskuname/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/productsummaryskuname/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/productsummaryskuname/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/productsummaryskuname/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/productsummaryskuname/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/productsummaryskuname/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/guides/basic-components)\n\nProduct Summary SKU Name\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\nProduct Summary SKU Name is a block exported by the [Product Summary app](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-product-summary) responsible for rendering the selected SKU's name.\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-sku-name` block to your store theme as a child of `product-summary.shelf`. 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\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| skuNameContainer |\n\n[Product Summary SKU Selector« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-summary/productsummaryskuselector)[Rich TextNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.rich-text)\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/productsummaryskuname/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[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-summary/productsummaryskuname%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryskuname/docs/apps/vtex.product-summary/productsummaryskuname%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_88e7ba72
|
[
{
"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 building sections 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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-list-of-native-sections/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-list-of-native-sections/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-list-of-native-sections/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-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/building-sections-list-of-native-sections/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-list-of-native-sections/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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_e9189b2a
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore storefront features implementing regionalization features in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/storefront-features-overview)\n\n[Adding third-party scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/storefront-features-handling-third-party-scripts)\n\n[Building navigation menus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/storefront-features-building-navigation-menus)\n\n[Displaying content for authenticated users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users)\n\n[Implementing regionalization features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/storefront-features-implementing-regionalization-features)\n\n[Implementing search features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/storefront-features-implementing-search-features)\n\n[Managing product images in specific contexts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/storefront-features-managing-product-images-in-specific-contexts)\n\n[Implementing Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/delivery-promise-implementation)\n\n[Implementing Live Shopping for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/storefront-features-overview)\n\n[Adding third-party scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/storefront-features-handling-third-party-scripts)\n\n[Building navigation menus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/storefront-features-building-navigation-menus)\n\n[Displaying content for authenticated users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users)\n\n[Implementing regionalization features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/storefront-features-implementing-regionalization-features)\n\n[Implementing search features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/storefront-features-implementing-search-features)\n\n[Managing product images in specific contexts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/storefront-features-managing-product-images-in-specific-contexts)\n\n[Implementing Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/delivery-promise-implementation)\n\n[Implementing Live Shopping for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/storefront-features-overview)\n\nImplementing regionalization features\n\nThis feature enables customers to set a location using a valid Postal Code.\n\nRegionalization is a feature of [VTEX Intelligent Search](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/3qgT47zY08biLP3d5os3DG) that optimizes search results according to the availability of sellers in the customer's region.\n\nRegionalization uses a behavior from VTEX Intelligent Search called [Availability](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/7LMQbWK5nElIkXo0NK8Kux). It searches for products available in the inventory of sellers that serve a particular region.\n\nStores that have more than one registered white-label seller usually have specific inventories for each region. This is the case for supermarkets, for example.\n\nWith the Regionalization feature enabled, if a customer enters their Postal Code while browsing the store (before checkout), only products available in the corresponding region will be displayed in the search results.\n\n---\n\n## Usage\n\n1. Intentionally, a user sets its location using a postal code.\n2. Updates product catalog.\n3. Gets notified if there's a product conflict at Minicart.\n\n---\n\n## Components\n\n* Region Bar \nThe RegionBar is a custom Button, usually used on mobile devices only. It should trigger the RegionModal. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/molecules-region-bar)\n* Open Region Modal \nRegion Modal \nA modal with region configurations. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/organisms-region-modal)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/storefront-features/implementing-regionalization-features.mdx)\n\n[Displaying content for authenticated users« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users)[Implementing search featuresNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/storefront-features-implementing-search-features)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/storefront-features-implementing-regionalization-features%23usage)\n\n[Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/storefront-features-implementing-regionalization-features%23components)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/storefront-features/implementing-regionalization-features.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/storefront-features-implementing-regionalization-features%23usage)\n\n[Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/storefront-features-implementing-regionalization-features/docs/guides/faststore/storefront-features-implementing-regionalization-features%23components)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_4c2220d3
|
[
{
"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 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-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-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-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-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-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-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-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-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-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-google-tag-manager/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-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-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-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-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-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-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-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-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-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-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-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-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-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-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-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-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-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-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-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-google-tag-manager/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-tag-manager/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-tag-manager/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-tag-manager/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-tag-manager/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-tag-manager/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-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-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-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-google-tag-manager/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-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-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-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-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-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-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-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-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-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-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-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-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-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-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-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-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-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-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-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-google-tag-manager/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-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-google-tag-manager/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\nConfiguring Analytics (Google Tag Manager)\n\nDiscover how to manage Analytics on Store Framework using the Google Tag Manager app.\n\nTo manage Analytics on [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework), you need to install the [Google Tag Manager (GTM) app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager), which is a first-party solution that integrates your VTEX account with [Google Tag Manager](https://read.calvincode.net/reader?url=https://tagmanager.google.com), a JavaScript and HTML tag management system provided by Google for tracking user browsing.\n\nThe app allows you to manage website tags without accessing the store source code, allowing you to add, edit, or remove tags easily, and provides user browsing tracking for Google Analytics.\n\n> This app is only available for stores built with [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework). For stores built with Legacy CMS Portal, see [Configuring Google Tag Manager](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-to-setup-google-analytics-in-vtex-store--G2P0rmSrEiqCcmUMyUUwG%23configuring-google-tag-manager).\n\n\n\n[Installing Google Tag ManagerLearn how to install the Google Tag Manager app in your VTEX store.Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-tag-manager/docs/guides/vtex-io-documentation-installing-google-tag-manager)[Setting up Google Tag ManagerSet up the Google Tag Manager app with variables, triggers, and tags.Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/store-framework-configuring-analytics-google-tag-manager.md)\n\n[Using events to trigger side effects on store components« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-tag-manager//docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components)[Installing Google Tag ManagerNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-tag-manager//docs/guides/vtex-io-documentation-installing-google-tag-manager)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/store-framework-configuring-analytics-google-tag-manager.md)\n\nCopy page\n\nOn this page\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_9eae4075
|
[
{
"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 share 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-share/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-share/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-share/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-share/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-share/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-share/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-share/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-share/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-share/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-share/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-share/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-share/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-share/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-share/updates/release-notes)\n\nShare\n\nThe `Share` component allows shoppers to share a product URL via social media. This component can be imported and used by any VTEX app.\n\n\n\n## Configuration\n\n1. Import the `vtex.store-components` app to your theme's dependencies in the `manifest.json` file as in the following example:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.store-components\": \"3.x\" \n\n3\n\n } \n\n`\n\n1. Add the `share` block as a 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 \"share\" \n\n4\n\n ] \n\n5\n\n } \n\n`\n\n1. Then, declare the `share` block using the props stated in the [Props](#props) table. For example:\n\n`1\n\n \"share\": { \n\n2\n\n \"component\": \"Share\" \n\n3\n\n } \n\n`\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| --------------------- | ------- | -------------------------------------------- | ---------------------------------------------------------------- |\n| buttonsContainerClass | String | Button container classes. | true |\n| className | String | Main container classes. | null |\n| imageUrl | String | Image url to share in social medias. | |\n| options | Options | Share button options, such as size. | {} |\n| shareLabelClass | String | Share label classes. | true |\n| social | Social | Possible social media icons to be displayed. | {Facebook: true, Twitter: true, WhatsApp: true, Pinterest: true} |\n\n#### `options` props:\n\n| Prop name | Type | Description |\n| --------- | ------ | --------------------------------------- |\n| size | Number | The size of the share button in pixels. |\n\n#### `social` props:\n\n| Prop name | Type | Description |\n| --------- | ------- | --------------------------------------- |\n| Facebook | Boolean | If Facebook social media will be shown. |\n| Twitter | Boolean | If Twitter social media will be shown. |\n| WhatsApp | Boolean | If WhatsApp social media will be shown. |\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| shareButtons |\n| shareContainer |\n| shareLabel |\n| shareLoader |\n| shareSocialButton |\n| shareSocialIcon |\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/store-components/vtex-store-components-share.md)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-share/docs/guides/vtex-store-components-share%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-share/docs/guides/vtex-store-components-share%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-share/docs/guides/vtex-store-components-share%23customization)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/store-components/vtex-store-components-share.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-share/docs/guides/vtex-store-components-share%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-share/docs/guides/vtex-store-components-share%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-share/docs/guides/vtex-store-components-share%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_5b7a880b
|
[
{
"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 icon 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-icon/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-icon/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-icon/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-icon/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-icon/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-icon/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-icon/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-icon/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-icon/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/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-icon/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/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-icon/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-overview)\n\n[Badge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-badge)\n\n[Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-button)\n\n[Checkbox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-checkbox)\n\n[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-icon)\n\n[Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-input)\n\n[Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-label)\n\n[Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-link)\n\n[List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-list)\n\n[Loader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-loader)\n\n[Overlay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-overlay)\n\n[Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-price)\n\n[Radio](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-radio)\n\n[Select](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-select)\n\n[SROnly](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-sr-only)\n\n[Skeleton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-skeleton)\n\n[Slider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-slider)\n\n[Textarea](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-textarea)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/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-icon/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-icon/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-icon/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-icon/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/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-icon/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-icon/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/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-icon/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-icon/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/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-icon/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/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-icon/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-overview)\n\n[Badge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-badge)\n\n[Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-button)\n\n[Checkbox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-checkbox)\n\n[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-icon)\n\n[Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-input)\n\n[Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-label)\n\n[Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-link)\n\n[List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-list)\n\n[Loader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-loader)\n\n[Overlay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-overlay)\n\n[Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-price)\n\n[Radio](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-radio)\n\n[Select](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-select)\n\n[SROnly](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-sr-only)\n\n[Skeleton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-skeleton)\n\n[Slider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-slider)\n\n[Textarea](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-textarea)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/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-icon/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-icon/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-icon/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-icon/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/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-icon/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-icon/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-icon/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-overview)\n\nIcon\n\nIcons are simplified graphics that represent actions, statuses, and navigation elements, helping users navigate the UI.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/atoms/Icon)\n\nThe `Icon` component provides SVG-based icons from the FastStore [Iconography library](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons), built on top of [Phosphor Icons](https://read.calvincode.net/reader?url=https://phosphoricons.com).\n\nIcons are used across the interface to improve clarity and usability in different contexts, such as:\n\n* **Navigation:** Provide cues that help users move through menus, pages, and the homepage.\n* **User actions:** Represent tasks like adding items to the cart, sharing content, or saving to favorites.\n* **System feedback:** Indicate statuses such as information, success, warning, or error.\n* **Commerce elements:** Represent the cart, account, or checkout.\n* **Form inputs:** Improve field usability with search, clearing fields, toggling password visibility, or copying content.\n* **Menus and lists:** Indicate dropdowns, pagination, or breadcrumb trails.\n\n> Browse the full set of icons in [Iconography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons).\n\nExample\n\nCode\n\n> The default values for `width` and `height` are `24`.\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { Icon } 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/Icon/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### Weight\n\nUse the `weight` prop to control the visual stroke weight of the icon. Available options are `thin`, `light`, `regular` (default), and `bold`.\n\n#### Bold\n\nExample\n\nCode\n\n#### Light\n\nExample\n\nCode\n\n#### Regular (default)\n\nExample\n\nCode\n\n#### Thin\n\nExample\n\nCode\n\n### Size\n\nControl icon size with the `width` and `height` props. If omitted, both default to `24` (medium size).\n\n#### Small\n\nExample\n\nCode\n\n#### Medium (default)\n\nExample\n\nCode\n\n#### Large\n\nExample\n\nCode\n\n---\n\n## Design tokens\n\nThe `Icon` component does not expose specific design tokens. Customize its appearance using:\n\n* The [weight](#weight) prop (`thin`, `light`, `regular`, `bold`).\n* CSS selectors targeting the `[data-fs-icon]` data attribute for layout adjustments. The default theme applies only structural styles to this selector.\n\n---\n\n## Data attributes\n\nYou can target and override `Icon` styles using the following data attributes:\n\n`data-fs-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-icon | | |\n| **name\\*** | string | Symbol id from element to render. Take a look at \\`/static/icons.svg\\`. Example: <Icon name=\"Bell\" /> | | | |\n| **weight** | \"thin\" \\| \"light\" | \"regular\" | \"bold\" | SVG weight. | regular |\n| **width** | number | SVG width. | '24' | | |\n| **height** | number | SVG height. | '24' | | |\n\n---\n\n## Best practices\n\n### ✅ Do's\n\n* Ensure icons are visually consistent in weight and size within the same context.\n* Provide sufficient contrast against varied backgrounds.\n* Pair icons with text when meaning may be ambiguous.\n\n### ❌ Don'ts\n\n* Don't rely solely on color or the icon graphic to convey critical meaning.\n* Don't mix different icon weights within the same control or pattern.\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/icon.mdx)\n\n[Checkbox« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-checkbox)[InputNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-input)\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-icon/docs/guides/faststore/atoms-icon%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-icon%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-icon%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-icon%23examples)\n\n[Weight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-icon%23weight)[Size](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-icon%23size)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-icon%23design-tokens)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-icon%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-icon%23props)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-icon%23best-practices)\n\n[✅ Do's](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-icon%23-dos)[❌ Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-icon%23-donts)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/atoms/icon.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-icon/docs/guides/faststore/atoms-icon%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-icon%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-icon%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-icon%23examples)\n\n[Weight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-icon%23weight)[Size](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-icon%23size)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-icon%23design-tokens)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-icon%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-icon%23props)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-icon%23best-practices)\n\n[✅ Do's](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-icon%23-dos)[❌ Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon/docs/guides/faststore/atoms-icon%23-donts)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_dea4ea15
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides store framework dealing with events in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-dealing-with-events)\n\n[Collecting user session data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/vtex-io-documentation-collecting-user-session-data)\n\n[Cleaning cart data on log out](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/vtex-io-documentation-cleaning-cart-data-on-log-out)\n\n[Improving filter navigator experience](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/vtex-io-documentation-improving-filter-navigator-experience)\n\n[Using events to trigger side effects on store components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-dealing-with-events)\n\n[Collecting user session data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/vtex-io-documentation-collecting-user-session-data)\n\n[Cleaning cart data on log out](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/vtex-io-documentation-cleaning-cart-data-on-log-out)\n\n[Improving filter navigator experience](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/vtex-io-documentation-improving-filter-navigator-experience)\n\n[Using events to trigger side effects on store components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-dealing-with-events)\n\nDealing with events\n\nLearn how to manage user and system-generated events in your VTEX store.\n\nEvents are actions or notifications that trigger specific responses. They provide insights into customer behavior and allow you to create dynamic shopping experiences.\n\nEvents can be triggered by user actions in the storefront (e.g., adding an item to the cart) or automatically generated by a system. On VTEX, every event is broadcast to the cloud, where [VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps) can capture and respond to them accordingly. Responses can range from behind-the-scenes actions, such as sending a confirmation email, to visible changes in the storefront, such as displaying a promotional popup or updating the cart.\n\nMoreover, events integrate with analytics tools and third-party apps. Tracking events, such as page views, product impressions, or cart updates, provides metrics on customer behavior, helping businesses make data-driven decisions and optimize store performance. Learn more in the [Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-analytics) guide.\n\nIn this section, you will learn how to handle your store events.\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 [Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3) tutorial.\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\nMake sure the [store builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-builder) is configured, as it enables the development of Store Framework storefronts.\n\n### Customize your storefront\n\nCustomize your store theme based on your business needs by following the guides within the [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework) section, such as the guides [Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages) and [Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components).\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), including how to build custom solutions, such as [Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps) and [Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service).\n\n## Guides in this section\n\n[Collecting user session dataTrack and configure session data to enhance user interactions.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-collecting-user-session-data)[Cleaning cart data on log outClear the cart when a user logs out of your VTEX store.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-cleaning-cart-data-on-log-out)[Improving filter navigation experienceEnhance the filter navigation in your VTEX store by implementing event-driven updates.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-improving-filter-navigator-experience)[Using events to trigger side effects on store componentsExplore how to use Pixel events to trigger automatic UI changes based on user actions.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components)\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-dealing-with-events.md)\n\n[Using the Markers prop to customize a block's message« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events//docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message)[Collecting user session dataNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events//docs/guides/vtex-io-documentation-collecting-user-session-data)\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/store-framework-dealing-with-events/docs/guides/store-framework-dealing-with-events%23before-you-begin)\n\n[Develop your Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-dealing-with-events%23develop-your-store-theme)[Check the builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-dealing-with-events%23check-the-builders)[Customize your storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-dealing-with-events%23customize-your-storefront)[Learn about VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-dealing-with-events%23learn-about-vtex-io-apps)\n\n[Guides in this section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-dealing-with-events%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-dealing-with-events.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-dealing-with-events%23before-you-begin)\n\n[Develop your Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-dealing-with-events%23develop-your-store-theme)[Check the builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-dealing-with-events%23check-the-builders)[Customize your storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-dealing-with-events%23customize-your-storefront)[Learn about VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-dealing-with-events%23learn-about-vtex-io-apps)\n\n[Guides in this section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-dealing-with-events/docs/guides/store-framework-dealing-with-events%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_9276726f
|
[
{
"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 dropdown 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-dropdown/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-dropdown/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-dropdown/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-dropdown/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-dropdown/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-dropdown/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-dropdown/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-dropdown/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-dropdown/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-dropdown/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-dropdown/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-dropdown/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/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-dropdown/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/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-dropdown/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/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-dropdown/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/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-dropdown/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-dropdown/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-dropdown/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-dropdown/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-dropdown/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-dropdown/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-dropdown/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/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-dropdown/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-dropdown/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-dropdown/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/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-dropdown/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-dropdown/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-dropdown/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-dropdown/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-dropdown/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/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-dropdown/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/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-dropdown/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/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-dropdown/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/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-dropdown/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-dropdown/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-dropdown/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-dropdown/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-dropdown/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-dropdown/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-dropdown/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/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-dropdown/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-dropdown/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-dropdown/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/components-index)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-overview)\n\nSearchDropdown\n\nCombines `SearchHistory`, `SearchTop` and `SearchAutoComplete` and `SearchProducts` to show all options in `SearchInput`.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/SearchDropdown)\n\nCombine `SearchHistory`, `SearchTop`, `SearchAutoComplete` and `SearchProducts` to show all options in `SearchInput`. 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\nWaiting for input...\n\nHistory\n\nClear History\n\n1. [Headphone](#)\n2. [Audio & Video](#)\n3. [mh-7000](#)\n\nTop Search\n\n1. [1Notebooks](#)\n2. [2Laser Printer](#)\n3. [3Bluetooth Keyboard](#)\n\nSearching for: `Appl`\n\n1. [appl**e**](#)\n2. [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\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { SearchDropdown } from \"@faststore/ui\"; \n\n`\n\n### Import styles\n\nTo apply styles, include the following in your stylesheet:\n\n`1\n\nimport \"@faststore/ui/src/components/molecules/SearchDropdown/styles.scss\"; \n\n`\n\n---\n\n## Design tokens\n\n| Local token | Default value/Global token linked |\n| ------------------------------------------ | -------------------------------------------------------------------------- |\n| \\--fs-search-dropdown-bkg-color | var(--fs-color-neutral-0) |\n| \\--fs-search-dropdown-box-shadow | var(--fs-shadow) |\n| \\--fs-search-dropdown-width-mobile | 100vw |\n| \\--fs-search-dropdown-width-desktop | 100% |\n| \\--fs-search-dropdown-border-width | var(--fs-border-width) |\n| \\--fs-search-dropdown-border-color | var(--fs-border-color) |\n| \\--fs-search-dropdown-border-radius | 0 0 var(--fs-border-radius) var(--fs-border-radius) |\n| \\--fs-search-dropdown-position-left-mobile | calc(-1 \\* var(--fs-control-tap-size)) |\n| \\--fs-search-dropdown-position-left-tablet | calc(var(--fs-search-dropdown-position-left-mobile) - var(--fs-spacing-1)) |\n| \\--fs-search-dropdown-position-top-mobile | calc(var(--fs-search-dropdown-position-top-tablet) + 1px) |\n| \\--fs-search-dropdown-position-top-tablet | calc(var(--fs-control-tap-size) + var(--fs-border-width)) |\n| \\--fs-search-dropdown-position-top-desktop | var(--fs-search-input-height-desktop) |\n| \\--fs-search-dropdown-section-border-color | var(--fs-border-color-light) |\n\n---\n\n## Data attributes\n\nYou can target and override `SearchDropdown` styles using the following data attributes:\n\n`data-fs-search-dropdown`\n\n`data-fs-search-dropdown-loading-text`\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-search-dropdown |\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/search-dropdown.mdx)\n\n[SearchAutocomplete« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-search-auto-complete)[SearchHistoryNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-search-history)\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-search-dropdown/docs/guides/faststore/molecules-search-dropdown%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-search-dropdown%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-search-dropdown%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-search-dropdown%23design-tokens)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-search-dropdown%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-search-dropdown%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/molecules/search-dropdown.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-dropdown/docs/guides/faststore/molecules-search-dropdown%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-search-dropdown%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-search-dropdown%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-search-dropdown%23design-tokens)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-search-dropdown%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-search-dropdown/docs/guides/faststore/molecules-search-dropdown%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_04e9e860
|
[
{
"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 product details page 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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/docs/guides/store-framework-building-pages)\n\n[Building a Product Details Page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page/docs/guides/vtex-io-documentation-building-a-product-details-page)\n\n[Building a search results page with multiple layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts)\n\n[Creating a Black Friday page from template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template)\n\n[Creating a custom search results page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page/docs/guides/vtex-io-documentation-creating-a-custom-search-results-page)\n\n[Creating a new custom page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page/docs/guides/vtex-io-documentation-creating-a-new-custom-page)\n\n[Customizing the Header and Footer blocks by page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page/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-building-a-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page/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-product-details-page/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/docs/guides/store-framework-building-pages)\n\n[Building a Product Details Page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page/docs/guides/vtex-io-documentation-building-a-product-details-page)\n\n[Building a search results page with multiple layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts)\n\n[Creating a Black Friday page from template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template)\n\n[Creating a custom search results page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page/docs/guides/vtex-io-documentation-creating-a-custom-search-results-page)\n\n[Creating a new custom page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page/docs/guides/vtex-io-documentation-creating-a-new-custom-page)\n\n[Customizing the Header and Footer blocks by page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page/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-building-a-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/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-product-details-page/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page/docs/guides/store-framework)\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page/docs/guides/store-framework-building-pages)\n\n[Building a Product Details Page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page/docs/guides/vtex-io-documentation-building-a-product-details-page)\n\nBuilding a product details page\n\nA product details page (PDP) is the page in an ecommerce website that displays information about a specific product, including dimensions, color, price, reviews, shipping, and other relevant details that consumers may want to check before purchasing.\n\nThe PDP is defined within the `store.product` block in the Store Theme app, and it's built with a series of child blocks. The `store.product` block accepts all blocks allowed by the `store` and `flex-layout` blocks as child dependencies, as well as block in the following list:\n\nBlocks accepted by `store.product`\n* `availability-subscriber`\n* `buy-button`\n* `blog-related-posts`\n* `breadcrumb`\n* `product-add-to-list-button`\n* `product-assembly-options`\n* `product-availability`\n* `product-brand`\n* `product-details`\n* `product-description`\n* `product-highlights`\n* `product-identifier`\n* `product-images`\n* `product-kit`\n* `product-name`\n* `product-price`\n* `product-rating-inline`\n* `product-rating-summary`\n* `product-reviews`\n* `product-teaser.product`\n* `product-quantity`\n* `product-questions-and-answers`\n* `product-separator`\n* `product-specifications`\n* `share`\n* `shipping-simulator`\n* `sku-selector`\n\n## Before you begin\n\nTo build a responsive PDP, you need to use [flex-layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout). For more information, read [this](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout) guide.\n\n## Practical example\n\nConsider the following example of a PDP built using the `store.product` and `flex-layout` blocks:\n\nClick here to see the code sample\n\n`1\n\n{ \n\n2\n\n \"store.product\": { \n\n3\n\n \"children\": [ \n\n4\n\n \"flex-layout.row#product-breadcrumb\", \n\n5\n\n \"flex-layout.row#product-main\", \n\n6\n\n \"shelf.relatedProducts\" \n\n7\n\n ] \n\n8\n\n }, \n\n9\n\n \"flex-layout.row#product-breadcrumb\": { \n\n10\n\n \"props\": { \n\n11\n\n \"marginTop\": 4 \n\n12\n\n }, \n\n13\n\n \"children\": [\"breadcrumb\"] \n\n14\n\n }, \n\n15\n\n \"flex-layout.row#product-main\": { \n\n16\n\n \"props\": { \n\n17\n\n \"colGap\": 7, \n\n18\n\n \"rowGap\": 7, \n\n19\n\n \"marginTop\": 4, \n\n20\n\n \"marginBottom\": 7, \n\n21\n\n \"paddingTop\": 7, \n\n22\n\n \"paddingBottom\": 7 \n\n23\n\n }, \n\n24\n\n \"children\": [\"flex-layout.col#product-image\", \"flex-layout.col#right-col\"] \n\n25\n\n }, \n\n26\n\n \"flex-layout.col#product-image\": { \n\n27\n\n \"props\": { \n\n28\n\n \"width\": \"60%\", \n\n29\n\n \"rowGap\": 0 \n\n30\n\n }, \n\n31\n\n \"children\": [\"product-images\"] \n\n32\n\n }, \n\n33\n\n \"product-images\": { \n\n34\n\n \"props\": { \n\n35\n\n \"displayThumbnailsArrows\": true \n\n36\n\n } \n\n37\n\n }, \n\n38\n\n \"flex-layout.col#right-col\": { \n\n39\n\n \"props\": { \n\n40\n\n \"preventVerticalStretch\": true, \n\n41\n\n \"rowGap\": 0 \n\n42\n\n }, \n\n43\n\n \"children\": [ \n\n44\n\n \"product-name\", \n\n45\n\n \"product-rating-summary\", \n\n46\n\n \"product-price#product-details\", \n\n47\n\n \"product-separator\", \n\n48\n\n \"product-quantity\", \n\n49\n\n \"product-identifier.product\", \n\n50\n\n \"sku-selector\", \n\n51\n\n \"flex-layout.row#buy-button\", \n\n52\n\n \"availability-subscriber\", \n\n53\n\n \"shipping-simulator\", \n\n54\n\n \"share#default\" \n\n55\n\n ] \n\n56\n\n }, \n\n57\n\n \"product-price#product-details\": { \n\n58\n\n \"props\": { \n\n59\n\n \"showInstallments\": true, \n\n60\n\n \"showSavings\": true \n\n61\n\n } \n\n62\n\n }, \n\n63\n\n \"flex-layout.row#buy-button\": { \n\n64\n\n \"props\": { \n\n65\n\n \"marginTop\": 4, \n\n66\n\n \"marginBottom\": 7 \n\n67\n\n }, \n\n68\n\n \"children\": [\"buy-button\"] \n\n69\n\n }, \n\n70\n\n \n71\n\n \"share#default\": { \n\n72\n\n \"props\": { \n\n73\n\n \"social\": { \n\n74\n\n \"Facebook\": true, \n\n75\n\n \"WhatsApp\": true, \n\n76\n\n \"Twitter\": false, \n\n77\n\n \"Pinterest\": true \n\n78\n\n } \n\n79\n\n } \n\n80\n\n } \n\n81\n\n} \n\n`\n\n\n\nNote that in the code sample, the `store.product` child dependencies define five blocks, the first two being `flex-layout.row`.\n\n> Keep in mind that the `flex-layout` block may be affected if you are using mobile mode. For more information, read the [Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-flex-layout) documentation.\n\n### First row of Flex Layout\n\nIn the first row of the `flex-layout` block, the [breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.breadcrumb) block is rendered as follows:\n\n\n\n`1\n\n\"flex-layout.row#product-breadcrumb\": { \n\n2\n\n \"props\": { \n\n3\n\n \"marginTop\": 4 \n\n4\n\n }, \n\n5\n\n \"children\": [\"breadcrumb\"] \n\n6\n\n }, \n\n`\n\nTo customize the breadcrumb, you can declare the `breadcrumb` block and configure its properties based on your preferences. For example:\n\n`1\n\n\"breadcrumb\": { \n\n2\n\n \"props\": { \n\n3\n\n \"showOnMobile\": true \n\n4\n\n } \n\n5\n\n} \n\n`\n\n### Second row of Flex Layout\n\nThe second row of the `flex-layout` block renders the main information about the product.\n\nIt renders the product image (`flex-layout.col#product-image`) in the left column and the name, price, SKU selector, and buy button in the right column(`flex-layout.col#right-col`):\n\n`1\n\n \"flex-layout.row#product-main\": { \n\n2\n\n \"props\": { \n\n3\n\n \"colGap\": 7, \n\n4\n\n \"rowGap\": 7, \n\n5\n\n \"marginTop\": 4, \n\n6\n\n \"marginBottom\": 7, \n\n7\n\n \"paddingTop\": 7, \n\n8\n\n \"paddingBottom\": 7 \n\n9\n\n }, \n\n10\n\n \"children\": [\"flex-layout.col#product-image\", \"flex-layout.col#right-col\"] \n\n11\n\n }, \n\n`\n\nTo customize the `flex-layout.col#product-image` and `flex-layout.col#right-col` sections, you can declare these blocks and configure their properties based on your preferences as below:\n\n`1\n\n\"flex-layout.col#product-image\": { \n\n2\n\n \"props\": { \n\n3\n\n \"width\": \"60%\", \n\n4\n\n \"rowGap\": 0 \n\n5\n\n }, \n\n6\n\n \"children\": [\"product-images\"] \n\n7\n\n }, \n\n8\n\n \"product-images\": { \n\n9\n\n \"props\": { \n\n10\n\n \"displayThumbnailsArrows\": true \n\n11\n\n } \n\n12\n\n }, \n\n13\n\n \"flex-layout.col#right-col\": { \n\n14\n\n \"props\": { \n\n15\n\n \"preventVerticalStretch\": true, \n\n16\n\n \"rowGap\": 0 \n\n17\n\n }, \n\n18\n\n \"children\": [ \n\n19\n\n \"product-name\", \n\n20\n\n \"product-price#product-details\", \n\n21\n\n \"product-separator\", \n\n22\n\n \"product-quantity\", \n\n23\n\n \"product-identifier.product\", \n\n24\n\n \"sku-selector\", \n\n25\n\n \"flex-layout.row#buy-button\", \n\n26\n\n \"shipping-simulator\", \n\n27\n\n \"share#default\" \n\n28\n\n ] \n\n29\n\n }, \n\n`\n\n#### Left column\n\nThe left column of the second row contains the [product-images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productimages) block because this was the first `flex-layout.col` block to be declared.\n\n\n\n. \n\n#### Right column\n\nThe right column of the second row displays the price, buy button, and other relevant product details. In practice, it's composed of the following blocks:\n\n\n\n* [product-name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/productname): Displays the product name, along with its SKU name, if desired.\n* [product-price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-price): Displays a properly formatted selling price. You can set it to display the list price (if different), installments, etc. Below is an example of a product price displaying both the sale and the list price.\n* `product-separator`: Renders a line separator.\n* [product-quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity): Displays a quantity selector that allows customers to choose how many items they want to add to the cart.\n* [product-identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-identifier): Displays the product identification number. It accepts different props, such as the label to display before/after the identifier.\n* [sku-selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/skuselector): Allows the user to choose a SKU, automatically hiding impossible combinations or indicating combinations that are currently unavailable.\n* [add-to-cart-button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button): Adds an item to the cart. You can customize it to display a success message, redirect users to the cart page, etc.\n* [shipping-simulator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/shippingsimulator): Allows users to enter their postal code to then display the available shipping options and their respective prices for the order.\n* [share](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/share): Allows product sharing on social media. You can customize its props to control which options will be displayed to the user.\n\n### Related products\n\nAfter the `flex-layout` rows, you need to declare the `shelf.relatedProducts` block in your `store.product` block. This block is a [shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/) that displays products related to the one the customer is browsing. These products are defined through Catalog in the Admin.\n\n`1\n\n\"shelf.relatedProducts\": { \n\n2\n\n \"props\": { \n\n3\n\n \"recommendation\": \"view\", \n\n4\n\n \"productList\": { \n\n5\n\n \"titleText\": \"Who saw also saw\", \n\n6\n\n \"itemsPerPage\": 3 \n\n7\n\n } \n\n8\n\n } \n\n9\n\n} \n\n`\n\nWhen related products are identified, they are displayed as follows:\n\n\n\nThe `shelf.relatedProducts` block accepts different recommendation types, such as `similars`, `view`, `buy`, `accessories`, `viewAndBought`, and `suggestions`.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/concepts-1/vtex-io-documentation-building-a-product-details-page.md)\n\n[Building pages« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page//docs/guides/store-framework-building-pages)[Building a search results page with multiple layoutsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page//docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts)\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-building-a-product-details-page/docs/guides/vtex-io-documentation-building-a-product-details-page%23before-you-begin)\n\n[Practical example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page/docs/guides/vtex-io-documentation-building-a-product-details-page%23practical-example)\n\n[First row of Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page/docs/guides/vtex-io-documentation-building-a-product-details-page%23first-row-of-flex-layout)[Second row of Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page/docs/guides/vtex-io-documentation-building-a-product-details-page%23second-row-of-flex-layout)[Related products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page/docs/guides/vtex-io-documentation-building-a-product-details-page%23related-products)\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-product-details-page.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-building-a-product-details-page/docs/guides/vtex-io-documentation-building-a-product-details-page%23before-you-begin)\n\n[Practical example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page/docs/guides/vtex-io-documentation-building-a-product-details-page%23practical-example)\n\n[First row of Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page/docs/guides/vtex-io-documentation-building-a-product-details-page%23first-row-of-flex-layout)[Second row of Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page/docs/guides/vtex-io-documentation-building-a-product-details-page%23second-row-of-flex-layout)[Related products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page/docs/guides/vtex-io-documentation-building-a-product-details-page%23related-products)\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_624d5e33
|
[
{
"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 api response codes 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/api-response-codes/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-response-codes/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/api-response-codes/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/api-response-codes/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/api-response-codes/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/api-response-codes/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/api-response-codes/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-response-codes/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-response-codes/docs/guides/api-usage)\n\n[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-response-codes/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/api-response-codes/docs/guides/making-your-first-request)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-response-codes/docs/guides/authentication)\n\n[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-response-codes/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/api-response-codes/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/api-response-codes/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-response-codes/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-response-codes/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/api-response-codes/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-response-codes/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/api-response-codes/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/api-response-codes/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-response-codes/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-response-codes/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-response-codes/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-response-codes/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-response-codes/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-response-codes/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-response-codes/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-response-codes/docs/guides/api-usage)\n\n[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-response-codes/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/api-response-codes/docs/guides/making-your-first-request)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-response-codes/docs/guides/authentication)\n\n[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-response-codes/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/api-response-codes/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/api-response-codes/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-response-codes/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-response-codes/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/api-response-codes/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-response-codes/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/api-response-codes/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/api-response-codes/docs/guides)\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-response-codes/docs/guides/api-usage)\n\n[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-response-codes/docs/guides/api-response-codes)\n\nAPI response status codes\n\nUnderstand the outcome of your interactions with VTEX Core Commerce APIs by delving deeper into HTTP status codes.\n\nEvery interaction with [VTEX Core Commerce APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference) returns an HTTP status code that indicates whether the request succeeded, failed, or demands particular actions for subsequent actions.\n\n| Status code | Description |\n| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| 200 OK | The request was successfully processed by VTEX. |\n| 201 Created | The request has been fulfilled, and a new resource has been created. This response is typically sent after POST requests and some PUT requests. |\n| 202 Accepted | The request has been received, but the processing has not been completed yet. |\n| 204 No Content | The request was processed successfully by the VTEX server, but there is no content to return. |\n| 205 Reset Content | The VTEX server has accepted the request but will not return any content. The client must reset the document from which the original request was sent. |\n| 400 Bad Request | The VTEX server could not decode the request body, generally due to malformed syntax or an incorrect Content-Type header. |\n| 401 Unauthorized | The caller was not authorized to perform the request due to missing or incorrect authentication credentials. Refer to [Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication) for more information. |\n| 403 Forbidden | The request is valid, but the VTEX server refuses to process the request. Ensure you have the appropriate [roles](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc?%26utm%5Fsource=autocomplete) to perform the desired action. |\n| 404 Not Found | The requested resource cannot be located. Refer to [VTEX API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference) for correct endpoint naming. |\n| 405 Method Not Allowed | The HTTP method used to access the endpoint is incorrect. Refer to [VTEX API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference) for more information on the supported methods. |\n| 429 Too Many Requests | The application exceeded request rate limits. |\n| 500 Internal Server Error | An internal server error has occurred. Please verify the headers of the HTTP request. If the request is directed to an external server, check with the provider. For VTEX-related issues, visit the [VTEX status page](https://read.calvincode.net/reader?url=https://status.vtex.com/) for real-time outages and incident reports. If the issue persists, contact [VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/support) for assistance. |\n| 502 Bad Gateway | The VTEX server acting as a gateway or proxy received an invalid response from the upstream server. Please try again later. |\n| 503 Service Unavailable | The VTEX server is temporarily unavailable. Check the [VTEX status page](https://read.calvincode.net/reader?url=https://status.vtex.com/) for real-time outages and incident reports. Try again later, or if the issue persists, reach out to [VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/support). |\n| 504 Gateway Timeout | The VTEX server acting as a gateway or proxy timed out while attempting to complete the request. Please try again later, or if the issue persists, reach out to [VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/support). |\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/Getting-Started/api-response-codes.md)\n\n[Refresh token flow for headless implementations« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-response-codes//docs/guides/refresh-token-flow-for-headless-implementations)[Handling errors and exceptionsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-response-codes//docs/guides/handling-errors-and-exceptions)\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/Getting-Started/api-response-codes.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_6b542bfe
|
[
{
"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 facebook fbe 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.facebook-fbe/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/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.facebook-fbe/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.facebook-fbe/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.facebook-fbe/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.facebook-fbe/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.facebook-fbe/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/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.facebook-fbe/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.facebook-fbe/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/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.facebook-fbe/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.facebook-fbe/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.facebook-fbe/docs/vtex-io-apps)\n\nFacebook Business Extension\n\nOfficial extension\n\nVersion: 1.12.3\n\nLatest version: 1.12.3\n\nThe [Facebook Business Extension and Conversions API app](https://read.calvincode.net/reader?url=https://apps.vtex.com/vtex-facebook-fbe/p) is the one-stop shop for merchants to easily connect their stores to Facebook services through the FBE platform. FBE stands for Facebook Business Extension and supports integration with Facebook features such as [Catalog](https://read.calvincode.net/reader?url=https://developers.facebook.com/docs/marketing-api/catalog), [Facebook Pixel](https://read.calvincode.net/reader?url=https://developers.facebook.com/docs/facebook-pixel), Conversions Api, and call-to-action buttons for Facebook and Instagram pages.\n\n## Table of Contents\n\n* [Facebook Business Extension](#facebook-business-extension) \n * [Table of Contents](#table-of-contents) \n * [Compatibility](#compatibility) \n * [Getting Started](#getting-started) \n * [Facebook Features](#facebook-features) \n * [Ads Plugin](#ads-plugin) \n * [Conversions API Integration](#conversions-api-integration) \n * [Optimizing your Conversions API setup](#optimizing-your-conversions-api-setup) \n * [Required Actions](#required-actions) \n * [Step 1 - Create the Trigger](#step-1---create-the-trigger) \n * [Step 2 - Create the Tag](#step-2---create-the-tag) \n * [Step 2b - What if I already have other customizations in my Purchase Tag?](#step-2b---what-if-i-already-have-other-customizations-in-my-purchase-tag) \n * [Step 3 - Publish your Changes](#step-3---publish-your-changes) \n * [Step 4 - Test your Changes](#step-4---test-your-changes) \n * [Disconnecting from FBE](#disconnecting-from-fbe) \n * [User Consent](#user-consent)\n\n## Compatibility\n\nThis app is fully compatible with IO stores and partially compatible with Legacy (or headless) stores.\n\n| Features | Legacy | IO |\n| ---------------------- | ----------------- | -- |\n| Facebook Pixel | ❌ | ✅ |\n| Conversions API | ✅ (only purchase) | ✅ |\n| Catalog Sync | ✅ | ✅ |\n| Call-To-Action Buttons | ✅ | ✅ |\n\nThis means legacy stores need to do a few extra steps to optimize their Pixel/Conversions API setup, which is explained in the later topics of this documentation.\n\nThis app is fully compatible with the [Facebook Pixel App](https://read.calvincode.net/reader?url=https://apps.vtex.com/vtex-facebook-pixel/p). FBE detects if you've selected the same pixel and replaces the Facebook Pixel App with its own Pixel App, which is tailored to work properly with Conversions API.\n\nThis app is fully compatible with the [Facebook Connector](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tracks/integracao-com-o-facebook--7h8KvIC4DbRRc8VlyJ8PFc/5OP69kHWKca01wLH0w10jX). When you configure FBE, if you already have the catalog sync configured, the Facebook Connector won't be impacted and will keep working as usual. Otherwise, FBE automatically configures the Facebook Connector to enable Catalog synchronization with Facebook.\n\nThis app is available in all countries as long as the used currency is supported by Facebook Ads. You can check an updated list of all supported currencies in this link: [Accepted Currencies for Facebook Ads](https://read.calvincode.net/reader?url=https://www.facebook.com/business/help/151451521590943?id=738655959856647)\n\n## Getting Started\n\n> _To configure the Facebook Business Extension and Conversions API app in the VTEX Admin, check out the documentation [Integration with Facebook Business Extension](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/integration-with-facebook-business-extension--2hS3ANSZ7vlHCcba4h7k8D/7JvybNGcBXxGKbVWjadKjt)._\n\nAfter installing the [Facebook Business Extension and Conversions API app](https://read.calvincode.net/reader?url=https://apps.vtex.com/vtex-facebook-fbe/p), you can connect to your Facebook account through the Admin menu under `Marketplace -> Facebook`.\n\nRegion, currency settings, and the store URL will be automatically filled in, but you can double-check these settings and change them if needed.\n\nStore URL, region, and currency settings are saved in order to correctly fire store events such as AddToCart and Purchase and to enable call-to-action buttons on your store's social media pages (Facebook, Instagram, etc)\n\n\n\nUpon clicking the `Connect with Facebook` button, a popup is shown, and the user can log in to their business account and select their Facebook assets, such as the business page, the Facebook pixel, and the catalog to sync with VTEX products:\n\n\n\nAfter confirming, you can check your integration status and the installed features, such as call-to-action buttons and catalog configuration:\n\n\n\nThe numbers along the statuses are the IDs for your selected assets.\n\nIf you need to, you can change the integration settings by clicking on `Integration Settings`:\n\n\n\nWhen you connect through FBE, the business manager ID and catalog ID are filled automatically since these fields are already provided by the app, so no extra steps are required here unless you need to change the Product Display Name, Category Mapping, or the Trade Policy.\n\n## Facebook Features\n\nOn the features card, it's possible to configure other Facebook features. Upon clicking on the \"Configure Feature\" button, a popup on Facebook will guide you through those extra settings:\n\n\n\nThese features are all provided by a custom Facebook UI and include, but are not limited to:\n\n* **Page Surface Call to Action Button**: Adds a `Buy Now` button to your Facebook Page, which redirects to your store.\n* **Instagram Call to Action Button**: Adds a `Buy Now` button to your Instagram Page, which redirects to your store.\n* **Messenger Call to Action**: Adds a `Buy Now` button inside Messenger when a user is messaging the business.\n\n## Ads Plugin\n\nOn the ads plugin cards, it's possible to manage your Facebook ads.\n\n\n\nUpon clicking on the \"Open Ads Insights\" button, a popup will open with the metrics and performance of your ads.\n\n\n\nBy clicking on the \"Open Ads Creation\" button, another popup will open with a lightweight interface for ads creation.\n\n\n\n## Conversions API Integration\n\nConversions API comes with the FBE App by default. It allows firing certain events directly from VTEX servers, ensuring the relevant data reaches Facebook independently from front-end implementations and/or network failures.\n\nThese are the supported events in the current version of this App:\n\n| Event | Facebook Pixel (Native) | Conversions API |\n| ----------------- | ----------------------- | --------------- |\n| Page View | ✅ | ✅ |\n| Content View | ✅ | ✅ |\n| Search | ✅ | ✅ |\n| Add To Cart | ✅ | ✅ |\n| Initiate Checkout | ✅ | ✅ |\n| Purchase | ✅ | ✅ |\n\nThis integration is configured automatically upon connecting your Facebook account. The CAPI integration works on any store (Legacy/IO), be sure to follow the next steps to ensure an optimal setup for your store.\n\n### Optimizing your Conversions API setup\n\nFirst off, you may need to do some extra steps depending on your current Facebook Pixel Configuration.\n\n> **Facebook Pixel** is a piece of code for your ecommerce website that lets you measure, optimize, and build audiences for your ad campaigns. When someone visits your website and takes an action (for example, buying something), the Facebook pixel is triggered and reports this action.\n\nThe table below shows if any actions are required:\n\n| Store | Pixel Setup | Actions Required? |\n| ------------ | ------------------ | ----------------- |\n| Legacy (CMS) | None | Yes ⚠️ |\n| Legacy (CMS) | Google Tag Manager | Yes ⚠️ |\n| VTEX IO | None | No ✅ |\n| VTEX IO | Facebook Pixel App | No ✅ |\n| VTEX IO | Google Tag Manager | Yes ⚠️ |\n\nIf no actions are required, you may skip the following subtopic.\n\n### Required Actions\n\n**1** \\- Browser events need to be fired with the correct parameters in order to promote correct deduplication between browser and server events. In this case, we need to do this for the Purchase event.\n\n> **What is Event Deduplication?** Facebook tries to deduplicate identical events sent through the Facebook pixel and the Conversions API when we work with a redundant setup.\n\n> **A redundant setup** is when you send the same events through from both a browser pixel and Conversions API. This is the default setup used by this App.\n\n> **What events will I be able to configure in this step?** For now, the only supported event for this step is the Purchase event. The other 5 (PageView, ViewContent, Search, AddToCart, and InitiateCheckout) are just supported by VTEX IO stores. These scripts for Legacy stores are on our implementation roadmap.\n\nThis is done through specific parameters that may be used to guarantee the events are the same. The two parameters we'll be configuring in this section are the _Event ID_ and the _Event Name_.\n\n* **Event ID**: This ID uniquely identifies an event. In our purchase event, we're going to use orderId as the Event ID.\n* **Event Name**: This is the type of the event being triggered. In our purchase event, we're going to go with 'Purchase'.\n\n**2** \\- Browser events must be initialized with the _external\\_id_ parameter in order to correctly match the actor of the event (the end consumer). We'll use the _userProfileId_ as the _external\\_id_\n\n> **The userProfileId** is a unique ID that represents an end consumer of a store in the VTEX platform.\n\nIn order to do all that, the following steps need to be done in **Google Tag Manager** (or your tool of choice):\n\n#### Step 1 - Create the Trigger\n\nYou may skip this step if you already fire Purchase events through your browser Pixel.\n\nAfter accessing your Google Tag Manager workspace, ensure you have a trigger for the `orderPlaced` event. This event happens in the checkout confirmation page, whenever a purchase is completed.\n\nIn order to do so, click on `Triggers` in the lateral menu:\n\n\n\nCreate a trigger of type `Custom Event`, and set the event name to `orderPlaced`:\n\n\n\nSave the trigger.\n\n#### Step 2 - Create the Tag\n\nWith your trigger configured, you need to create a tag to run the custom code required to fire the purchase event to Facebook. You can find an example implementation through the pixel snippets in the FBE App. Go to Marketplace -> Facebook on your VTEX Admin, then click on the `Purchase` button under Pixel Snippets:\n\n\n\n> It's important to emphasize that Pixel Snippets are only available if the Pixel Toggle is disabled. VTEX IO stores with the toggle enabled have no need for any extra configuration to have an optimal setup.\n\nThen all you need to do for now is click the copy button:\n\n\n\nThis snippet contains all the required parameters to trigger the purchase event correctly. **However, if you already have other kinds of customizations in your Purchase Tag, please read the next subtopic for more information about how the snippet was created so you can customize it according to your needs.**\n\nBack on Tag Manager, create a new \"Custom HTML\" tag and paste the currently copied script into the HTML text box.\n\nClick on \"Triggering\" and set the trigger to your \"Order Placed\" event:\n\n\n\nSave your new tag.\n\n#### Step 2b - What if I already have other customizations in my Purchase Tag?\n\nThis section is for setups that already have customizations in their Purchase Tag (such as detecting different payment methods or having additional parameters on the event payload besides `contents`, `contentId`, `contentType`, `currency`, and `value`)\n\nPlease be aware that this section is very technical since it explains in detail how exactly the Tag gathers all required information to compose and send the purchase event to Facebook.\n\n(Click to Expand) This is the un-minified version of the Purchase Tag Snippet, explained:\n\n`` 1\n\nconst pixelId = 111111111111 // this is your PixelId \n\n2\n\n \n3\n\n// Function to convert an array buffer to its hexadecimal representation. \n\n4\n\nfunction buf2hex(buffer) { \n\n5\n\n return Array.prototype.map \n\n6\n\n .call(new Uint8Array(buffer), function (x) { \n\n7\n\n return `00$\\{x.toString(16)\\}`.slice(-2) \n\n8\n\n }) \n\n9\n\n .join('') \n\n10\n\n} \n\n11\n\n \n12\n\n// Function that hashes values before sending them to FB. \n\n13\n\nfunction hashSHA256(value) { \n\n14\n\n const encoder = new TextEncoder() \n\n15\n\n const data = value ? encoder.encode(value) : Promise.resolve(undefined) \n\n16\n\n \n17\n\n const hashedValue = data \n\n18\n\n ? window.crypto.subtle.digest('SHA-256', data).then(function (f) { \n\n19\n\n return buf2hex(f) \n\n20\n\n }) \n\n21\n\n : Promise.resolve(undefined) \n\n22\n\n \n23\n\n return hashedValue \n\n24\n\n} \n\n25\n\n \n26\n\n// This is the main Pixel Code provided by Facebook. \n\n27\n\n!(function (f, b, e, v, n, t, s) { \n\n28\n\n if (f.fbq) return \n\n29\n\n n = f.fbq = function () { \n\n30\n\n n.callMethod ? n.callMethod.apply(n, arguments) : n.queue.push(arguments) \n\n31\n\n } \n\n32\n\n \n33\n\n if (!f._fbq) f._fbq = n \n\n34\n\n n.push = n \n\n35\n\n n.loaded = !0 \n\n36\n\n n.version = '2.0' \n\n37\n\n n.queue = [] \n\n38\n\n t = b.createElement(e) \n\n39\n\n t.async = !0 \n\n40\n\n t.src = v \n\n41\n\n s = b.getElementsByTagName(e)[0] \n\n42\n\n s.parentNode.insertBefore(t, s) \n\n43\n\n})(window, document, 'script', 'https://connect.facebook.net/en_US/fbevents.js') \n\n44\n\n \n45\n\n// A small timeout of half a second is placed to ensure the fbq function is correctly loaded. \n\n46\n\nsetTimeout(function () { \n\n47\n\n \n48\n\n // As this tag is self-containing, instead of using variables it peeks into the dataLayer by itself. \n\n49\n\n const orderPlaced = dataLayer.find(function (d) { \n\n50\n\n return d.event === 'orderPlaced' \n\n51\n\n }) \n\n52\n\n \n53\n\n // The UserProfile function retrieves the end consumer email from visitorContactInfo and calls the Checkout API to get the saved userProfile, which contains the userProfileId. \n\n54\n\n // The userProfileId is used as the external_id which is an advanced matching parameter as described by Facebook. \n\n55\n\n // visitorContactInfo is an array with 3 elements, composed by ['email', 'firstName', 'lastName']. We just need the email for now. \n\n56\n\n const userProfile = \n\n57\n\n orderPlaced && \n\n58\n\n orderPlaced.visitorContactInfo && \n\n59\n\n orderPlaced.visitorContactInfo.length > 0 \n\n60\n\n ? fetch( \n\n61\n\n `/api/checkout/pub/profiles?email=$\\{orderPlaced.visitorContactInfo[0]\\}` \n\n62\n\n ) \n\n63\n\n // Retrieve the response text from the API call. \n\n64\n\n .then(function (f) { \n\n65\n\n return f.text() \n\n66\n\n }) \n\n67\n\n // Parse the response text as an Object. \n\n68\n\n .then(function (f) { \n\n69\n\n return JSON.parse(f) \n\n70\n\n }) \n\n71\n\n // The e-mail and userProfileId must be hashed before they're sent to Facebook. \n\n72\n\n // In no circunstance these parameters can be sent openly before hashing. If that happens, FB automatically discards them. \n\n73\n\n .then(function (f) { \n\n74\n\n return Promise.all([ \n\n75\n\n hashSHA256(f.userProfileId), \n\n76\n\n hashSHA256(orderPlaced.visitorContactInfo[0].toLowerCase()), \n\n77\n\n ]) \n\n78\n\n }) \n\n79\n\n : Promise.resolve([]) \n\n80\n\n \n81\n\n // With the userProfile in hands, we're able to compose the advancedMatchingParams \n\n82\n\n userProfile.then(function (profileInfo) { \n\n83\n\n const advancedMatchingParams = \n\n84\n\n profileInfo.length == 2 && profileInfo[0] && profileInfo[1] \n\n85\n\n ? { \n\n86\n\n external_id: profileInfo[0], \n\n87\n\n em: profileInfo[1], \n\n88\n\n } \n\n89\n\n : {} \n\n90\n\n \n91\n\n // This condition checks if fbq was already loaded/executed in this page. \n\n92\n\n if (!fbq.instance.pixelsByID[pixelId]) { \n\n93\n\n // Here we initialize the Pixel with the Advanced Matching Parameters. \n\n94\n\n fbq('init', String(pixelId), advancedMatchingParams, { agent: 'vtex' }) \n\n95\n\n \n96\n\n // Then we track the PageView \n\n97\n\n fbq('track', 'PageView') \n\n98\n\n } \n\n99\n\n \n100\n\n // The Event ID should always be the orderGroupId without -01, -02, etc, to match the Event ID from Conversions API. \n\n101\n\n var substr = orderPlaced.transactionId.indexOf('-'); \n\n102\n\n var orderId = orderPlaced.transactionId.substring(0, substr > 0 ? substr : orderPlaced.transactionId.length); \n\n103\n\n \n104\n\n // After that, we create the PurchaseEvent object based on the order placed. \n\n105\n\n const eventObject = { \n\n106\n\n value: orderPlaced.transactionTotal, \n\n107\n\n content_type: 'product', \n\n108\n\n currency: orderPlaced.transactionCurrency, \n\n109\n\n content_ids: orderPlaced.transactionProducts.map(function (p) { \n\n110\n\n return p.sku \n\n111\n\n }), \n\n112\n\n contents: orderPlaced.transactionProducts.map(function (p) { \n\n113\n\n return { id: p.sku, quantity: p.quantity, price: p.sellingPrice } \n\n114\n\n }), \n\n115\n\n } \n\n116\n\n \n117\n\n // In order to ensure deduplication, we send the orderId as the eventID, and the event as 'Purchase'. \n\n118\n\n // This works perfectly for the purchase event since the orderId is unique. \n\n119\n\n const eventParams = { \n\n120\n\n eventID: orderId, \n\n121\n\n event: 'Purchase', \n\n122\n\n } \n\n123\n\n \n124\n\n // We can finally track the Purchase event \n\n125\n\n fbq('track', 'Purchase', eventObject, eventParams) \n\n126\n\n }) \n\n127\n\n}, 500) \n\n ``\n\n#### Step 3 - Publish your Changes\n\nAfter saving your tag, you need to submit and publish your new version.\n\n#### Step 4 - Test your Changes\n\nYou can then test your events on the Events Manager on the Facebook platform. Open the test events tab and fill in your store URL. Click on the button to open a new browser and finish a purchase in your store. All events should show up in the Test Events Tab:\n\n\n\n> Though most of the setups use GTM to fire pixel events, it's possible to configure this using other tools. Just make sure the corresponding parameters are being sent correctly in your tool of choice.\n\n## Disconnecting from FBE\n\nAt any point in time, the user can disconnect from FBE. Please note that while disconnecting revokes access from the system user created for the integration, it does not stop catalog synchronization either. In order to disable it, deactivate catalog sync on the find marketplaces (`/admin/marketplace-configuration/facebook`) settings.\n\nBe aware that upon disconnecting, the app will stop sending pixel events (pixel and conversions API). It will resume working as expected if you reconnect to FBE.\n\nPrevious Facebook Pixel (`vtex.facebook-pixel`) installations that might have been uninstalled during FBE configuration will also be reinstalled.\n\n\n\n## User Consent\n\nThis functionality must be associated with a third-party cookie consent system. To enable the blocking of pixel and server events (with the exception of the server event for the purchase), you must activate the flag through the settings in the admin (`/admin/apps/vtex.facebook-fbe@1.x/setup/`):\n\n\n\nAfter activating this functionality, the Facebook script will be initialized with consent revoke, as documented by Facebook in the following article:<https://developers.facebook.com/docs/meta-pixel/implementation/gdpr>\n\nIn addition, a cookie is created called fbe\\_consent set to false, preventing events via the server. To allow the emission of events after the user's consent, the `fbq` function must be called, as well as the cookie value must be changed through a script implemented by the store within the third-party tool:\n\n`1\n\nfbq('consent', 'grant') \n\n2\n\ndocument.cookie = \"fbe_consent=true\" \n\n`\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[Table of Contents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/docs/apps/vtex.facebook-fbe%23table-of-contents)\n\n[Compatibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/docs/apps/vtex.facebook-fbe%23compatibility)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/docs/apps/vtex.facebook-fbe%23getting-started)\n\n[Facebook Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/docs/apps/vtex.facebook-fbe%23facebook-features)\n\n[Ads Plugin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/docs/apps/vtex.facebook-fbe%23ads-plugin)\n\n[Conversions API Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/docs/apps/vtex.facebook-fbe%23conversions-api-integration)\n\n[Optimizing your Conversions API setup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/docs/apps/vtex.facebook-fbe%23optimizing-your-conversions-api-setup)[Required Actions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/docs/apps/vtex.facebook-fbe%23required-actions)\n\n[Disconnecting from FBE](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/docs/apps/vtex.facebook-fbe%23disconnecting-from-fbe)\n\n[User Consent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.facebook-fbe/docs/apps/vtex.facebook-fbe%23user-consent)\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_fbf06341
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides integration vtex sales app local stock sale in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/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/integration-vtex-sales-app-local-stock-sale/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/integration-vtex-sales-app-local-stock-sale/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/integration-vtex-sales-app-local-stock-sale/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/integration-vtex-sales-app-local-stock-sale/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/integration-vtex-sales-app-local-stock-sale/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/integration-vtex-sales-app-local-stock-sale/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/integration-vtex-sales-app-local-stock-sale/docs/guides/enable-cart-transfer-between-devices)\n\n[Force stock availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/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/integration-vtex-sales-app-local-stock-sale/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/integration-vtex-sales-app-local-stock-sale/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/integration-vtex-sales-app-local-stock-sale/docs/guides/enable-partial-cancellation)\n\n[Hide cancellation buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/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/integration-vtex-sales-app-local-stock-sale/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/integration-vtex-sales-app-local-stock-sale/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/integration-vtex-sales-app-local-stock-sale/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/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/integration-vtex-sales-app-local-stock-sale/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/integration-vtex-sales-app-local-stock-sale/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/integration-vtex-sales-app-local-stock-sale/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/integration-vtex-sales-app-local-stock-sale/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/integration-vtex-sales-app-local-stock-sale/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/integration-vtex-sales-app-local-stock-sale/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/integration-vtex-sales-app-local-stock-sale/docs/guides/enable-cart-transfer-between-devices)\n\n[Force stock availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/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/integration-vtex-sales-app-local-stock-sale/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/integration-vtex-sales-app-local-stock-sale/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/integration-vtex-sales-app-local-stock-sale/docs/guides/enable-partial-cancellation)\n\n[Hide cancellation buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/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/integration-vtex-sales-app-local-stock-sale/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/integration-vtex-sales-app-local-stock-sale/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/integration-vtex-sales-app-local-stock-sale/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/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/integration-vtex-sales-app-local-stock-sale/docs/guides/how-to-customize-vtex-sales-app)\n\n[Integration VTEX Sales App Local stock sale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/guides/integration-vtex-sales-app-local-stock-sale)\n\nIntegration VTEX Sales App Local stock sale\n\nLearn how to integrate the VTEX Sales App Local stock sale\n\n## Integration VTEX Sales App Local stock sale\n\nTo first identify Local stock sale sales the first thing to do is to look for [VTEX Sales App](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc/7fnnVlG3Kv1Tay9iagc5yf) sales. VTEX Sales App sales can be filtered by a specific OMS filter called \"VTEX Sales App\", this filter looks for user agent information that sets a specific user agent that can be used to track VTEX Sales App sales. This tag is not available at the Order Payload or databases (redshift), but it can be used at [list orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/listorders) to filter VTEX Sales App Sales. Another field that can be used for this is `marketingData.marketingTags`, if the array contains an \"VTEX Sales App\" tag the order was made by VTEX Sales App application. This field can be found at the Order Payload and Redshift databases.\n\nThe next step is to understand if the order generated will be processed by the same store that has created it. To do that, check first if the `checkedIn` flag is `true`, next run through all products of this order looking at `shippingData.logisticsInfo`. Inside this key, it is needed to compare `pickupPointId` with `checkedInPickupPointId` the value of those tags must be the same and not null, meaning that the store that created the order is responsible for delivering the order.\n\n## Integration Methods\n\nNow that VTEX Sales App Orders and _\"Local stock sale delivery method\"_ can be identified in our OMS, the next step is to use the available methods to consume OMS APIs to process Local stock sale orders. There are two options for that:\n\n### Tracking Local stock sale Order\n\nThe Local stock sale Order tracking can be active or passive regarding what works best for the business. Although we strongly recommend to use **Web Hook Integrations** for Physical Stores Sales Operations, since it provides the best response time.\n\n### API Integration\n\nIt is recommended to get a list from all On Hand Orders in a specific time gap. You can use this method to display all Local stock sale orders or to double check the orders and reprocess any of it that had issues for invoicing or updating the ERP / POS inventory. Although it is not recommended to track orders using this method, for that it is needed to integrate by Web Hook APIs.\n\nAs an example you can use this request:\n\n`1\n\ncurl --request GET \\ \n\n2\n\n --url 'https://accountname.environment.com.br/api/oms/pvt/orders?f_creationDate=creationDate%3A%5B2016-01-01T02%3A00%3A00.000Z%20TO%202021-01-01T01%3A59%3A59.999Z%5D&f_hasInputInvoice=false&f_isInstore=true' \\ \n\n3\n\n --header 'Accept: application/json' \\ \n\n4\n\n --header 'Content-Type: application/json' \n\n`\n\nThis is a normal request using the Get Orders List method by OMS API. To filter VTEX Sales App orders it is needed to set the flag **f\\_isInstore=true.** Then to know if it is an Local stock sale Orders check if the flag **checkedInPickupPointId is not null** and compare the value of it is equal to the tag **shippingData.logisticsInfo.pickupPointId** on every product.\n\n### Web Hook Integration\n\nFirst, it is necessary to configure a web hook to receive Local stock sale orders. For this it can be used the following expression, inside the filter tag ([Order Hooks Documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/orders-feed%23configuration-1)):\n\n`1\n\n{ \n\n2\n\n \"filter\": { \n\n3\n\n \"type\": \"FromOrders\", \n\n4\n\n \"expression\": \"(\\\"instore\\\" in marketingData.marketingTags) and (checkedInPickupPointId != null) and (checkedInPickupPointId in shippingData.logisticsInfo[].pickupPointId)\", \n\n5\n\n \"disableSingleFire\": false \n\n6\n\n }, \n\n7\n\n \"hook\": { \n\n8\n\n \"url\": \"https://endpoint.example/path\", \n\n9\n\n \"headers\": { \n\n10\n\n \"key\": \"value\" \n\n11\n\n } \n\n12\n\n } \n\n13\n\n} \n\n`\n\nAs response of this configuration, the endpoint used at the example before is going to receive the following payload when a new Local stock sale order is placed ([Order Hooks documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/orders-feed%23hook-notifications)):\n\n`1\n\n{ \n\n2\n\n \"Domain\": \"OrdersDocumentUpdated\", \n\n3\n\n \"OrderId\": \"v40484048naf-01\", \n\n4\n\n \"State\": \"unknow\", \n\n5\n\n \"LastState\": null, \n\n6\n\n \"LastChange\": \"2022-12-15T20:32:06.6120711\", \n\n7\n\n \"CurrentChange\": \"0001-01-01T00:00:00\", \n\n8\n\n \"Origin\": { \n\n9\n\n \"Account\": \"accountABC\", \n\n10\n\n \"Key\": \"vtexappkey-keyEDF\" \n\n11\n\n } \n\n12\n\n} \n\n`\n\nThe received order id can be used to get the full Order information, including the products on it by using the OMS API Method: Get Order ([Orders API reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getorder)).\n\n### Invoicing Local stock sale Order\n\nAfter getting the Order Data, the next step is to start an Invoice Emission, this step is not handled by VTEX and each Merchant can pick the solution that fits best their operation (ie: using POS software to emit and print it at the physical store, using ERP to send it through email…).\n\nRegardless of the solution adopted to emit the invoice, one important thing is to attach the invoice data into the VTEX OMS system. By this, VTEX Sales App can inform the sales associate that the order invoice was invoiced. To do that, it can be used the following OMS resource sending an payload as the example below ([Order Invoice API reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/invoicenotification)):\n\n`1\n\n{ \n\n2\n\n \"type\": \"Output\", \n\n3\n\n \"invoiceNumber\": \"NFe-00001\", \n\n4\n\n \"courier\": \"\", \n\n5\n\n \"trackingNumber\": \"\", \n\n6\n\n \"trackingUrl\": \"\", \n\n7\n\n \"items\": [ \n\n8\n\n { \n\n9\n\n \"id\": \"345117\", \n\n10\n\n \"quantity\": 1, \n\n11\n\n \"description\": \"335\", \n\n12\n\n \"price\": 9003 \n\n13\n\n } \n\n14\n\n ], \n\n15\n\n \"issuanceDate\": \"2013-11-21T00:00:00\", \n\n16\n\n \"invoiceValue\": 9508 \n\n17\n\n} \n\n`\n\nContributors\n\n1\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/integration-vtex-sales-app-local-stock-sale.md)\n\n[Allow manual prices on VTEX Sales App« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale//docs/guides/allow-manual-prices-on-vtex-sales-app)[My AuthenticationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale//docs/guides/ui-customization-my-authentication)\n\nContributors\n\n1\n\n[](https://github.com/karenkrieger)\n\nON THIS PAGE\n\n[Integration VTEX Sales App Local stock sale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/guides/integration-vtex-sales-app-local-stock-sale%23integration-vtex-sales-app-local-stock-sale)\n\n[Integration Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/guides/integration-vtex-sales-app-local-stock-sale%23integration-methods)\n\n[Tracking Local stock sale Order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/guides/integration-vtex-sales-app-local-stock-sale%23tracking-local-stock-sale-order)[API Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/guides/integration-vtex-sales-app-local-stock-sale%23api-integration)[Web Hook Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/guides/integration-vtex-sales-app-local-stock-sale%23web-hook-integration)[Invoicing Local stock sale Order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/guides/integration-vtex-sales-app-local-stock-sale%23invoicing-local-stock-sale-order)\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/integration-vtex-sales-app-local-stock-sale.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Integration VTEX Sales App Local stock sale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/guides/integration-vtex-sales-app-local-stock-sale%23integration-vtex-sales-app-local-stock-sale)\n\n[Integration Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/guides/integration-vtex-sales-app-local-stock-sale%23integration-methods)\n\n[Tracking Local stock sale Order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/guides/integration-vtex-sales-app-local-stock-sale%23tracking-local-stock-sale-order)[API Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/guides/integration-vtex-sales-app-local-stock-sale%23api-integration)[Web Hook Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/guides/integration-vtex-sales-app-local-stock-sale%23web-hook-integration)[Invoicing Local stock sale Order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integration-vtex-sales-app-local-stock-sale/docs/guides/integration-vtex-sales-app-local-stock-sale%23invoicing-local-stock-sale-order)\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_1a517214
|
[
{
"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 formatting order invoicing time 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/formatting-order-invoicing-time/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/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/formatting-order-invoicing-time/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/formatting-order-invoicing-time/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/formatting-order-invoicing-time/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/formatting-order-invoicing-time/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/formatting-order-invoicing-time/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/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/formatting-order-invoicing-time/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n[Feed v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/orders-feed)\n\n[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/order-modifications)\n\n[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/change-seller)\n\n[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/order-canceling-improvements)\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/actions-orders)\n\n[Fetching marketplace information with the Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/get-marketplace-data-orders-api)\n\n[Fetching payment details from a Mercado Libre order with Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/get-payment-data-mercado-libre-orders-api)\n\n[Formatting order invoicing time via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/formatting-order-invoicing-time)\n\n[Using VTEX Admin filters on orders via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/using-orders-management-filters-in-api)\n\n[Adding a second address for invoicing an order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/adding-a-second-address-to-the-order)\n\nSubscriptions\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/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/formatting-order-invoicing-time/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/formatting-order-invoicing-time/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/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/formatting-order-invoicing-time/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n[Feed v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/orders-feed)\n\n[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/order-modifications)\n\n[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/change-seller)\n\n[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/order-canceling-improvements)\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/actions-orders)\n\n[Fetching marketplace information with the Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/get-marketplace-data-orders-api)\n\n[Fetching payment details from a Mercado Libre order with Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/get-payment-data-mercado-libre-orders-api)\n\n[Formatting order invoicing time via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/formatting-order-invoicing-time)\n\n[Using VTEX Admin filters on orders via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/using-orders-management-filters-in-api)\n\n[Adding a second address for invoicing an order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/adding-a-second-address-to-the-order)\n\nSubscriptions\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/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/formatting-order-invoicing-time/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/formatting-order-invoicing-time/docs/guides)\n\nOrders\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/actions-orders)\n\n[Formatting order invoicing time via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time/docs/guides/formatting-order-invoicing-time)\n\nFormatting order invoicing time via API\n\nWhen submitting invoice data to a marketplace via API, you can use the endpoint [Update order's partial invoice](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/updatepartialinvoicesendtrackingnumber) to format the order invoicing time. The correct JSON format for the request is as the following example:\n\n`1\n\n{ \n\n2\n\n \"type\":\"Output\", \n\n3\n\n \"issuanceDate\":\"2017-10-05T11:32:11\", \n\n4\n\n \"invoiceNumber\":\"9999\", \n\n5\n\n \"invoiceValue\":\"10000\", \n\n6\n\n \"invoiceKey\": null, \n\n7\n\n \"invoiceUrl\": null, \n\n8\n\n \"courier\": null, \n\n9\n\n \"trackingNumber\": null, \n\n10\n\n \"trackingUrl\": null, \n\n11\n\n \"items\": [ \n\n12\n\n { \n\n13\n\n \"id\": \"1234\", \n\n14\n\n \"price\": 10000, \n\n15\n\n \"quantity\": 1 \n\n16\n\n } \n\n17\n\n ] \n\n18\n\n } \n\n`\n\nThe property responsible for informing the invoicing date and time is `issuanceDate`. This field follows the UTC 0 time zone.\n\nIf you want to include a time with a specific time zone (for example: \"UTC -3\"), you must use a format like the example below:\n\n`\"issuanceDate\": \"2017-10-05T11:32:11-0300\"`\n\n**Attention:** Do not use any spaces on the date.\n\nNote that integrations that fetch order data from the VTEX system should also be aware of the time zone and make the necessary adjustments.\n\nFor details on how the request should be formatted, see the API [Update order's partial invoice](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/updatepartialinvoicesendtrackingnumber).\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/Orders/actions-orders/formatting-order-invoicing-time.md)\n\n[Fetching payment details from a Mercado Libre order with Orders API« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time//docs/guides/get-payment-data-mercado-libre-orders-api)[Using VTEX Admin filters on orders via APINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/formatting-order-invoicing-time//docs/guides/using-orders-management-filters-in-api)\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/Orders/actions-orders/formatting-order-invoicing-time.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_7046cb5c
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides calling commerce apis 2 discovering vtex commerce apis and 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/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-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/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-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/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-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/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-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/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-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/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/vtex-io-documentation-service)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[1\\. Getting the Service app boilerplate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate)\n\n[2\\. Discovering VTEX Commerce APIs and authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication)\n\n[3\\. Using VTEX IO clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/calling-commerce-apis-3-using-vtex-io-clients)\n\n[Calling Commerce APIs - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/calling-commerce-apis-conclusion)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/vtex-io-documentation-clients)\n\nHandling events\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/service-path-patterns)\n\n[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/configuring-dynamic-routes-in-vtex-io-services)\n\n[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/vtex-io-documentation-developing-service-configuration-apps)\n\n[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/node-builder-7x-migration-guide)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/vtex-io-documentation-service)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[1\\. Getting the Service app boilerplate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate)\n\n[2\\. Discovering VTEX Commerce APIs and authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication)\n\n[3\\. Using VTEX IO clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/calling-commerce-apis-3-using-vtex-io-clients)\n\n[Calling Commerce APIs - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/calling-commerce-apis-conclusion)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/vtex-io-documentation-clients)\n\nHandling events\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/service-path-patterns)\n\n[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/configuring-dynamic-routes-in-vtex-io-services)\n\n[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/vtex-io-documentation-developing-service-configuration-apps)\n\n[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/node-builder-7x-migration-guide)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/app-development)\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/app-development-guides)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[2\\. Discovering VTEX Commerce APIs and authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication)\n\n2\\. Discovering VTEX Commerce APIs and authentication\n\nNow that we have a comprehensive understanding of the project structure, it's important to address API authentication before we proceed with calling VTEX Core Commerce APIs. VTEX strongly advises against using the `AppKey` and `AppToken` pair in VTEX IO apps. Instead, the recommended practice involves utilizing the VTEX ID token.\n\nEvery app developed on VTEX IO represents a resource on the platform. This allows an app to interact with other systems on behalf of itself, duly authorized by the account administrator. It is the reponsibility of the app developer to declare the necessary permissions. In practical terms, this entails:\n\n* Declaring both the endpoint and the [roles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-roles) required to access any API in the apps's `manifest.json` file.\n* Making request with a **VTEX ID token** instead of the **AppKey** and **AppToken** pair. For more information, refer to [App authentication using auth tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens).\n\n## Logging the app token\n\nEach VTEX IO app is issued a corresponding `authToken`. This token can be obtained from the `ctx` object and contains all the permissions declared in the `policies` field of the app's `manifest.json` file.\n\nTo inspect the `authToken` of an app, go to the `node/middlewares/validate.ts` file and add the highlighted log code.\n\n## Checking the app token\n\nWith the app linked to your development workspace, access the service route and check the content logged in the terminal. Use the following URL format: `https://{workspace}-{account}.myvtex.com/_v/status/:code`, replacing `{workspace}` and `{account}` according to your scenario, and `:code` with `200`\n\n## Decoding the app token\n\nCheck the content of this token using a platform such as [jwt.io](https://read.calvincode.net/reader?url=https://jwt.io/). This decoded representation provides valuable details, including the associated account and workspace, user and role information, as well as timestamps for token validity.\n\nnode/middlewares/validate.ts\n\n`1\n\nimport { UserInputError } from '@vtex/api' \n\n2\n\n \n3\n\nexport async function validate(ctx: Context, next: () => Promise<any>) { \n\n4\n\n const { \n\n5\n\n vtex: { \n\n6\n\n route: { params }, \n\n7\n\n }, \n\n8\n\n } = ctx \n\n9\n\n \n10\n\n console.log(ctx.vtex.authToken) \n\n11\n\n console.info('Received params:', params) \n\n12\n\n \n13\n\n const { code } = params \n\n14\n\n \n15\n\n if (!code) { \n\n16\n\n throw new UserInputError('Code is required') // Wrapper for a Bad Request (400) HTTP Error. Check others in https://github.com/vtex/node-vtex-api/blob/fd6139349de4e68825b1074f1959dd8d0c8f4d5b/src/errors/index.ts \n\n17\n\n } \n\n18\n\n \n19\n\n const codeNumber = parseInt(code as string, 10) \n\n20\n\n \n21\n\n ctx.state.code = codeNumber \n\n22\n\n \n23\n\n await next() \n\n24\n\n} \n\n`\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Calling Commerce APIs/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication.mdx)\n\n[1\\. Getting the Service app boilerplate« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication//docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate)[3\\. Using VTEX IO clientsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication//docs/guides/calling-commerce-apis-3-using-vtex-io-clients)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Logging the app token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication%23logging-the-app-token)\n\n[Checking the app token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication%23checking-the-app-token)\n\n[Decoding the app token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication%23decoding-the-app-token)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Calling Commerce APIs/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Logging the app token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication%23logging-the-app-token)\n\n[Checking the app token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication%23checking-the-app-token)\n\n[Decoding the app token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication%23decoding-the-app-token)\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_6509d8a6
|
[
{
"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 link 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-link/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-link/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-link/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-link/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-link/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-link/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-link/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-link/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-link/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/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-link/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/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-link/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-overview)\n\n[Badge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-badge)\n\n[Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-button)\n\n[Checkbox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-checkbox)\n\n[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-icon)\n\n[Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-input)\n\n[Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-label)\n\n[Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-link)\n\n[List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-list)\n\n[Loader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-loader)\n\n[Overlay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-overlay)\n\n[Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-price)\n\n[Radio](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-radio)\n\n[Select](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-select)\n\n[SROnly](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-sr-only)\n\n[Skeleton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-skeleton)\n\n[Slider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-slider)\n\n[Textarea](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-textarea)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/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-link/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-link/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-link/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-link/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/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-link/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-link/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/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-link/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-link/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/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-link/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/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-link/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-overview)\n\n[Badge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-badge)\n\n[Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-button)\n\n[Checkbox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-checkbox)\n\n[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-icon)\n\n[Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-input)\n\n[Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-label)\n\n[Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-link)\n\n[List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-list)\n\n[Loader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-loader)\n\n[Overlay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-overlay)\n\n[Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-price)\n\n[Radio](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-radio)\n\n[Select](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-select)\n\n[SROnly](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-sr-only)\n\n[Skeleton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-skeleton)\n\n[Slider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-slider)\n\n[Textarea](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-textarea)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/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-link/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-link/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-link/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-link/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/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-link/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-link/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-link/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-overview)\n\nLink\n\nLinks allow users to easily navigate through web pages.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/atoms/Link)\n\nThe `Link` component behaves like a regular anchor tag (`a`), but it can be rendered as any HTML tag or component, including specific framework link components.\n\nExample\n\nCode\n\nDefaultDisplayInlineSmall\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { Link } 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/Link/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#### Inverse\n\nExample\n\nCode\n\nInverse Link\n\n#### Display\n\nExample\n\nCode\n\nDisplay Link\n\n#### Inline\n\nExample\n\nCode\n\nInline Link\n\n### Size\n\n#### Small\n\nExample\n\nCode\n\nSmall Link\n\n---\n\n## Design tokens\n\n| Local token | Default value/Global token linked |\n| -------------------------------- | --------------------------------------- |\n| \\--fs-link-min-width | auto |\n| \\--fs-link-min-height | var(--fs-link-min-width) |\n| \\--fs-link-padding | var(--fs-spacing-2) var(--fs-spacing-0) |\n| \\--fs-link-border-radius | var(--fs-border-radius) |\n| \\--fs-link-text-line-height | 1.5 |\n| \\--fs-link-text-color | var(--fs-color-link) |\n| \\--fs-link-text-color-visited | var(--fs-color-link-visited) |\n| \\--fs-link-text-decoration | none |\n| \\--fs-link-text-decoration-hover | underline |\n| \\--fs-link-transition-function | var(--fs-transition-function) |\n| \\--fs-link-transition-property | var(--fs-transition-property) |\n| \\--fs-link-transition-timing | var(--fs-transition-timing) |\n\n### Design tokens: Inverse\n\nInverse links use light colors optimized for dark backgrounds, ensuring proper contrast and readability in inverted color schemes.\n\n| Local token | Default value/Global token linked |\n| ------------------------------------- | --------------------------------- |\n| \\--fs-link-inverse-text-color | var(--fs-color-link-inverse) |\n| \\--fs-link-inverse-text-color-visited | var(--fs-link-inverse-text-color) |\n\n### Design tokens: Inline\n\nInline links are designed to blend within text content, featuring minimal padding and underlined text for clear identification within paragraphs.\n\n| Local token | Default value/Global token linked |\n| --------------------------------- | --------------------------------- |\n| \\--fs-link-inline-padding | 0 |\n| \\--fs-link-inline-text-decoration | underline |\n| \\--fs-link-inline-text-color | var(--fs-link-text-color) |\n\n### Design tokens: Small\n\nSmall links use reduced font size and padding to create a more compact appearance, ideal for dense layouts or secondary navigation elements.\n\n| Local token | Default value/Global token linked |\n| -------------------------- | --------------------------------------- |\n| \\--fs-link-small-text-size | var(--fs-text-size-1) |\n| \\--fs-link-small-padding | var(--fs-spacing-1) var(--fs-spacing-0) |\n\n### Design tokens: Display\n\nDisplay links use prominent styling suitable for standalone navigation elements or headings, maintaining visual hierarchy while preserving link behavior.\n\n| Local token | Default value/Global token linked |\n| ------------------------------------- | --------------------------------- |\n| \\--fs-link-display-text-line-height | var(--fs-link-text-line-height) |\n| \\--fs-link-display-text-color | var(--fs-color-text-display) |\n| \\--fs-link-display-text-color-visited | var(--fs-link-display-text-color) |\n\n---\n\n## Data attributes\n\nYou can target and override `Link` styles using the following data attributes:\n\n`data-fs-link`\n\n`data-fs-link-variant=\"default\" | \"display\" | \"inline\"`\n\n`data-fs-link-size=\"small\" | \"regular\"`\n\n`data-fs-link-inverse=\"true\"`\n\n---\n\n## Props\n\nThe `Link` component supports all attributes supported by the `a` tag. If you need to use it as an external link component (i.e., Next.js `Link` or Gatsby `Link`), the FastStore UI `Link` component can be used with the `as={NextLink}` prop.\n\nBesides those attributes, the following props are also supported:\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-link | |\n| **variant** | 'default' \\| 'display' | 'inline' | Specifies the component variant. | default |\n| **size** | 'small' \\| 'regular' | Specifies the size variant. | regular | |\n| **inverse** | boolean | Defines the use of inverted colors. | | |\n| **as** | string \\| PolymorphicComponentPropsWithRef | Defines how this component should behave. | a | |\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/link.mdx)\n\n[Label« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-label)[ListNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-list)\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-link/docs/guides/faststore/atoms-link%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-link%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-link%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-link%23examples)\n\n[Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-link%23variants)[Size](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-link%23size)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-link%23design-tokens)\n\n[Design tokens: Inverse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-link%23design-tokens-inverse)[Design tokens: Inline](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-link%23design-tokens-inline)[Design tokens: Small](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-link%23design-tokens-small)[Design tokens: Display](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-link%23design-tokens-display)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-link%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-link%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/atoms/link.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-link/docs/guides/faststore/atoms-link%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-link%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-link%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-link%23examples)\n\n[Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-link%23variants)[Size](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-link%23size)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-link%23design-tokens)\n\n[Design tokens: Inverse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-link%23design-tokens-inverse)[Design tokens: Inline](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-link%23design-tokens-inline)[Design tokens: Small](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-link%23design-tokens-small)[Design tokens: Display](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-link%23design-tokens-display)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-link%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link/docs/guides/faststore/atoms-link%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_3a62bd08
|
[
{
"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 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/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/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/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/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/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/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/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/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/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/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/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/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/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/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/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/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/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/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-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.product-summary/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/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/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/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/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/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/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/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/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/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/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/guides/basic-components)\n\nProduct Summary\n\nOfficial extension\n\nVersion: 2.91.0\n\nLatest version: 2.91.0\n\n[](#contributors-)\n\nProduct Summary is an app for summarizing product information (such as name, price, and image) in other store blocks, such as the [Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/) and the [Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/).\n\n\n\n## Configurating the product summary\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\nNow, you can use all blocks exported by the `product-summary` app. See the full list below:\n\n| Block name | Description |\n| ------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [list-context.product-list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarylist) |  Renders the list of products in the Product Summary component. It fetches product information and provides it to the product-summary.shelf block. Then, this block provides its child blocks with the product information. |\n| product-summary.shelf |  Logical block that provides the needed structure for the Product Summary component through its child blocks (listed below). |\n| [product-summary-attachment-list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryattachmentlist) | Renders a list for product [attachments](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU). |\n| [product-summary-brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarybrand) | Renders the product brand. |\n| [product-summary-buy-button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarybuybutton) | Renders the Buy button. This block must only be configured if your store uses the [Minicart v1](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/minicart/blob/383d7bbd3295f06d1b5854a0add561a872e1515c/docs/README.md). If your store uses the [Minicart v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart), please configure the [**Add to Cart button**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button) instead. |\n| [product-summary-description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarydescription) | Renders the product description. |\n| [product-summary-image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryimage) | Renders the product image. |\n| [product-summary-name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryname) | Renders the product name. |\n| [product-summary-sku-name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryskuname) | Renders the selected SKU name. |\n| product-summary-price |  Renders the product price. This block has been deprecated in favor of the [Product Price](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-product-summary-3.png) app. Although support for this block is still available, we strongly recommend using the Product Price app. |\n| [product-summary-sku-selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryskuselector) | Renders the SKU Selector block. |\n| [product-specification-badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-product-summary-productsummaryspecificationbadges) | Renders badges based on product specifications. |\n\n1. Add the `list-context.product-list` block to a store template of your choice, and declare the `product-summary.shelf` in its block list. For example:\n\n`1\n\n{ \n\n2\n\n \"list-context.product-list\": { \n\n3\n\n \"blocks\": [\"product-summary.shelf\"] \n\n4\n\n }, \n\n`\n\n> Although the block name 'product-summary.shelf' alludes to the Shelf component, it is not necessary to use this block in order to create a shelf component. The Product Summary Shelf displays a summary of the product information in other components, such as the [Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart) and the [Search Results](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-result) pages.\n\n1. Add the blocks from the list above as children of the `product-summary.shelf`, considering the product information you want to display in the product list. Take the following example in which the product name, description, image, price, SKU selector, and Buy button are all displayed in the Product Summary:\n\n`1\n\n{ \n\n2\n\n \"list-context.product-list\": { \n\n3\n\n \"blocks\": [\"product-summary.shelf\"] \n\n4\n\n }, \n\n5\n\n \n6\n\n \"product-summary.shelf\": { \n\n7\n\n \"children\": [ \n\n8\n\n \"product-summary-name\", \n\n9\n\n \"product-summary-description\", \n\n10\n\n \"product-summary-image\", \n\n11\n\n \"product-summary-price\", \n\n12\n\n \"product-summary-sku-selector\", \n\n13\n\n \"product-summary-buy-button\" \n\n14\n\n ] \n\n15\n\n } \n\n16\n\n} \n\n`\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| aspectRatio |\n| buyButton |\n| buyButtonContainer |\n| clearLink |\n| column |\n| container |\n| containerNormal |\n| containerSmall |\n| containerInline |\n| description |\n| element |\n| image |\n| imageContainer |\n| imagePlaceholder |\n| information |\n| isHidden |\n| nameContainer |\n| priceContainer |\n| quantityStepperContainer |\n| spacer |\n\n[Product Specifications« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-specifications)[Product Summary Attachment ListNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)[ProductSummaryAttachmentListVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList)[ProductSummaryPriceVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary@2.91.0/ProductSummaryPrice)[ProductSummaryShelfVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary@2.91.0/ProductSummaryShelf)[ProductSummaryListVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary@2.91.0/ProductSummaryList)[ProductSummaryBuyButtonVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary@2.91.0/ProductSummaryBuyButton)[ProductSummarySpecificationBadgesVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary@2.91.0/ProductSummarySpecificationBadges)[ProductSummaryImageVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary@2.91.0/ProductSummaryImage)[ProductSummaryDescriptionVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary@2.91.0/ProductSummaryDescription)[ProductSummarySKUSelectorVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUSelector)[ProductSummaryNameVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary@2.91.0/ProductSummaryName)[ProductSummarySKUNameVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName)[ProductSummaryBrandVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary@2.91.0/ProductSummaryBrand)\n\nON THIS PAGE\n\n[Configurating the product summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-summary%23configurating-the-product-summary)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/docs/apps/vtex.product-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_7c7ecd92
|
[
{
"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 of controls for templates 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-of-controls-for-templates/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates/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-of-controls-for-templates/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-of-controls-for-templates/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-of-controls-for-templates/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-of-controls-for-templates/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-of-controls-for-templates/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/list-of-controls-for-templates/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates/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/list-of-controls-for-templates/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/list-of-controls-for-templates/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/list-of-controls-for-templates/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/list-of-controls-for-templates/docs/guides/setting-up-the-zoom)\n\n[Creating gift lists](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates/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/list-of-controls-for-templates/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/list-of-controls-for-templates/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/list-of-controls-for-templates/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/list-of-controls-for-templates/docs/guides/configure-the-price-history-control)\n\n[Shelf template controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates/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/list-of-controls-for-templates/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/list-of-controls-for-templates/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates/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/list-of-controls-for-templates/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates/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/list-of-controls-for-templates/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/list-of-controls-for-templates/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/list-of-controls-for-templates/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/list-of-controls-for-templates/docs/guides/setting-up-the-zoom)\n\n[Creating gift lists](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates/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/list-of-controls-for-templates/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/list-of-controls-for-templates/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/list-of-controls-for-templates/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/list-of-controls-for-templates/docs/guides/configure-the-price-history-control)\n\n[Shelf template controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates/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/list-of-controls-for-templates/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/list-of-controls-for-templates/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates/docs/storefront-development)\n\n(Legacy) CMS Portal\n\n[List of controls for templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates/docs/guides/list-of-controls-for-templates)\n\nList of template controls\n\nThe controls listed in this article can be used by your store's frontend developer to create the store page layout in the **Storefront > Layout** module.\n\n* [General controls](#general-controls)\n* [Product page controls](#product-page-controls) \n * [RichSnippets controls](#richsnippets-controls)\n* [Department, category, and search page controls](#department-category-and-search-page-controls)\n* [Other controls](#other-controls)\n* [Deprecated controls](#deprecated-controls)\n\n## General controls\n\nYou can use the controls listed below in most pages in your store.\n\n| Control | Description |\n| -------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| <vtex.cmc:breadCrumb/> | **Breadcrumb:** Indicates the user's current location in your store website and the pages they accessed to get to the current one. Works in product, department, category, and search pages. |\n| <vtex.cmc:fullTextSearchBox/> | **Search control:** Displays the search bar in your store. For more information, read [Search Control - fulltextSearchBox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-control-fulltextsearchbox). |\n| <vtex.cmc:welcomeMessage/> | **Welcome message:** Displays a welcome message to anyone visiting your store. To customize this message, go to the **Store Settings > Storefront** module and click **Settings**. In the Store Texts tab, look for the topbarSaudacao command in the ID options and select it. In the text box that will display automatically, you can edit the welcome message and then Save. |\n| <vtex:metaTags/> | **Meta tags:** Defines the page meta tags — tags that are useful for search engines to identify your content easily. |\n| <vtex.cmc:canonicalPage disable=\"true\"/> | **Disable canonical tag:** If this control is set to true, the canonical tag will be disabled in the page. Using this tag indicates duplicate content to search engines and prioritizes it correctly in page tracking. |\n| <vtex.cmc:departmentLinks/> | **Department links:** Displays links for the first level of categories (departments) created in the Admin. For the category to be listed, the Menu field must be enabled when [creating the category](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/registering-a-category--tutorials%5F206). |\n| <vtex.cmc:departmentNavigator/> | **Department menu:** Displays a menu with your store departments and categories (levels 1 and 2). To display the link for the complete list, the Menu field must be enabled when [creating categories](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/registering-a-category--tutorials%5F206). This menu also displays brands that have the _[Display in Home menu](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/campos-de-cadastro-de-marca--37Ky7lTbEkiWIAYA80EMyI%23)_ option enabled and category specifications, such as size and color. This control is indicated for use as a side menu. |\n| <vtex.cmc:searchTitle/> | **Page title:** Displays the title of departments, categories, and search pages. |\n| <vtex.cmc:productQuickView/> | **QuickView:** This control needs to be added before closing the </body> tag in the QuickView page template. It is key for loading the files needed in the page. |\n| <vtex.cmc:ProductQueryStringReferenceShelf/> | **Shelf:** Allows you to configure a shelf in your store using the attributes listed below. |\n\nBelow, you can see a description of the **Shelf** control `<vtex.cmc:ProductQueryStringReferenceShelf/>` attributes:\n\n| Tag attribute | Description |\n| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |\n| layout | Shelf template ID. Required attribute. |\n| itemCount | Number of items to be displayed. Required attribute. |\n| columnCount | Number of columns. Required attribute. |\n| showUnavailable | The page will display out-of-stock products when this attribute is set to true. |\n| selectionMode=”batch-buy” | Optional attribute that allows sorting products in bulk. |\n| isTrackable | This control is trackable when this attribute is set to true. |\n| InternalCampaign | Name of the internal [campaign audience](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-campaign-audiences--6cnuDZJzIkIeocewAQQK4K). |\n| InternalPart | Internal _ViewPart_ name. |\n\n**Shelf** control example:\n\n`1\n\n<vtex.cmc:ProductQueryStringReferenceShelf layout=\"e2ed81f5-6241-4418-a47b-018d7482fcf0\" itemCount=\"3\" columnCount=\"3\" showUnavailable=\"true\" isTrackable=\"true\" InternalCampaign=\"Landing highlight\" InternalPart=\"Window display highlight\"/> \n\n`\n\n## Product page controls\n\n| Control | Description |\n| --------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| <vtex.cmc:ProductGifts /> | **Display giveaways on the product page:** Displays the giveaways attached to the product, if you have configured a Buy One, Get One promotion in your store. [See how to configure this type of promotion](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-to-set-a-buy-and-win-promotion-gift-for-a-specific-sku--4QlFtwxAju6qOwaCi2YS0G). |\n| <vtex.cmc:productName/> | **Product name:** Displays the name of the product. |\n| <vtex.cmc:brandName/> | **Product brand with link:** Displays the product's brand with a link to access a list of products in the same brand and category in your store. |\n| <vtex.cmc:ProductImage/> | **Thumbnail of the main product image:** Displays a thumbnail of the main product image. |\n| <vtex.cmc:productReference/> | **Product reference code:** Displays the product reference code. |\n| <vtex.cmc:skuReference/> | **SKU reference code:** Displays the reference code of the SKU. |\n| <vtex.cmc:skuPrice/> | **List prices, Computed prices, Installments, and “Save” promotion:** List prices and “Save” promotions are only displayed if the product's computed price is lower than its list price. The best installment plan will be displayed to the customer based on the total price of the order and the interest-free payment options. It does not display information when the product display mode is **SKU list**. |\n| <vtex.cmc:skuSelection /> | **SKU selection:** Allows selecting the product variation following the Admin configuration (radio and combo). |\n| <vtex.cmc:OtherPaymentMethod/> | **View other payment methods:** Displays the best payment and installment conditions for a SKU. The SKU must be available in stock for the control to be displayed. This control does not work for categories displayed as \"List\" in products with multiple SKUs. |\n| <vtex.cmc:Delivery/> | **Availability:** Displays the estimated time it will take for the product to be available, depending on the default logistics route. |\n| <vtex.cmc:stockKeepingUnitRewardValue/> | **Loyalty Program Value:** Displays the value of the SKU in the store's loyalty program. |\n| <vtex.cmc:BuyTogether/> | **Buy together:** Displays the SKUs selected in the **Display together** field when adding a SKU. |\n| <vtex.cmc:ProductDescription/> | **Product description:** Displays the information entered in the **Description** field of the product form. |\n| <vtex.cmc:productDescriptionShort/> | **Product short description:** Displays the value entered in the **Additional description** field of the product form. |\n| <vtex.cmc:productSpecification/> | **Product specification:** Additional properties that can be added to your products. |\n| <vtex.cmc:StockKeepingUnitAttributes/> | **SKU specification:** Also displays \"unstructured attributes\" used for seller products. |\n| <vtex.cmc:stockKeepingUnitMeasures/> | **Actual SKU dimensions:** Shows the SKU height, width, length, and weight. |\n| <vtex.cmc:ProductTag/> | **Associated tags** |\n| <vtex.cmc:PageSearch/> | **Search within the product page** |\n| <vtex.cmc:BuyButton/> | **Buy button:** Displays the button to add the product to the shopping cart. If the product is out of stock, this control will display the “Notify Me” option, [if enabled](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/set-up-the-avise-me--2VqVifQuf6Co2KG048Yu6e). |\n| <vtex.cmc:BuyInPage/> | **Buy button (Asynchronous):** This control adds the product to the shopping cart asynchronously, without leaving the product page. For this control to work properly, it requires the <vtex.cmc:AmountItemsInCart/> control [as described in this article](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates%23department-category-and-search-page-controls). |\n| <vtex.cmc:stockKeepingUnitAmountAndUnitSelection /> | **Quantity selector with multiplier unit:** Renders a fractional quantity field, considering the unit of measure and unit multiplier set for that SKU. The result is the quantity to be purchased. |\n| <vtex.cmc:evaluationRate/> | **Star ratings given by users:** Displays total ratings from users. |\n| <vtex.cmc:giftListInsertSku/> | **Add product to a list** |\n| <vtex.cmc:GiftListFormV2/> | **Form for creating a list** |\n| <vtex.cmc:HightLight/> | **Collection highlight flag** |\n| <vtex.cmc:discountHightLight/> | **Promotion highlight flag** |\n| <vtex.cmc:sellerDescription /> | **Seller description:** Name and image added to the seller of a given product. |\n| <vtex.cmc:SellerOptions /> | **Seller options:** Displays the sellers that offer the product, the product price of each seller, and installment options (up to three different prices). |\n| <vtex.cmc:SalesChannelDropList /> | **Trade policy list:** Displays a list of available trade policies. |\n| <vtex:contentPlaceHolder id=\"ColecaoQVVT\"/> | **”People who looked at this item also looked at” shelf:** It adds a control of type **Related products** in the Legacy CMS Portal that lists products from the same category as the PDP. When editing the element, select QuemViu\\_Viu\\_Tambem in the **Tipo** field and create a new shelf template. It is a quick and easy way to implement \"who looked at this, also looked at\" section, offering shoppers purchasing alternatives. |\n| <vtex:contentPlaceHolder id=\"ColecaoQVCT\"/> | **“People who looked at this item also purchased” shelf:** It adds a control of type **Related products** in the Legacy CMS Portal that lists products from the same category as the PDP. When editing the element, select QuemComprou\\_Viu\\_Tambem in the **Tipo** field and create a new shelf template. It is a quick and easy way to implement \"who looked at this, also purchased\" section, offering shoppers purchasing alternatives. |\n| <vtex:contentPlaceHolder id=\"ColecaoQCCT\"/> | **People who purchased this item also purchased” shelf:** It adds a control of type **Related products** in the Legacy CMS Portal that lists products from the same category as the PDP. When editing the element, select QuemComprou\\_Comprou\\_Tambem in the **Tipo** field and create a new shelf template. It is a quick and easy way to implement \"who purchased this, also purchased\" section, offering shoppers purchasing alternatives. |\n| <vtex:contentPlaceHolder id=\"Similares\"/> | **Similar/Related products:** It adds a control of type **Related products** in the Legacy CMS Portal that lists the SKUs configured as similar in the SKU registration. When editing the element, select Similar in the **Tipo** field. |\n| <vtex:contentPlaceHolder id=\"Acessorios\"/> | **Accessories:** It adds a control of type **Related products** in the Legacy CMS Portal that lists the SKUs configured as accessories in the SKU registration. When editing the element, select Acessorios in the **Tipo** field. |\n| <vtex:contentPlaceHolder id=\"Sugestoes\"/> | **Suggestions:** It adds a control of type **Related products** in the Legacy CMS Portal that lists the SKUs configured as suggestions in the SKU registration. When editing the element, select Sugestao in the **Tipo** field. |\n| <vtex.cmc:facebookLike/> | **Facebook Like** |\n\n### RichSnippets controls\n\nThe `<vtex.cmc:productRichSnippets />` control adds specific tags for sharing information through social media, such as Google microformats, Facebook Open Graph, and Twitter cards. The testing tools are:\n\n1. [Google Structured Data Testing Tool](https://read.calvincode.net/reader?url=https://www.google.com/webmasters/tools/richsnippets)\n2. [Facebook Sharing Debugger](https://read.calvincode.net/reader?url=https://developers.facebook.com/tools/debug/)\n3. [Twitter Card Validator](https://read.calvincode.net/reader?url=https://cards-dev.twitter.com/validator)\n\n| Property | Possible values |\n| -------------- | ----------------------------------- |\n| showGoogle | { \"1\", \"true\", \"on\", \"yes\" } |\n| showFacebook | { \"1\", \"true\", \"on\", \"yes\" } |\n| Twitter | @accountname of the Twitter account |\n| doNotshowPrice | { \"1\", \"true\", \"on\", \"yes\" } |\n| googleRate | { \"1\", \"true\", \"on\", \"yes\" } |\n| fbAdmins | |\n| fbAppId | |\n\n| Control | Example of use |\n| ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |\n| <vtex.cmc:productRichSnippets showGoogle=\"1\"/> | For the product to be indexed on Google, the control needs to be in the <body> tag. |\n| <vtex.cmc:productRichSnippets showFacebook=\"1\" fbAdmins=\"\\[fbAdmins\\]\" fbAppId=\"\\[fbAppId\\]\"/> | For Facebook, the control needs to be in the <head> tag. fbAdmins and fbAppId settings are optional. |\n| <vtex.cmc:productRichSnippets Twitter=\"\\[TwitterAccount\\]\"/> | For Twitter, the control can be added to <head> or <body> tags. Settings can also be grouped together. |\n\n## Department, category, and search page controls\n\n| Control | Description |\n| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| <vtex.cmc:advancedSearchFilter/> | **Advanced Search Filter** |\n| <vtex.cmc:singleDepartmentNavigator/> | **Department menu:** The available attribute is keepCurrentPath. When this attribute is set to true, products will be displayed on the page. |\n| <vtex.cmc:searchNavigator/> | **Search menu/filter:** Displays a menu with your store departments and categories (levels 1 and 2). To display the link to the **complete list**, the **Menu** field must be enabled when [creating categories](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/registering-a-category--tutorials%5F206). |\n| <vtex.cmc:miniCart/> | **Minicart control:** A shopping cart control used in the top menu of all pages — except Checkout and the order confirmation page. This control displays shopping cart information, such as items, quantities, and prices. |\n| <vtex.cmc:AmountItemsInCart> | **Number of items in the shopping cart:** Displays basic information about the shopping cart. This control is required if you use the <vtex.cmc:BuyInPage/> control. For example, you could use it for [KitLook](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-to-assemble-a-look-kit--tutorials%5F266) cases. |\n| <vtex.cmc:searchResult/> | Product search results. The attributes of this control are described below. |\n\nThe `<vtex.cmc:searchResult/>` control attributes are:\n\n| Tag attribute | Description |\n| ------------------------- | ---------------------------------------------------------------------------- |\n| layout | Required attribute. Code of the shelf (template) that will display products. |\n| itemCount | Required attribute. Number of items per page. |\n| columnCount | Required attribute. Number of columns. |\n| showUnavailable | When this attribute is set to true, out-of-stock products will be displayed. |\n| selectionMode=”batch-buy” | Optional attribute that allows sorting products in bulk. |\n| isTrackable | When this attribute is set to true, this control is trackable. |\n| InternalCampaign | Audience name of the internal campaign. |\n| InternalPart | Internal _ViewPart_ name. |\n\nSearch results example:\n\n`1\n\n \n2\n\n<vtex.cmc:searchResult layout=\"48e223e6-da80-4610-b3d5-4e5cfaf94f13\" itemCount=\"10\" columnCount=\"4\" isTrackable=\"true\" InternalCampaign=\"Search results landing\" InternalPart=\"Search Results\" /> \n\n`\n\nFor more information, read the tutorial [Shelf template controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/shelf-template-controls).\n\n## Other controls\n\n| Control | Description |\n| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------- |\n| <vtex.cmc:orderList/> | Displays the customer order list in the **Orders** section of **My account** – /account/orders |\n| <vtex.cmc:accountUserProfile/> | Displays the customer information in **My account** – /account |\n| <vtex.cmc:accountAddress/> | Displays the customer addresses on the **My account** page – /account |\n| <vtex.cmc:sellerInfo /> | Displays the seller information on the platform and should be used on the seller detail page in the seller-info folder. |\n\n## Deprecated controls\n\n| Control | Description | Page |\n| -------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |\n| <vtex.cmc:productPageTitle/> | DEPRECATED **Product title** | Product page |\n| <vtex.cmc:stockKeepingUnitSelection/> | DEPRECATED **SKU selection**. Use <vtex.cmc:skuSelection/> instead. | Product page |\n| <vtex.cmc:skuRichSelection changeImage=\"1\"/> | DEPRECATED **SKU checkbox selection** | Product page |\n| <vtex.cmc:shippingValue/> | DEPRECATED **Calculate shipping cost and delivery time frame**. This control has a [known issue](https://read.calvincode.net/reader?url=https://help.vtex.com/en/known-issues/a-viewpart-shippingvalue-nao-exibe-prazos-em-horas-corretamente--5hvl9eGxPLZAuNcFAFc9Vb%23). | Product page |\n| <vtex.cmc:stockKeepingUnitService/> | DEPRECATED **SKU services** | Product page |\n| <vtex.cmc:StockKeepingUnitPriceHistory Months=\"6\" Percentile=\"100\"/> | DEPRECATED **Price history** | Product page |\n| <vtex.cmc:evaluationRate/> | DEPRECATED **Consumer rating (stars)**. Previously, this displayed the average star rating from customers. | Product page |\n| <vtex.cmc:UserReview/> | DEPRECATED **Ratings and comments**. This previously displayed an option to rate products, a form to add a review, rating results, and added reviews. | Product page |\n| <vtex.cmc:welcomeMessage/> | DEPRECATED **User login**. This created the IPI cookie used by the <vtex.cmc:UserReview/> control. Without it, login was required in a loop when trying to add a review. | Product page |\n\nContributors\n\n5\n\n[](https://github.com/karenkrieger)\n\n[](https://github.com/barbara-celi)\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/GeorgeLimaDev)\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/legacy-cms/list-of-controls-for-templates.md)\n\n[Can I order my product as I want?« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates//docs/guides/can-i-order-my-product-as-i-want)[Setting up the zoomNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates//docs/guides/setting-up-the-zoom)\n\nContributors\n\n5\n\n[](https://github.com/karenkrieger)\n\n[](https://github.com/barbara-celi)\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/GeorgeLimaDev)\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[General controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates/docs/guides/list-of-controls-for-templates%23general-controls)\n\n[Product page controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates/docs/guides/list-of-controls-for-templates%23product-page-controls)\n\n[RichSnippets controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates/docs/guides/list-of-controls-for-templates%23richsnippets-controls)\n\n[Department, category, and search page controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates/docs/guides/list-of-controls-for-templates%23department-category-and-search-page-controls)\n\n[Other controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates/docs/guides/list-of-controls-for-templates%23other-controls)\n\n[Deprecated controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates/docs/guides/list-of-controls-for-templates%23deprecated-controls)\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/list-of-controls-for-templates.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[General controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates/docs/guides/list-of-controls-for-templates%23general-controls)\n\n[Product page controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates/docs/guides/list-of-controls-for-templates%23product-page-controls)\n\n[RichSnippets controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates/docs/guides/list-of-controls-for-templates%23richsnippets-controls)\n\n[Department, category, and search page controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates/docs/guides/list-of-controls-for-templates%23department-category-and-search-page-controls)\n\n[Other controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates/docs/guides/list-of-controls-for-templates%23other-controls)\n\n[Deprecated controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/list-of-controls-for-templates/docs/guides/list-of-controls-for-templates%23deprecated-controls)\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_476e2b6c
|
[
{
"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 and create clients on vtex io in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-service)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-clients)\n\n[Developing custom Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-how-to-create-and-use-clients)\n\n[Connecting to VTEX Core Commerce APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io)\n\n[Using Clients in Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/using-node-clients)\n\nHandling events\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/service-path-patterns)\n\n[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/configuring-dynamic-routes-in-vtex-io-services)\n\n[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-developing-service-configuration-apps)\n\n[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/node-builder-7x-migration-guide)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-service)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-clients)\n\n[Developing custom Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-how-to-create-and-use-clients)\n\n[Connecting to VTEX Core Commerce APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io)\n\n[Using Clients in Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/using-node-clients)\n\nHandling events\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/service-path-patterns)\n\n[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/configuring-dynamic-routes-in-vtex-io-services)\n\n[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-developing-service-configuration-apps)\n\n[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/node-builder-7x-migration-guide)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/app-development)\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/app-development-guides)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-clients)\n\n[Developing custom Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-how-to-create-and-use-clients)\n\nDeveloping Clients\n\nLearn how to develop custom Clients for seamless communication with other services.\n\nIf you need to integrate your VTEX IO app with external services that aren't covered by [VTEX IO's native Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients), creating custom Clients can be a powerful solution. Custom Clients extend the functionality of VTEX IO Client types, offering benefits like caching and versioning. This guide will walk you through the process of creating custom Clients for your VTEX IO apps.\n\n> Note that direct communication with APIs is generally discouraged in favor of implementing a dedicated Client. By creating custom Clients, you can extend the capabilities of your VTEX IO applications, enabling seamless integration with a wide range of services.\n\nThe diagram below illustrates how an app works with a Client to an external service:\n\nRequester / eventIO appExternalserviceRequest to IO app / event listened by IO appRequest with custom ClientResponse of external service\\[If requester\\] Response of IO appRequester / eventIO appExternalservice\n\nAs you develop your custom Client, you will define methods within it. These Client methods are functions responsible for handling the logic needed to execute specific actions. They facilitate interactions with services and APIs, managing requests and responses effectively.\n\nOnce you've created your custom Client, you can seamlessly integrate it into your VTEX IO app to execute the implemented methods. While you have the flexibility to incorporate data-handling logic within your Client's methods (e.g., field mapping or data filtering), it's essential to keep the core responsibilities of the Client well-organized.\n\n## Before you begin\n\nBefore diving into Client development, make sure you have the following prerequisites in place:\n\n* **VTEX IO development workspace:** Ensure you have a VTEX IO development workspace set up. For more information, refer to [Creating a Development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace).\n* **TypeScript Familiarity:** This guide assumes you have a basic understanding of TypeScript, as we'll be using the `node` [Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders) to develop with TypeScript. For more information, refer to [TypeScript's official documentation](https://read.calvincode.net/reader?url=https://www.typescriptlang.org/docs/).\n* **Understanding of Clients:** Clients play a crucial role in facilitating interactions between your application and both external and internal services. For more information, refer to [Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients).\n\n## Instructions\n\nIn this guide, we will create a custom Client example for communicating with GitHub APIs. We'll implement the following methods within our Client:\n\n* `getRepo`: Fetches a GitHub repository given the owner and repository name.\n* `getUser`: Retrieves GitHub user data based on a specified GitHub username.\n* `createTag`: Creates a new tag on GitHub, taking into account the repository owner, repository, and tag data.\n* `searchRepos`: Searches for GitHub repositories using a specified query.\n\n### Step 1 - Setting up your VTEX IO app\n\n1. Start a new VTEX IO app using the `node` builder and open the project using your preferred code editor.\n2. Open a terminal and navigate to the `node` folder of your project. \n`1 \ncd node \n`\n3. Install the `@vtex/api` and `@octokit/rest` packages by running the following command: \n`1 \nyarn add @vtex/api @octokit/rest \n`\n4. Open the app's `manifest.json` file and add the necessary [Policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies). Policies are a set of permissions granted to an app, allowing or forbidding it to execute a given set of actions, such as making requests to an external resource. For this example, we will use the `outbound-access` policy to communicate with GitHub APIs (`api.github.com`). \nmanifest.json \n`1 \n\"policies\": [ \n2 \n { \n3 \n \"name\": \"outbound-access\", \n4 \n \"attrs\": { \n5 \n \"host\": \"api.github.com\", \n6 \n \"path\": \"*\" \n7 \n } \n8 \n }, \n9 \n] \n` \n> Note that incorrect policies may result in request blocking.\n\n### Step 2 - Creating a custom Client\n\n1. Create a folder named `clients` inside the `node` directory.\n2. Create a TypeScript file for your Client in the `node/clients` directory. Choose a name that easily identifies your Client (e.g., `github.ts`).\n3. Implement the TypeScript class that extends the appropriate [Client type](#client-types) from `@vtex/api`. In this example, we will create the `GithubClient`. Also, since we are communicating with GitHub's external APIs, we will use `ExternalClient`.\n4. Use [InstanceOptions](#instanceoptions) as needed, configuring options such as authentication, timeout, caching, and more based on your requirements.\n\nnode/clients/github.ts\n\n`1\n\nimport type { IOContext, InstanceOptions } from '@vtex/api' \n\n2\n\nimport { ExternalClient } from '@vtex/api' \n\n3\n\n \n4\n\nexport default class GithubClient extends ExternalClient { \n\n5\n\n constructor(context: IOContext, options?: InstanceOptions) { \n\n6\n\n super('http://api.github.com', context, { \n\n7\n\n ...options, \n\n8\n\n retries: 2, \n\n9\n\n headers: { \n\n10\n\n Accept: 'application/vnd.github.machine-man-preview+json', \n\n11\n\n 'x-vtex-use-https': 'true' \n\n12\n\n } \n\n13\n\n }); \n\n14\n\n } \n\n15\n\n \n16\n\n // Add the Client-related methods here \n\n17\n\n} \n\n`\n\nEnsure to export the Client from its module, either [default or named export](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/export).\n\n### Step 3 - Implementing Client methods\n\nWithin your Client TypeScript file, implement the methods for your Client. You can leverage the methods provided by the [HttpClient](#httpclient-methods) to build your own methods. For example:\n\nnode/clients/github.ts\n\n`` 1\n\nimport type { RestEndpointMethodTypes } from '@octokit/rest' \n\n2\n\n \n3\n\n... \n\n4\n\n \n5\n\n public getRepo({ owner, repo }: GitRepo, token?: string) { \n\n6\n\n return this.http.get<RestEndpointMethodTypes['repos']['get']['response']>( \n\n7\n\n this.routes.repo({ owner, repo }), \n\n8\n\n { \n\n9\n\n metric: 'git-repo-get', \n\n10\n\n headers: { \n\n11\n\n ...this.options?.headers, \n\n12\n\n Accept: 'application/vnd.github.nebula-preview+json', \n\n13\n\n ...(token && { Authorization: `token ${token}` }), \n\n14\n\n }, \n\n15\n\n } \n\n16\n\n ) \n\n17\n\n } \n\n ``\n\nBelow we have the complete code example:\n\nVTEX API core types:\n\n* `IOContext`: Contains the VTEX IO context data, such as account, workspace, locale, authentication token, etc.\n* [InstanceOptions](#instanceoptions): The options for configuring your `HttpClient` instance.\n* `ExternalClient`: The base Client class for communicating with external APIs.\n\nType of the base Client that the custom Client extends from. Used to connect with external APIs.\n\nA variable to store a map of routes for each method implemented in the Client. This structure is not mandatory, but it makes the code more readable when calling the `HttpClient` methods.\n\nThe `baseUrl` argument in `super` must be a URL starting with `http://`. For a secure connection, set the header `'x-vtex-use-https'` to `'true'`. This header changes the request to HTTPS when it leaves the VTEX infrastructure.\n\nConfiguration options for each request of this Client. It extends `AxiosRequestConfig`, adding some IO-specific options. In this example, we are setting the number of retries, the `Accept` header to indicate the desired format, and the `x-vtex-use-https` header to force the use of HTTPS.\n\nThe `metric` parameter gives a name to identify each HTTP call for analytics purposes.\n\nThe `getRaw` method retrieves additional information about the response, such as headers. The `get` method retrieves only the response body.\n\nThe query parameters are passed using this format, resulting in `?q={{query}}` being appended to the request's URL.\n\nnode/github.ts\n\n`` 1\n\nimport type { IOContext, InstanceOptions } from '@vtex/api' \n\n2\n\nimport { ExternalClient } from '@vtex/api' \n\n3\n\nimport type { RestEndpointMethodTypes } from '@octokit/rest' \n\n4\n\n \n5\n\ninterface GitRepo { \n\n6\n\n owner: string \n\n7\n\n repo: string \n\n8\n\n} \n\n9\n\n \n10\n\nexport default class GithubClient extends ExternalClient { \n\n11\n\n private routes = { \n\n12\n\n repo: ({ owner, repo }: GitRepo) => `/repos/${owner}/${repo}`, \n\n13\n\n user: ({ username }: { username: string }) => `/users/${username}`, \n\n14\n\n tags: ({ owner, repo }: GitRepo) => `/repos/${owner}/${repo}/git/tags`, \n\n15\n\n searchRepos: () => '/search/repositories', \n\n16\n\n } \n\n17\n\n \n18\n\n constructor(context: IOContext, options?: InstanceOptions) { \n\n19\n\n super('http://api.github.com', context, { \n\n20\n\n ...options, \n\n21\n\n retries: 2, \n\n22\n\n headers: { \n\n23\n\n Accept: 'application/vnd.github.machine-man-preview+json', \n\n24\n\n 'x-vtex-use-https': 'true', \n\n25\n\n }, \n\n26\n\n }) \n\n27\n\n } \n\n28\n\n \n29\n\n public getRepo({ owner, repo }: GitRepo, token?: string) { \n\n30\n\n return this.http.get<RestEndpointMethodTypes['repos']['get']['response']>( \n\n31\n\n this.routes.repo({ owner, repo }), \n\n32\n\n { \n\n33\n\n metric: 'git-repo-get', \n\n34\n\n headers: { \n\n35\n\n ...this.options?.headers, \n\n36\n\n Accept: 'application/vnd.github.nebula-preview+json', \n\n37\n\n ...(token && { Authorization: `token ${token}` }), \n\n38\n\n }, \n\n39\n\n } \n\n40\n\n ) \n\n41\n\n } \n\n42\n\n \n43\n\n public async getUser({ username }: { username: string }) { \n\n44\n\n const response = await this.http.getRaw< \n\n45\n\n RestEndpointMethodTypes['users']['getByUsername']['response'] \n\n46\n\n >(this.routes.user({ username }), { metric: 'git-user-get' }) \n\n47\n\n \n48\n\n return response.data \n\n49\n\n } \n\n50\n\n \n51\n\n public createTag( \n\n52\n\n { \n\n53\n\n owner, \n\n54\n\n repo, \n\n55\n\n ...tagData \n\n56\n\n }: { \n\n57\n\n owner: string \n\n58\n\n repo: string \n\n59\n\n } & RestEndpointMethodTypes['git']['createTag']['parameters'], \n\n60\n\n token?: string \n\n61\n\n ) { \n\n62\n\n console.info('Tag data:', tagData) \n\n63\n\n \n64\n\n return this.http.post<RestEndpointMethodTypes['git']['createTag']>( \n\n65\n\n this.routes.tags({ owner, repo }), \n\n66\n\n tagData, \n\n67\n\n { \n\n68\n\n metric: 'git-create-tag', \n\n69\n\n headers: { \n\n70\n\n ...this.options?.headers, \n\n71\n\n ...(token && { Authorization: `token ${token}` }) \n\n72\n\n }, \n\n73\n\n } \n\n74\n\n ) \n\n75\n\n } \n\n76\n\n \n77\n\n public searchRepos({ query }: { query: string }) { \n\n78\n\n return this.http.get< \n\n79\n\n RestEndpointMethodTypes['search']['repos']['response'] \n\n80\n\n >(this.routes.searchRepos(), { \n\n81\n\n metric: 'git-search-repos', \n\n82\n\n params: { q: query }, \n\n83\n\n }) \n\n84\n\n } \n\n85\n\n} \n\n ``\n\n### Step 4 - Exporting custom clients\n\nNow that you've created your custom Client, you need to organize and export it for use in your VTEX IO service. Follow these steps:\n\n1. Create an `index.ts` file in the `node/clients` folder.\n2. Inside the `index.ts` file, import the custom Client you created in the previous step. For example: \n`1 \nimport GithubClient from \"./github.ts\"; \n`\n3. Define a class called `Clients` that extends `IOClients`. This class is used to organize and configure your custom Clients. Within the Clients class, declare a `get` property for each of your custom Clients. This property allows you to access a specific Client by name. In our example, we've created a Client named `github` that uses the `GithubClient` class. \n`1 \nimport { IOClients } from \"@vtex/api\"; \n2 \nimport GithubClient from \"./github.ts\"; \n3 \n \n4 \nexport class Clients extends IOClients { \n5 \n public get github() { \n6 \n return this.getOrSet(\"github\", GithubClient); \n7 \n } \n8 \n} \n`\n\nNow that you have developed and exported your custom Client to communicate with the desired service, your Clients can be accessed and used within your VTEX IO service to perform various tasks, such as interacting with external APIs like GitHub. Learn how to use Clients effectively in the [Using Node Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-node-clients) guide.\n\n## Client types\n\nThe [@vtex/api](https://read.calvincode.net/reader?url=https://github.com/vtex/node-vtex-api/) package provides a structured way to create Clients.\n\n| Type | Use case |\n| ---------------- | ---------------------------------------------------------------- |\n| AppClient | Communication with other IO Services via HTTP calls. |\n| AppGraphQLClient | Communication with other IO GraphQL services. |\n| ExternalClient | Communication with external APIs. |\n| JanusClient | Communication with VTEX Core Commerce APIs through Janus Router. |\n| InfraClient | Communication with VTEX IO Infra services. |\n\nRefer to the diagram below to better understand the relationship between Client types.\n\nIOClient\n\nhttp: HttpClient\n\nconstructor(context,options)\n\nHttpClient\n\ncacheableType: CacheType\n\nlogger: Logger\n\nrunMiddlewares: ComposedMiddleware\n\ndelete\n\nget\n\ngetRaw\n\ngetWithBody\n\nname: string\n\npost\n\npostRaw\n\nput\n\nputRaw\n\ngetConfig:(url: string, config?: RequestConfig)\n\nrequest:(config: RequestConfig) : => Promise\n\ngetBuffer:(url: string, config?: RequestConfig) : => Promise<>\n\ngetStream:(url: string, config?: RequestConfig) : => Promise\n\nhead:(url: string, config?: RequestConfig) : => Promise>\n\nGraphQLClient\n\nmutate\n\nquery\n\nconstructor(http:HttpClient)\n\nIOGraphQLClient\n\ngraphql: GraphQLClient\n\nconstructor(context,options)\n\nAppGraphQLClient\n\nconstructor(app,context,options)\n\nInfraClient\n\nconstructor(app, context, options, isRoot)\n\nExternalClient\n\nconstructor(baseURL,context,options)\n\nJanusClient\n\nconstructor(context,options,environment)\n\nAppClient\n\nconstructor(app,context,options)\n\nNote that `context` is of type `IOContext` and `options` is of type [InstanceOptions](#instanceoptions).\n\n## `InstanceOptions`\n\nThe `InstanceOptions` table below provides a detailed description of the available options for configuring your `HttpClient` instance:\n\n| Option | Description |\n| ----------------------------- | ----------------------------------------------------------------------------------- |\n| authType | Specifies the authentication type. |\n| timeout | Sets the request timeout duration in milliseconds. |\n| memoryCache | Configures a memory cache layer for caching data. |\n| diskCache | Configures a disk cache layer for caching data. |\n| baseURL | Defines the base URL for making requests. |\n| retries | Specifies the number of times a request should be retried in case of failure. |\n| exponentialTimeoutCoefficient | Configures the coefficient for exponential timeout backoff strategy. |\n| initialBackoffDelay | Sets the initial delay before starting exponential backoff retries in milliseconds. |\n| exponentialBackoffCoefficient | Configures the coefficient for exponential backoff retries. |\n| metrics | Specifies an object for accumulating metrics related to requests. |\n| concurrency | Defines the maximum number of concurrent requests. |\n| headers | Sets default headers to be sent with every request. |\n| params | Sets default query string parameters to be sent with every request. |\n| middlewares | Configures an array of middleware functions for request processing. |\n| verbose | Enables or disables verbose logging for requests and responses. |\n| name | Defines a custom name for the instance. |\n| serverTimings | Sets server timings for measuring request and response times. |\n| httpsAgent | Configures the HTTPS agent for making requests over SSL/TLS. |\n\n## `HttpClient` methods\n\nBelow is a table outlining the methods available in the `HttpClient` class:\n\n| Method | Description |\n| ------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------- |\n| get(url: string, config?: RequestConfig) | Sends an HTTP GET request. Returns only the response body. |\n| getRaw(url: string, config?: RequestConfig) | Sends an HTTP GET request. Returns all the response data. |\n| getWithBody(url: string, data?: any, config?: RequestConfig) | Sends an HTTP GET request with a request body. |\n| getBuffer(url: string, config?: RequestConfig) | Sends an HTTP GET request and resolves with the response data as a buffer along with the headers. |\n| getStream(url: string, config?: RequestConfig) | Sends an HTTP GET request and resolves with the response as a readable stream (of type IncomingMessage). |\n| put(url: string, data?: any, config?: RequestConfig) | Sends an HTTP PUT request. Returns only the response body. |\n| putRaw(url: string, data?: any, config?: RequestConfig) | Sends an HTTP PUT request. Returns all the response data. |\n| post(url: string, data?: any, config?: RequestConfig) | Sends an HTTP POST request. Returns only the response body. |\n| postRaw(url: string, data?: any, config?: RequestConfig) | Sends an HTTP POST request. Returns all the response data. |\n| patch(url: string, data?: any, config?: RequestConfig) | Sends an HTTP PATCH request. Returns only the response body. |\n| head(url: string, config?: RequestConfig) | Sends an HTTP HEAD request and resolves when the request is complete. |\n| delete(url: string, config?: RequestConfig) | Sends an HTTP DELETE request. |\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/Getting-Started/back-end-development-guides/vtex-io-documentation-how-to-create-and-use-clients.mdx)\n\n[Clients« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io//docs/guides/vtex-io-documentation-clients)[Connecting to VTEX Core Commerce APIsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io//docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io)\n\nContributors\n\n1\n\n[](https://github.com/henriquessb)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-how-to-create-and-use-clients%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-how-to-create-and-use-clients%23instructions)\n\n[Step 1 - Setting up your VTEX IO app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-how-to-create-and-use-clients%23step-1-setting-up-your-vtex-io-app)[Step 2 - Creating a custom Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-how-to-create-and-use-clients%23step-2-creating-a-custom-client)[Step 3 - Implementing Client methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-how-to-create-and-use-clients%23step-3-implementing-client-methods)[Step 4 - Exporting custom clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-how-to-create-and-use-clients%23step-4-exporting-custom-clients)\n\n[Client types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-how-to-create-and-use-clients%23client-types)\n\n[InstanceOptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-how-to-create-and-use-clients%23instanceoptions)\n\n[HttpClient methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-how-to-create-and-use-clients%23httpclient-methods)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Getting-Started/back-end-development-guides/vtex-io-documentation-how-to-create-and-use-clients.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/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-how-to-create-and-use-clients%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-how-to-create-and-use-clients%23instructions)\n\n[Step 1 - Setting up your VTEX IO app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-how-to-create-and-use-clients%23step-1-setting-up-your-vtex-io-app)[Step 2 - Creating a custom Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-how-to-create-and-use-clients%23step-2-creating-a-custom-client)[Step 3 - Implementing Client methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-how-to-create-and-use-clients%23step-3-implementing-client-methods)[Step 4 - Exporting custom clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-how-to-create-and-use-clients%23step-4-exporting-custom-clients)\n\n[Client types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-how-to-create-and-use-clients%23client-types)\n\n[InstanceOptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-how-to-create-and-use-clients%23instanceoptions)\n\n[HttpClient methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io/docs/guides/vtex-io-documentation-how-to-create-and-use-clients%23httpclient-methods)\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_6ac063f2
|
[
{
"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 3.10.3 README pt 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@3.10.3/README_pt/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@3.10.3/README_pt/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@3.10.3/README_pt/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@3.10.3/README_pt/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@3.10.3/README_pt/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@3.10.3/README_pt/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@3.10.3/README_pt/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@3.10.3/README_pt/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges@3.10.3/README_pt/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges@3.10.3/README_pt/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges@3.10.3/README_pt/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges@3.10.3/README_pt/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@3.10.3/README_pt/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges@3.10.3/README_pt/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges@3.10.3/README_pt/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@3.10.3/README_pt/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@3.10.3/README_pt/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@3.10.3/README_pt/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges@3.10.3/README_pt/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges@3.10.3/README_pt/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges@3.10.3/README_pt/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges@3.10.3/README_pt/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges@3.10.3/README_pt/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges@3.10.3/README_pt/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@3.10.3/README_pt/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges@3.10.3/README_pt/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges@3.10.3/README_pt/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges@3.10.3/README_pt/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges@3.10.3/README_pt/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@3.10.3/README_pt/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges@3.10.3/README_pt/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges@3.10.3/README_pt/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@3.10.3/README_pt/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@3.10.3/README_pt/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@3.10.3/README_pt/docs/vtex-io-apps)\n\nBadges\n\n[vtex.badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges)\n\nVersion: 3.10.3\n\nLatest version: 3.10.3\n\nO aplicativo de Badges tem como objetivo adicionar Badges de conteúdo em seu ecommerce. Há uma aplicação no admin em que poderão ser adicionadas, editadas e removidas as badges e há também um componente para frente de loja em que poderão ser acrescentadas as badges cadastradas no tema da sua store.\n\n## Instalando\n\n### O ADMIN\n\nPara instalar o aplicativo no admin e, assim, gerenciar suas badges, deve-se entrar em seu terminal, logar no workspace e digitar o comando:\n\n`1\n\n vtex install vtex.badges@3.x \n\n`\n\n### A Store\n\nPara disponibilizar o componente em sua loja, é necessário adicionar nas \"peerDependencies\" do manifest o seguinte código:\n\n`1\n\n \"vtex.badges\": \"3.x\" \n\n`\n\nEm seguida, já é possível adicionar o componente de badges em sua loja.\n\n## O funcionamento\n\n### No ADMIN\n\nApós instalar o aplicativo em sua loja, já estará disponível em seu ambiente ADMIN o aplicativo de Gerenciamento de Badges. Para utilizá-lo, basta acessar a barra lateral em \"OUTROS\", a qual deve conter o aplicativo \"Gerenciamento de Badges\". Clicando no aplicativo, deverá visualizar a seguinte página:\n\n \n\nNessa página é possível criar uma nova badge\n\n* Adicionando o nome da badges\n* Adicionando o conteúdo da badge (como imagem, texto ou html)\n* Adicionando a prioridade da badges (sendo 1 a prioridade máxima e 5 a menor)\n* Adicionando uma regra de ativação\n\nUm exemplo de como pode-se ser preenchido o formulário que está contido abaixo.\n\n \n\nNesse mesmo gerenciamento pode-se editar ou excluir uma badge em questão, basta-se mudar a aba do formulário de \"Adicionar Badge\" para \"Editar Badges\" e ser clicado no botão de \"LineActions\", como pode-se ser visto na imagem abaixo:\n\n \n\nTambém é importante acrescentar que para o perfeito funcionamento do aplicativo, no campo de regra de ativação deve haver pelo menos uma condição que seja utilizado o verbo \"É\". Desta forma, não deve haver um badge cuja regra de ativação seja **unicamente** \"NÃO É\"\n\n### Em Meus Aplicativos\n\nPara aprimorar a busca pelas badges, é possível selecionar quais campos você quer que sejam filtradas a busca por elas. Isso permite que a busca no Banco de Dado seja mais simples e mais eficiente na hora de retornar as badges para seu site. Para configura basta entrar na área de Meus Aplicativos. Em seguida escolher **App Badges** e selecionar quais campos você deseja que a busca seja relacionada.\n\n \n\nVale lembrar que por default todos os campos são utilizados como filtro\n\n### Na Store\n\nAgora com as badges cadastradas, é possível adiciona-las em sua loja. Para o correto funcionamento das mesmas é necessário que o componente das badges seja aderida dentro de uma página de produto (store.product) ou dentro de um product-summary. O exemplo abaixo demonstra como colocar uma badges na página de produto.\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### `store-badges` props\n\n| Nome da Prop | Tipo | Descrição |\n| -------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| numberOfBadges | number | Define quantas badges serão renderizadas |\n| text | array | Contém definições de valores que serão usados quando se renderiza uma badge de texto. Saiba mais sobre essas props no <https://github.com/vtex-apps/rich-text> |\n| image | array | Contém definições de valores que serão usados quando se renderiza uma badge de imagem. Saiba mais sobre essas props no <https://github.com/vtex-apps/store-image> |\n\n### O resultado final\n\nCom todas as etapas concluídas já é possível conferir o resultado final em sua store. A ordem das badges é definida de acordo com a prioridade escolhida na hora de cadastrá-las. O exemplo abaixo mostra como ficaria a uma store que foi seguido o passo a passo desse tutorial.\n\n \n\n**Upcoming documentation:**\n\n* [Feature/test back](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/badges/pull/17)\n\nSee also\n\n[Vtex.badgesVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges@3.10.3/README_pt/docs/apps/vtex.badges)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Instalando](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges@3.10.3/README_pt/docs/apps/vtex.badges@3.10.3/README%5Fpt%23instalando)\n\n[O ADMIN](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges@3.10.3/README_pt/docs/apps/vtex.badges@3.10.3/README%5Fpt%23o-admin)[A Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges@3.10.3/README_pt/docs/apps/vtex.badges@3.10.3/README%5Fpt%23a-store)\n\n[O funcionamento](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges@3.10.3/README_pt/docs/apps/vtex.badges@3.10.3/README%5Fpt%23o-funcionamento)\n\n[No ADMIN](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges@3.10.3/README_pt/docs/apps/vtex.badges@3.10.3/README%5Fpt%23no-admin)[Em Meus Aplicativos](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges@3.10.3/README_pt/docs/apps/vtex.badges@3.10.3/README%5Fpt%23em-meus-aplicativos)[Na Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges@3.10.3/README_pt/docs/apps/vtex.badges@3.10.3/README%5Fpt%23na-store)[store-badges props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges@3.10.3/README_pt/docs/apps/vtex.badges@3.10.3/README%5Fpt%23store-badges-props)[O resultado final](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.badges@3.10.3/README_pt/docs/apps/vtex.badges@3.10.3/README%5Fpt%23o-resultado-final)\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_9d5ddeac
|
[
{
"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 section styles 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-section-styles/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-section-styles/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-section-styles/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-section-styles/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-section-styles/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-section-styles/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-section-styles/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-section-styles/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-section-styles/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/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-section-styles/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/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-section-styles/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/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-section-styles/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-section-styles/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-section-styles/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-section-styles/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-section-styles/docs/guides/faststore/overrides-section-styles)\n\n[\\`getOverriddenSection\\` function](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/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-section-styles/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-section-styles/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-section-styles/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-section-styles/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-section-styles/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-section-styles/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-section-styles/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-section-styles/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-section-styles/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-section-styles/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/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-section-styles/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-section-styles/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/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-section-styles/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-section-styles/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/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-section-styles/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/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-section-styles/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/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-section-styles/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-section-styles/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-section-styles/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-section-styles/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-section-styles/docs/guides/faststore/overrides-section-styles)\n\n[\\`getOverriddenSection\\` function](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/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-section-styles/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-section-styles/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-section-styles/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-section-styles/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-section-styles/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-section-styles/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-section-styles/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-section-styles/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-section-styles/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-section-styles/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/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-section-styles/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-section-styles/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-section-styles/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/docs/guides/faststore)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/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-section-styles/docs/guides/faststore/overrides-overview)\n\nOverriding section styles\n\nTo customize the styles of a native section, you can use the `className` property, which works similarly to [React's className](https://read.calvincode.net/reader?url=https://react.dev/reference/react-dom/components/common%23applying-css-styles).\n\n## Before you begin\n\nBefore delving into this guide, make sure you have already overridden a component, as presented in the [getOverriddenSection function](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function) guide.\n\n## Instructions\n\nLet’s use the example provided in the [getOverriddenSection function](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-getoverriddensection-function) guide, where the `Simple Alert` styles are being overridden via the `className`:\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\nSection: AlertSection, \n\n7\n\nclassName: styles.simpleAlert, \n\n8\n\ncomponents: { Icon: { props: { weight: \"bold\" } } }, \n\n9\n\n}); \n\n10\n\n \n11\n\nexport default SimpleAlert; \n\n`\n\n1. Create the `simple-alert.module.scss` file within the `sections` folder.\n2. In the `simple-alert.module.scss` file, declare the class you have added to the Simple Alert component. In this case, `.simpleAlert`.\n3. Add the `scss` styles you desire to override: \n`1 \n.simpleAlert{ \n2 \n [data-fs-alert-content] { \n3 \n color: Blue; \n4 \n font-weight: bold; \n5 \n } \n6 \n} \n`\n4. Run `yarn dev` to sync your changes.\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/section-styles.mdx)\n\n[Overriding a native component« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/docs/guides/faststore/overrides-native-component)[\\`getOverriddenSection\\` functionNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/docs/guides/faststore/overrides-getoverriddensection-function)\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/overrides-section-styles/docs/guides/faststore/overrides-section-styles%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/docs/guides/faststore/overrides-section-styles%23instructions)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/developing-and-overriding-components/overrides/section-styles.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/overrides-section-styles/docs/guides/faststore/overrides-section-styles%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-section-styles/docs/guides/faststore/overrides-section-styles%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_37e6d175
|
[
{
"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 price 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-price/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-price/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-price/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-price/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-price/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-price/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-price/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/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-product-price/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/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-product-price/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-product-price/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/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-product-price/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-product-price/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/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-product-price/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/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-product-price/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-product-price/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/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-product-price/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-product-price/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-product-price/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/guides/basic-components)\n\nProduct Price\n\nOfficial extension\n\nVersion: 1.33.0\n\nLatest version: 1.33.0\n\n[](#contributors-)\n\nThe Product Price app exports blocks related to the product price, such as list price, selling price, and savings.\n\n\n\n> Currently, **Product Price is the only app that provides product price blocks for your theme**. The [Product Summary Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryprice) block from the [Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary/) app and the [Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productprice/) block from [Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components/) have been deprecated.\n\n## Configuration\n\n### Step 1 - Adding the Product Price app to your theme dependencies\n\nIn the theme's `manifest.json` file, add the Product Price app as a dependency:\n\n`1\n\n\"dependencies\": { \n\n2\n\n \"vtex.product-price\": \"1.x\" \n\n3\n\n} \n\n`\n\nNow, you can use all the blocks exported by the `product-price` app. See the full list below:\n\n| Block name | Description |\n| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| product-list-price | Renders the product list price. This block will not be rendered if it is equal to or less than the product selling price. |\n| product-selling-price | Renders the product selling price. |\n| product-spot-price | Renders the product spot price (if it is equal to the selling price, the block is not rendered). This block finds the spot price by looking for the lowest price of all installment options. |\n| product-installments | Renders the product installments. If more than one option is available, the one with the highest number of installments will be displayed by default. |\n| product-installments-list | Renders all the installments of the payment system with the most installment options by default. |\n| product-installments-list-item | Renders an installment option from the product-installments-list-item. |\n| product-price-savings | Renders the product price savings, if there are any. It can show the discount percentage or the total amount of the savings. |\n| product-spot-price-savings | Renders the product spot price savings, if there are any. It can show the discount percentage or the total amount of the savings. |\n| product-list-price-range | Renders the product list price range. It follows the same logic applied to the ListPrice: if its value equals the product selling price, this block is not rendered. |\n| product-selling-price-range | This is the product selling price range. |\n| product-seller-name | Renders the name of the product seller. |\n| product-price-suspense | Renders a fallback component when the price is loading and its children block when it is not loading. This block is handy when the store works with asynchronous prices. |\n\nAll blocks listed above use product price data fetched from the store catalog. To learn more, please read the [Pricing module overview](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/precos-101--6f8pwCns3PJHqMvQSugNfP).\n\n### Step 2 - Adding the Product Price blocks to your theme templates\n\nTo add the Product Price blocks to your theme, you just need to declare them as children of the `product-summary.shelf` exported by the [Product Summary](https://read.calvincode.net/reader?url=https://vtex.io/docs/components/content-blocks/vtex.product-summary@2.52.3) app, or declare them in the theme's Product template (`store.product`).\n\nNote that these blocks require a Product context to work correctly. Therefore, when declaring them as children of the `product-summary.shelf`, make sure they are in a store template in which this context is available.\n\nFor example:\n\n`1\n\n\"shelf#home\": { \n\n2\n\n \"blocks\": [\"product-summary.shelf\"] \n\n3\n\n}, \n\n4\n\n \n5\n\n\"product-summary.shelf\": { \n\n6\n\n \"children\": [ \n\n7\n\n \"product-list-price\", \n\n8\n\n \"product-selling-price#summary\", \n\n9\n\n \"product-price-savings\", \n\n10\n\n \"product-installments\" \n\n11\n\n ] \n\n12\n\n}, \n\n`\n\nExcept for `product-price-suspense`, every block in this app only has three props in common:\n\n| Prop name | Type | Description | Default value |\n| ---------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| markers | \\[string\\] | IDs that you define to identify the block's rendered message and customize it using the Site Editor in the Admin. Learn how to use them by reading the documentation on [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-using-the-markers-prop-to-customize-a-blocks-message). Note that a block's message can be customized using the message prop in the Store Theme source code. | \\[\\] |\n| blockClass | string | Block ID that you define to be used in [CSS customizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-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. If you use the Site Editor in the Admin, you can also define the text message that a block will render on the UI. | undefined |\n\nFor example:\n\n`1\n\n\"product-selling-price#summary\": { \n\n2\n\n \"props\": { \n\n3\n\n \"markers\": [ \n\n4\n\n \"highlight\" \n\n5\n\n ], \n\n6\n\n \"blockClass\": \"summary\", \n\n7\n\n \"message\": \"Selling price: {sellingPriceValue}\" \n\n8\n\n } \n\n9\n\n}, \n\n`\n\nThe `product-price-savings` block has two additional props:\n\n| Prop name | Type | Description | Default value |\n| ----------------- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| percentageStyle | locale or compact | Set to compact to remove the white space between the number and the percent sign. It uses the pattern provided by the current locale as default. | locale |\n| minimumPercentage | number | Set the minimum value for the percentage value display. If not configured, it will display always. Example: 10 means savings less than or equal to 10% will not appear. | 0 |\n\nThe following blocks have an additional prop: `product-list-price`, `product-selling-price`, `product-spot-price`, `product-spot-price-savings`, `product-price-savings`, `product-list-price-range`, and `product-selling-price-range`. The prop is:\n\n| Prop name | Type | Description | Default value |\n| ---------- | ------- | ------------------------------------------------------- | ------------- |\n| alwaysShow | boolean | Renders the block even when the product is unavailable. | false |\n\nFor example:\n\n`1\n\n\"product-selling-price#summary\": { \n\n2\n\n \"props\": { \n\n3\n\n \"alwaysShow\": true \n\n4\n\n } \n\n5\n\n}, \n\n`\n\nThe `product-installments-list` block has two additional props:\n\n| Prop name | Type | Description | Default value |\n| ------------------ | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| paymentSystemName | string | Allows you to filter the listed installment options by a particular payment system. If not passed, the installments of the payment system with the most installment options will be rendered. | undefined |\n| installmentsToShow | number\\[\\] | Determines the installment options you want to show to the user based on the number of installments. For example, if \\[1, 3\\] is passed as a value for this prop, only the installments options with NumberOfInstallments equal to 1 and 3 will be rendered. If a value is not passed, all options will be rendered. | undefined |\n\nThe `product-installments` block also has two additional props:\n\n| Prop name | Type | Description | Default value |\n| ------------------------ | ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| installmentsCriteria | max-quantity or max-quantity-without-interest | When set to max-quantity, the block renders the installment plan with the most number of installments. When set to max-quantity-without-interest, the block renders the installment plan with the most number of installments and **no interest**. Note that if this prop is set to max-quantity-without-interest and no installment plan matches the 'without interest' criterion, the component will fall back to the default behavior. | max-quantity |\n| installmentOptionsFilter | { paymentSystemName?: string, installmentsQuantity?: number } | Allows you to define two filtering rules that will narrow down the possible installment plans the component may render. | undefined |\n\nIf you are using the asynchronous price feature, you can take advantage of `product-price-suspense` and its props:\n\n| Prop name | Type | Description | Default value |\n| --------- | ----- | ------------------------------------------------------------------ | ----------------- |\n| Fallback | block | Name of the block that will be rendered when the price is loading. | rich-text#loading |\n\nFor example:\n\n`1\n\n{ \n\n2\n\n \"rich-text#loading\": { \n\n3\n\n \"props\": { \n\n4\n\n \"text\": \"Loading...\" \n\n5\n\n } \n\n6\n\n }, \n\n7\n\n \"product-price-suspense\": { \n\n8\n\n \"props\": { \n\n9\n\n \"Fallback\": \"rich-text#loading\" \n\n10\n\n }, \n\n11\n\n \"children\": [ \n\n12\n\n \"product-list-price#summary\", \n\n13\n\n \"flex-layout.row#selling-price-savings\", \n\n14\n\n \"product-installments#summary\", \n\n15\n\n \"add-to-cart-button\" \n\n16\n\n ] \n\n17\n\n }, \n\n18\n\n \"product-summary.shelf\": { \n\n19\n\n \"children\": [ \n\n20\n\n \"stack-layout#prodsum\", \n\n21\n\n \"product-summary-name\", \n\n22\n\n \"product-rating-inline\", \n\n23\n\n \"product-summary-space\", \n\n24\n\n \"product-price-suspense\" \n\n25\n\n ] \n\n26\n\n } \n\n27\n\n} \n\n`\n\n\n\n### Step 3 - Editing the block's messages\n\nEvery Product Price block uses the [ICU Message Format](https://read.calvincode.net/reader?url=https://format-message.github.io/icu-message-format-for-translators/), making it possible to fully edit the text message and variables displayed by each block.\n\nThe variable values are rendered based on the context wrapping the block, meaning it uses product data to render the price accordingly.\n\nYou can, however, define the message texts a block will render on the UI using the `message` prop as explained previously.\n\nThe `markers` prop, in turn, needs an extra configuration in the Admin's Site Editor to work correctly. When using it, do not forget to read the [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-using-the-markers-prop-to-customize-a-blocks-message/) documentation.\n\n\n\nIn addition, remember to take into account the message variables for each block, since you will need them to edit the desired messages using the Admin's Site Editor:\n\n* **`product-list-price`**\n\n| Message variable | Type | Description |\n| ------------------------------------- | ------- | -------------------------------------------------------------------------------------------- |\n| listPriceValue | string | List price value. |\n| listPriceWithTax | string | List price value with tax. |\n| listPriceWithUnitMultiplier | string | List price multiplied by a unit multiplier. |\n| listPriceWithTaxWithoutUnitMultiplier | string | List price with tax without unit multiplier. |\n| taxPercentage | string | Tax percentage. |\n| taxValue | string | Tax value. |\n| hasMeasurementUnit | boolean | Determines whether the product has a unit of measure (true) or not (false). |\n| measurementUnit | string | Unit of measure text. |\n| hasUnitMultiplier | boolean | Determines whether the product has a unit multiplier different from 1 (true) or not (false). |\n| unitMultiplier | string | Value of the unit multiplier. |\n\n* **`product-selling-price`**\n\n| Message variable | Type | Description |\n| ---------------------------------------- | ------- | -------------------------------------------------------------------------------------------- |\n| sellingPriceValue | string | Selling price value. |\n| sellingPriceWithTax | string | Selling price with tax. |\n| sellingPriceWithUnitMultiplier | string | Selling price multiplied by a unit multiplier. |\n| sellingPriceWithUnitMultiplierAndTax | string | Selling price multiplied by a unit multiplier and added tax. |\n| sellingPriceWithTaxWithoutUnitMultiplier | string | Selling price with tax without unit multiplier. |\n| taxPercentage | string | Tax percentage. |\n| hasListPrice | boolean | Determines whether the product has a list price (true) or not (false). |\n| taxValue | string | Tax value. |\n| hasMeasurementUnit | boolean | Determines whether the product has a unit of measure (true) or not (false). |\n| measurementUnit | string | Unit of measure text. |\n| hasUnitMultiplier | boolean | Determines whether the product has a unit multiplier different from 1 (true) or not (false). |\n| unitMultiplier | string | Value of the unit multiplier. |\n\nYou can use the `product-selling-price` `sellingPriceWithUnitMultiplier`, `hasMeasurementUnit`, `unitMultiplier`, and `measurementUnit` variables together to render the unit of measure and unit multiplier on products that have it.\n\nFor example:\n\n`1\n\n{ \n\n2\n\n \"product-selling-price\": { \n\n3\n\n \"props\": { \n\n4\n\n \"message\": \"{sellingPriceWithUnitMultiplier}{hasMeasurementUnit, select, true { / {hasUnitMultiplier, select, true {{unitMultiplier}} false {}} {measurementUnit}} false {}}\" \n\n5\n\n } \n\n6\n\n } \n\n7\n\n} \n\n`\n\nAccording to the example above, products with a unit of measure and a unit multiplier would be rendered as follows:\n\n`$24.00 / 2 oz`\n\n> _Note that the unit of measure and unit multiplier would be properly rendered alongside their price._\n\nStill, in the example, products that do not have a unit of measure and a unit multiplier will only render their price:\n\n`$24.00`\n\n* **`product-spot-price`**\n\n| Message variable | Type | Description |\n| ---------------- | ------ | ----------------- |\n| spotPriceValue | string | Spot price value. |\n\n* **`product-installments` and `product-installments-list-item`**\n\n| Message variables | Type | Description |\n| ---------------------- | ------- | -------------------------------------------------------------------------- |\n| spotPriceValue | string | Spot price value. |\n| installmentsNumber | string | Number of installments. |\n| installmentValue | string | Amount of each installment. |\n| installmentsTotalValue | string | Total amount of installments. |\n| interestRate | string | Interest rate. |\n| paymentSystemName | string | Payment system for the installments. |\n| hasInterest | boolean | Determines whether the installments have interest (true) or not (false). |\n| hasMoreThanOne | boolean | Determines whether there is more than 1 installment (true) or not (false). |\n\n* **`product-price-savings`**\n\n| Message variables | Type | Description |\n| ------------------ | ------ | ------------------------------------------------------------------------- |\n| previousPriceValue | string | Previous price value (list price). |\n| newPriceValue | string | New price value (selling price). |\n| savingsValue | string | Difference between the previous product price and the new one. |\n| savingsWithTax | string | Difference between the previous product price and the new one with taxes. |\n| savingsPercentage | string | Percentage of savings. |\n\n* **`product-spot-price-savings`**\n\n| Message variables | Type | Description |\n| -------------------------- | ------ | ---------------------------------------------------------------------------- |\n| previousPriceValue | string | Previous price value (list price). |\n| newSpotPriceValue | string | New price value (spot price). |\n| spotPriceSavingsValue | string | Difference between the previous product price and the spot price. |\n| spotPriceSavingsWithTax | string | Difference between the previous product price and the spot price with taxes. |\n| spotPriceSavingsPercentage | string | Percentage of savings. |\n\n* **`product-list-price-range`**\n\n| Message variables | Type | Description |\n| ----------------- | ------ | ----------------------------------------------------------- |\n| minPriceValue | string | Value of the cheapest list price SKU. |\n| maxPriceValue | string | Value of the most expensive list price SKU. |\n| minPriceWithTax | string | Value of the cheapest list price SKU with tax. |\n| maxPriceWithTax | string | Value of the most expensive list price SKU with tax. |\n| listPriceValue | string | Value of the list price of the only SKU available. |\n| listPriceWithTax | string | Value of the list price of the only SKU available with tax. |\n\n* **`product-selling-price-range`**\n\n| Message variables | Type | Description |\n| ------------------- | ------ | -------------------------------------------------------------- |\n| minPriceValue | string | Value of the cheapest selling price SKU. |\n| maxPriceValue | string | Value of the most expensive selling price SKU. |\n| minPriceWithTax | string | Value of the cheapest selling price SKU with tax. |\n| maxPriceWithTax | string | Value of the most expensive selling price SKU with tax. |\n| sellingPriceValue | string | Value of the selling price of the only SKU available. |\n| sellingPriceWithTax | string | Value of the selling price of the only SKU available with tax. |\n\n* **`product-seller-name`**\n\n| Message variable | Type | Description |\n| ---------------- | ------ | ------------------------------- |\n| sellerName | string | The name of the product seller. |\n\nIn the gif example above, the block first displayed a `Save $224.40` message. By editing the exported message, it now renders a `You are saving: $224.40 (37%)` message thanks to the changes performed through the Site Editor in the Admin:\n\n\n\n## Customization\n\nTo apply CSS customizations in this and other blocks, follow the instructions given in the recipe on [Using CSS handles for store customizations](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| installmentValue |\n| installmentsListContainer |\n| installmentsNumber |\n| installmentsTotalValue |\n| installments |\n| interestRate |\n| listPrice' |\n| listPrice--isUnavailable |\n| listPriceRangeMaxValue |\n| listPriceRangeMaxWithTax |\n| listPriceRangeMinValue |\n| listPriceRangeMinWithTax |\n| listPriceRangeUniqueValue |\n| listPriceRangeUniqueWithTax |\n| listPriceRange |\n| listPriceRange--isUnavailable |\n| listPriceValue |\n| listPriceWithTax |\n| newPriceValue |\n| newSpotPriceValue |\n| paymentSystemName |\n| previousPriceValue |\n| savingsPercentage |\n| savingsValue |\n| savingsWithTax |\n| savings |\n| savings--isUnavailable |\n| sellerName |\n| sellerNameContainer |\n| sellerNameContainer--isDefaultSeller |\n| sellingPrice--hasListPrice |\n| sellingPrice--isUnavailable |\n| sellingPriceRangeMaxValue |\n| sellingPriceRangeMaxWithTax |\n| sellingPriceRangeMinValue |\n| sellingPriceRangeMinWithTax |\n| sellingPriceRangeUniqueValue |\n| sellingPriceRangeUniqueWithTax |\n| sellingPriceRange |\n| sellingPriceRange--isUnavailable |\n| sellingPriceRange--hasListPrice |\n| sellingPriceValue |\n| sellingPriceWithTax |\n| sellingPrice |\n| spotPriceSavingsPercentage |\n| spotPriceSavingsValue |\n| spotPriceSavingsWithTax |\n| spotPriceSavings |\n| spotPriceSavings--isUnavailable |\n| spotPriceValue |\n| spotPrice |\n| spotPrice--isUnavailable |\n| taxPercentage |\n\n[Product List« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.product-list)[Product QuantityNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.product-quantity)\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-product-price/docs/apps/vtex.product-price%23configuration)\n\n[Step 1 - Adding the Product Price app to your theme dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.product-price%23step-1-adding-the-product-price-app-to-your-theme-dependencies)[Step 2 - Adding the Product Price blocks to your theme templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.product-price%23step-2-adding-the-product-price-blocks-to-your-theme-templates)[Step 3 - Editing the block's messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.product-price%23step-3-editing-the-blocks-messages)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-price/docs/apps/vtex.product-price%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=)"
}
] |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.